0

Interface Yiisoft\Arrays\ArrayableInterface

All Classes | Methods

ArrayableInterface should be implemented by classes that want to support customizable representation of their instances.

For example, if a class implements ArrayableInterface, by calling {@see \Yiisoft\Arrays\ArrayableInterface::toArray()}, an instance of this class can be turned into an array (including all its embedded objects) which can then be further transformed easily into other formats, such as JSON, XML.

The methods {@see \Yiisoft\Arrays\ArrayableInterface::fields()} and {@see \Yiisoft\Arrays\ArrayableInterface::extraFields()} allow the implementing classes to customize how and which of their data should be formatted and put into the result of {@see \Yiisoft\Arrays\ArrayableInterface::toArray()}.

Public Methods

Hide inherited methods

Method Description Defined By
extraFields() Returns the list of additional fields that can be returned by {@see toArray()} in addition to those listed in {@see fields()}. Yiisoft\Arrays\ArrayableInterface
fields() Returns the list of fields that should be returned by default by {@see toArray()} when no specific fields are specified. Yiisoft\Arrays\ArrayableInterface
toArray() Converts the object into an array. Yiisoft\Arrays\ArrayableInterface

Method Details

Hide inherited methods

extraFields() public abstract method

Returns the list of additional fields that can be returned by {@see toArray()} in addition to those listed in {@see fields()}.

This method is similar to {@see \Yiisoft\Arrays\fields()} except that the list of fields declared by this method are not returned by default by {@see \Yiisoft\Arrays\toArray()}. Only when a field in the list is explicitly requested, will it be included in the result of {@see \Yiisoft\Arrays\toArray()}.

See also:

public abstract array extraFields ( )
return array

The list of expandable field names or field definitions. Please refer to {@see \Yiisoft\Arrays\fields()} on the format of the return value.

 

                public function extraFields(): array;
fields() public abstract method

Returns the list of fields that should be returned by default by {@see toArray()} when no specific fields are specified.

A field is a named element in the returned array by {@see \Yiisoft\Arrays\toArray()}.

This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

  • email: the field name is the same as the property name email;
  • firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
  • fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

See also toArray().

public abstract array fields ( )
return array

The list of field names or field definitions.

 

                public function fields(): array;
toArray() public abstract method

Converts the object into an array.

public abstract array toArray ( string[] $fields = [], string[] $expand = [], boolean $recursive = true )
$fields string[]

The fields that the output array should contain. Fields not specified in {@see \Yiisoft\Arrays\fields()} will be ignored. If this parameter is empty, all fields as specified in {@see \Yiisoft\Arrays\fields()} will be returned.
$expand string[]

The additional fields that the output array should contain. Fields not specified in {@see \Yiisoft\Arrays\extraFields()} will be ignored. If this parameter is empty, no extra fields will be returned.
$recursive boolean

Whether to recursively return array representation of embedded objects.
return array

The array representation of the object.

 

                public function toArray(array $fields = [], array $expand = [], bool $recursive = true): array;