Final Class luya\cms\injectors\ActiveQueryCheckboxInjector

All Classes | Properties | Methods
Inheritanceluya\cms\injectors\ActiveQueryCheckboxInjector » luya\cms\injectors\BaseActiveQueryInjector » luya\cms\base\BaseBlockInjector » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.0
Source Code https://github.com/luyadev/luya-module-cms/blob/master/src/injectors/ActiveQueryCheckboxInjector.php

Checkboxes from an ActiveQuery.

Generates a checkbox selection from an active query interface and returns the models via the ActiveDataProvider.

An example for the injector config:

new ActiveQueryCheckboxInjector([
    'query' => \newsadmin\models\Article::find()->where(['cat_id' => 1]),
    'label' => 'title', // This attribute from the model is used to render the admin block dropdown selection.
]);

In order to configure the ActiveQueryCheckboxInjector used the {{\luya\cms\base\InternalBaseBlock::injectors}} method:

public function injectors()
{
    return [
       'theData' => new ActiveQueryCheckboxInjector([
            'query' => News::find()->where(['is_deleted' => 0]),
            'label' => function($model) {
                return $model->title . " - " . $model->description;
            },
        ]);
   ];
}

Public Properties

Hide inherited properties

Property Type Description Defined By
$append boolean Whether the variable should be at the start (prepand) or end (append) of the configration. luya\cms\base\BaseBlockInjector
$context luya\cms\base\BlockInterface The context block object where the injector is placed. luya\cms\base\BaseBlockInjector
$contextConfig array The config of the variable to inject luya\cms\base\BaseBlockInjector
$label null|string|\luya\cms\injectors\closure This attribute from the model is used to render the admin block dropdown selection. luya\cms\injectors\BaseActiveQueryInjector
$pagination boolean|array Whether the extra assigned data should enable pagination. luya\cms\injectors\BaseActiveQueryInjector
$query yii\db\ActiveQueryInterface The ActiveQuery object luya\cms\injectors\ActiveQueryCheckboxInjector
$type string The type of variable is used for the inject. luya\cms\base\BaseBlockInjector
$varLabel string The label used in the administration area for this injector. luya\cms\base\BaseBlockInjector
$varName string The name of the variable on what the injector should use and listen to. luya\cms\base\BaseBlockInjector

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
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
getContext() Getter for the context variable on where the block is injected. luya\cms\base\BaseBlockInjector
getContextConfigValue() Returns the value of the variable which is defined for this injector object based on it given type. luya\cms\base\BaseBlockInjector
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
setContext() Setter for the context value must be typeof BlockInterface. luya\cms\base\BaseBlockInjector
setContextConfig() Set a new configuration value for a variable based on its context (cfg or var). luya\cms\base\BaseBlockInjector
setQuery() Setter method for the active query interface. luya\cms\injectors\BaseActiveQueryInjector
setup() The setup method which all injectors must implement. The setup method is mainly to inject the variable into the configs and setting up the extra vars values. luya\cms\injectors\ActiveQueryCheckboxInjector

Protected Methods

Hide inherited methods

Method Description Defined By
getExtraAssignArrayData() Get the Active Record models from the stored block values luya\cms\injectors\BaseActiveQueryInjector
getExtraAssignSingleData() Get a single active record based on the stored block value. luya\cms\injectors\BaseActiveQueryInjector
getQuery() Get the Active Query Object. luya\cms\injectors\BaseActiveQueryInjector
getQueryData() Get an array with options luya\cms\injectors\BaseActiveQueryInjector

Property Details

Hide inherited properties

$query public property

The ActiveQuery object

public yii\db\ActiveQueryInterface $query = null

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);
    }
}
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();
}
getContext() public method

Defined in: luya\cms\base\BaseBlockInjector::getContext()

Getter for the context variable on where the block is injected.

public luya\cms\base\BlockInterface getContext ( )

                public function getContext()
{
    return $this->_context;
}
getContextConfigValue() public method

Defined in: luya\cms\base\BaseBlockInjector::getContextConfigValue()

Returns the value of the variable which is defined for this injector object based on it given type.

public mixed getContextConfigValue ( $varName, $defaultValue = null )
$varName string
$defaultValue mixed

