Demos · Guide · Class Reference · Wiki · Extensions · Forum · Live Chat · Login
search

morray

Converts an AR model to an array including related data.
report it
14 followers
Requirements
Setup
Usage

Morray (model to array) is a behavior that converts an AR model to an array. It will include all the specified relations. This can be useful for API's that need to supply the data including related data, or exporting relational data as XML file.

You can use scenario's to specify the fields that need to be included and also their order.

Requirements

Tested on Yii 1.1.8.

Setup

  • Download and extract the file in the 'behaviors' folder.
  • Include this method in the AR model that you're using:
public function behaviors() {
   return array(
     'MorrayBehavior'=>array(
          'class'=>'application.behaviors.MorrayBehavior'
      ),
    );
}

Usage

  • Use the following code (in controller) to retrieve the data:
//retrieve model like normal
$obj = User::model()->findByPk(1);
//call the toArray() method to convert the data to an array
$arr = $obj->toArray();

If you use findAll(), Yii will return an array of objects, loop them to get the data:

$objects = User::model()->findAll();
$arr = array();
foreach ($objects as $obj) {
     $arr[] = $obj->toArray();
}

To exclude some fields (passwords, timestamps, etc) we can use scenario's: Create a new validation rule in the AR model from which you want to exclude fields, and specify the safe attributes. These are the fields that will be included. (The order of the fields are preserved in the output array.)

public function rules()
{
    return array(
        array('id, first_name, last_name, username', 'safe', 'on' => 'myname'),
    );
}

You need to specify the scenario name when retrieving the data:

$arr = $obj->toArray(array("scenario"=>"myname"));

Note that relations should be eager loaded, for example using a scope or using 'with'.

Please report any bugs or shortcomings below.

Total 1 comment

#6395 report it
Zephyr at 2012/01/06 07:41pm
cannot redeclare loop()

When using toArray in a loop like so:

$objects = User::model()->findAll();
$arr = array();
foreach ($objects as $obj) {
     $arr[] = $obj->toArray();
}

I get an error that I cannot redeclare loop(). I fixed it, by putting the loop function outside of toArray();

<?php
/**
 * MorrayBehavior (Model to Array Behavior)
 *
 * ver 1.0 beta
 *
 * Converts an AR model to an array, retaining associated relations.
 *
 **/
 
class MorrayBehavior extends CBehavior
{
    public function toArray($options=array())
    {
        //option 'scenario', use a scenario to only display safe attributes
        //default: empty (no scenario)
        if (!isset($options['scenario'])) {
            $options['scenario'] = "";
        }
 
        //option 'relname', key name of the array holding the relations
        //       use empty string to use no new array for relations
        //default: "_rel"
        if (!isset($options['relname'])) {
            $options['relname'] = "_rel";
        }
 
        //get the owner class
        $owner = $this->getOwner();
 
        //check if the owner class is an AR class
        if (is_subclass_of($owner, 'CActiveRecord')) {
 
            //this function recursively loops all attributes and relations of a supplied object
 
 
            //return the result by calling the recursive function
            return $this->loop($owner, $options);
        }
 
        return false;
    }
     private function loop($obj, $options = array(), $arr = array())
    {
        //store current object attribute values
        $attributes = $obj->attributes;
 
        //check if user supplied a scenario, and if this object has any rules
        if ((!empty($options['scenario'])) && (is_array($obj->rules()))) {
 
            //loop the rules, search for a matching scenario
            foreach ($obj->rules() as $rule) {
 
                //check if this scenario name matches the supplied one
                if ((isset($rule['on']) && ($rule['on'] == $options['scenario']))) {
 
                    //check if this is the 'safe' option
                    if ((isset($rule[1])) && ($rule[1] == "safe")) {
 
                        //put the safe attributes in an array
                        $safe_attributes = explode(",", $rule[0]);
 
                        //new array for putting only the values of the safe attributes
                        $attributes_values = array();
 
                        //loop the safe attributes
                        foreach ($safe_attributes as $safe_attribute) {
 
                            //trim in case there are any spaces
                            $safe_attribute = trim($safe_attribute);
 
                            //if this safe attribute contains a value, save it in the new attribute array
                            if (isset($attributes[$safe_attribute])) {
                                $attributes_values[$safe_attribute] = $attributes[$safe_attribute];
                            }
                        }
                        //assign the safe attributes over the the array containing all the attributes
                        $attributes = $attributes_values;
                    }
                }
            }
        }
 
        // assign the attributes of current relation to array
        $arr = $attributes;
 
        //get relations from current relation
        $relations = $obj->relations();
 
        //put the keys (relation names) in an array
        if ($relation_ids = array_keys($relations)) {
 
            //loop relations
            foreach ($relation_ids as $relation_id) {
 
                //check if sub relation is loaded (using scopes or 'with')
                if ($obj->hasRelated($relation_id)) {
                    $relation = $obj->{$relation_id};
 
                    //if sub relation is an object, there is 1 relation being returned
                    if (is_object($relation)) {
 
                        //if relname is supplied, use that to store the relation in
                        if (!empty($options['relname'])) {
                            $arr[$options['relname']][$relation_id] = $this->loop($relation, $options, $arr);
                        }
                        else {
                            //if no relname is supplied, store directly in current array
                            $arr[$relation_id] = $this->loop($relation, $options, $arr);
                        }
                    }
 
                    //if sub relation is an array, there are multiple relations being returned
                    if (is_array($relation)) {
 
                        //do a foreach on each sub relation
                        foreach ($relation as $sub_relation) {
 
                            //if relname is supplied, use that to store the relation in
                            if (!empty($options['relname'])) {
                                $arr[$options['relname']][$relation_id][] = $this->loop($sub_relation, $options, $arr);
                            }
                            else {
                                //if no relname is supplied, store directly in current array
                                $arr[$relation_id][] = $this->loop($sub_relation, $options, $arr);
                            }
                        }
                    }
                }
            }
        }
        return $arr;
    }
}

Leave a comment

Please to leave your comment.

Create extension
Search Extensions
Downloads
See all »
Related Extensions
 

Yii Supporters

  • Clevertech supports Yii. Clevertech builds custom solutions to cut overhead, create relevant management reporting and deliver profits.
  • The Ext4Yii Framework is a professional PHP Yii extension which provides server-side ExtJS functionality.
Terms of Service | License | Contact Us
Copyright © 2012 by Yii Software LLC. All Rights Reserved.