Class luya\behaviors\JsonBehavior

Inheritanceluya\behaviors\JsonBehavior » yii\base\Behavior » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.9
Source Code https://github.com/luyadev/luya/blob/master/core/behaviors/JsonBehavior.php

Json Behavior.

Therefore the JsonBehavior default confiugration let you seamless work with expecting array values, array input and array output. Provides auto encoding for array values after validation in order to store in the database.

An example of how to declared, validate and assign json values (as array):

public function behaviors()
{
    return [
        'json' => [
            'class' => JsonBehavior:class,
            'attributes' => ['json_field'],
        ]
    ];
}

public function rules()
{
    return [
        [['json_field', 'each', 'rule' => ['safe']]]
    ]
}

The above mode assumes an array is passed to the model:

$model->json_field = ['foo' => 'bar'];

Public Properties

Hide inherited properties

Property Type Description Defined By
$attributes luya\behaviors\JsonBehavior
$decodeAfterFind boolean If enabled the data will be encoded from json to array after populating the active record data. luya\behaviors\JsonBehavior
$encodeBeforeValidate boolean If enabled, the data will be encoded before validating, this means the validation rule should be string otherwise the validation must be array. luya\behaviors\JsonBehavior
$events array An Array with all events which should be attached. luya\behaviors\JsonBehavior
$owner yii\base\Component|null The owner of this behavior yii\base\Behavior

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
attach() Attaches the behavior object to the component. yii\base\Behavior
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
decodeAttributes() Decode all attributes from php to json. luya\behaviors\JsonBehavior
detach() Detaches the behavior object from the component. yii\base\Behavior
encodeAttributes() Encode all attributes from json to php. luya\behaviors\JsonBehavior
events() Declares event handlers for the $owner's events. luya\behaviors\JsonBehavior
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
jsonDecode() Decodes the given JSON string into a PHP data structure. luya\behaviors\JsonBehavior
jsonEncode() Encodes the given value into a JSON string. luya\behaviors\JsonBehavior

Property Details

Hide inherited properties

$attributes public property
public $attributes = []
$decodeAfterFind public property (available since version 1.2.0)

If enabled the data will be encoded from json to array after populating the active record data.

public boolean $decodeAfterFind true
$encodeBeforeValidate public property (available since version 1.2.0)

If enabled, the data will be encoded before validating, this means the validation rule should be string otherwise the validation must be array. This might also differ based on how the data is passed to the model. Data passed to the model will be encoded from string to array (if not already).

$events public property (available since version 2.1.0)

An Array with all events which should be attached. Based on {{$encodeBeforeValidate}} and {{$decodeAfterFind}} the array will automatically receive certain events. The main goal for this property is to have the option to attach events by yourself. For example it could be useful to decode values on ngrest find.

[
    'class' => JsonBehavior::class,
    'events' => [NgRestModel::EVENT_AFTER_NGREST_FIND => 'decodeAttributes']
    'attributes' => ['my_super_json_attribute'],
]
public array $events = []

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set (not null).

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}

            
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}

            
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}

            
attach() public method

Defined in: yii\base\Behavior::attach()

Attaches the behavior object to the component.

The default implementation will set the $owner property and attach event handlers as declared in events(). Make sure you call the parent implementation if you override this method.

public void attach ( $owner )
$owner yii\base\Component

The component that this behavior is to be attached to.

                public function attach($owner)
{
    $this->owner = $owner;
    foreach ($this->events() as $event => $handler) {
        $this->_attachedEvents[$event] = $handler;
        $owner->on($event, is_string($handler) ? [$this, $handler] : $handler);
    }
}

            
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}

            
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
decodeAttributes() public method

Decode all attributes from php to json.

public void decodeAttributes ( )

                public function decodeAttributes()
{
    foreach ($this->attributes as $name) {
        $value = $this->owner->{$name};
        
        $this->owner->{$name} = $this->jsonDecode($value);
    }
}

            
detach() public method

Defined in: yii\base\Behavior::detach()

Detaches the behavior object from the component.

The default implementation will unset the $owner property and detach event handlers declared in events(). Make sure you call the parent implementation if you override this method.

public void detach ( )

                public function detach()
{
    if ($this->owner) {
        foreach ($this->_attachedEvents as $event => $handler) {
            $this->owner->off($event, is_string($handler) ? [$this, $handler] : $handler);
        }
        $this->_attachedEvents = [];
        $this->owner = null;
    }
}

            
encodeAttributes() public method

Encode all attributes from json to php.

public void encodeAttributes ( )

                public function encodeAttributes()
{
    foreach ($this->attributes as $name) {
        $value = $this->owner->{$name};
        
        if (is_array($value)) {
            $this->owner->{$name} = $this->jsonEncode($value);
        }
    }
}

            
events() public method

Declares event handlers for the $owner's events.

Child classes may override this method to declare what PHP callbacks should be attached to the events of the $owner component.

The callbacks will be attached to the $owner's events when the behavior is attached to the owner; and they will be detached from the events when the behavior is detached from the component.

The callbacks can be any of the following:

  • method in this behavior: 'handleClick', equivalent to [$this, 'handleClick']
  • object method: [$object, 'handleClick']
  • static method: ['Page', 'handleClick']
  • anonymous function: function ($event) { ... }

The following is an example:

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( )
return array

Events (array keys) and the corresponding event handler methods (array values).

                public function events()
{
    if ($this->encodeBeforeValidate) {
        $this->events[ActiveRecord::EVENT_BEFORE_VALIDATE] = 'encodeAttributes';
    } else {
        $this->events[ActiveRecord::EVENT_AFTER_VALIDATE] = 'encodeAttributes';
    }
    if ($this->decodeAfterFind) {
        $this->events[ActiveRecord::EVENT_AFTER_FIND] = 'decodeAttributes';
    }
    return $this->events;
}

            
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name

return boolean

Whether the method is defined

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

            
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);

See also:

public boolean hasProperty ( $name, $checkVars true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}

            
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}

            
jsonDecode() public method

Decodes the given JSON string into a PHP data structure.

public array jsonDecode ( $value )
$value string

                public function jsonDecode($value)
{
    // data is already passed by array
    if (is_array($value)) {
        return $value;
    }
    return Json::decode($value);
}

            
jsonEncode() public method

Encodes the given value into a JSON string.

public string jsonEncode ( $value )
$value mixed

This is commonly an array.

                public function jsonEncode($value)
{
    // if value is already a json, skip encoding and return result
    // ensure data is not doulble encoded or throws exception
    if (Json::isJson($value)) {
        return $value;
    }
    return Json::encode($value);
}