The default value for the variable if not found.
throws yii\base\InvalidConfigException 

                public function getContextConfigValue($varName, $defaultValue = null)
{
    if ($this->type == InternalBaseBlock::INJECTOR_VAR) {
        return $this->context->getVarValue($varName, $defaultValue);
    }
    if ($this->type == InternalBaseBlock::INJECTOR_CFG) {
        return $this->context->getCfgValue($varName, $defaultValue);
    }
    throw new InvalidConfigException("The type '{$this->type}' is not supported.");
}
getExtraAssignArrayData() protected method

Defined in: luya\cms\injectors\BaseActiveQueryInjector::getExtraAssignArrayData()

Get the Active Record models from the stored block values

protected yii\db\ActiveRecord[] getExtraAssignArrayData ( )

                protected function getExtraAssignArrayData()
{
    $ids = ArrayHelper::getColumn($this->getContextConfigValue($this->varName, []), 'value');
    $provider = new ActiveDataProvider([
        'query' => $this->_query->andWhere(['in', 'id', $ids]),
        'pagination' => $this->pagination,
    ]);
    return $provider->getModels();
}
getExtraAssignSingleData() protected method

Defined in: luya\cms\injectors\BaseActiveQueryInjector::getExtraAssignSingleData()

Get a single active record based on the stored block value.

protected yii\db\ActiveRecord getExtraAssignSingleData ( )

                protected function getExtraAssignSingleData()
{
    $value = $this->getContextConfigValue($this->varName);
    if (!$value) {
        return false;
    }
    return $this->getQuery()->where(['id' => $value])->one();
}
getQuery() protected method (available since version 2.1.0)

Defined in: luya\cms\injectors\BaseActiveQueryInjector::getQuery()

Get the Active Query Object.

protected yii\db\ActiveQueryInterface getQuery ( )

                protected function getQuery()
{
    return $this->_query;
}
getQueryData() protected method

Defined in: luya\cms\injectors\BaseActiveQueryInjector::getQueryData()

Get an array with options

protected array getQueryData ( )

                protected function getQueryData()
{
    $provider = new ActiveDataProvider([
        'query' => $this->_query,
        'pagination' => false,
    ]);
    $data = [];
    foreach ($provider->getModels() as $model) {
        if (is_callable($this->label)) {
            $label = call_user_func($this->label, $model);
        } elseif (is_string($this->label)) {
            $label = $model->{$this->label};
        } else {
            $label = implode(", ", $model->getAttributes());
        }
        $data[] = ['value' => $model->primaryKey, 'label' => $label];
    }
    return $data;
}
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()
{
}
setContext() public method

Defined in: luya\cms\base\BaseBlockInjector::setContext()

Setter for the context value must be typeof BlockInterface.

public void setContext ( luya\cms\base\BlockInterface $context )
$context luya\cms\base\BlockInterface

The block context which will be injected on setup.

 

                public function setContext(BlockInterface $context)
{
    $this->_context = $context;
}
setContextConfig() public method

Defined in: luya\cms\base\BaseBlockInjector::setContextConfig()

Set a new configuration value for a variable based on its context (cfg or var).

public void setContextConfig ( array $config )
$config array

The config of the variable to inject
throws yii\base\InvalidConfigException 

                public function setContextConfig(array $config)
{
    if ($this->type == InternalBaseBlock::INJECTOR_VAR) {
        return $this->context->addVar($config, $this->append);
    }
    if ($this->type == InternalBaseBlock::INJECTOR_CFG) {
        return $this->context->addCfg($config, $this->append);
    }
    throw new InvalidConfigException("The type '{$this->type}' is not supported.");
}
setQuery() public method

Defined in: luya\cms\injectors\BaseActiveQueryInjector::setQuery()

Setter method for the active query interface.

Define the active query which will be used to retrieve data must be an instance of {{\yii\db\ActiveQueryInterface}}.

public void setQuery ( yii\db\ActiveQueryInterface $query )
$query yii\db\ActiveQueryInterface

The query provider for the {{yii\data\ActiveDataProvider}}.

 

                public function setQuery(ActiveQueryInterface $query)
{
    $this->_query = $query;
}
setup() public method

The setup method which all injectors must implement. The setup method is mainly to inject the variable into the configs and setting up the extra vars values.

public void setup ( )

                public function setup()
{
    // injecto the config
    $this->setContextConfig([
        'var' => $this->varName,
        'type' => TypesInterface::TYPE_CHECKBOX_ARRAY,
        'label' => $this->varLabel,
        'options' => [
            'items' => $this->getQueryData(),
        ],
    ]);
    // provide the extra data
    $this->context->addExtraVar($this->varName, $this->getExtraAssignArrayData());
}