Class luya\cms\menu\QueryIterator

Inheritanceluya\cms\menu\QueryIterator » yii\base\BaseObject
ImplementsIterator, yii\base\Configurable
Available since version1.0.0

Iterator class for menu items.

The main goal is to to createa an object for the item on the current() iteration.

Public Properties

Hide inherited properties

Property Type Description Defined By
$data array An array containing the data to iterate. luya\cms\menu\QueryIterator
$lang string|null Can contain the language context, so the sub querys for this item will be the same language context as the parent object which created this object. luya\cms\menu\QueryIterator
$preloadModels boolean Whether all models for each menu element should be preloaded or not, on large systems with propertie access it can reduce the sql requests but uses more memory instead. luya\cms\menu\QueryIterator
$with luya\cms\menu\QueryIterator

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
current() Iterator get current element, generates a new object for the current item on accessing.s. luya\cms\menu\QueryIterator
generateItem() Generate the Item Object based on array input. luya\cms\menu\QueryIterator
getLoadedModel() Get the model for a given id. luya\cms\menu\QueryIterator
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
key() Iterator get current key. luya\cms\menu\QueryIterator
loadModels() Load all models for ghe given Menu Query. luya\cms\menu\QueryIterator
next() Iterator go to next element. luya\cms\menu\QueryIterator
rewind() Iterator rewind. luya\cms\menu\QueryIterator
valid() Iterator valid. luya\cms\menu\QueryIterator

Property Details

Hide inherited properties

$data public property

An array containing the data to iterate.

public array $data = []
$lang public property

Can contain the language context, so the sub querys for this item will be the same language context as the parent object which created this object.

public string|null $lang null
$preloadModels public property

Whether all models for each menu element should be preloaded or not, on large systems with propertie access it can reduce the sql requests but uses more memory instead.

public boolean $preloadModels false
$with public property
public $with = []

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

            
current() public method

Iterator get current element, generates a new object for the current item on accessing.s.

public luya\cms\menu\Item current ( )

                #[\ReturnTypeWillChange]
public function current()
{
    $item = current($this->data);
    return $this->generateItem($item);
}

            
generateItem() public method (available since version 3.2.0)

Generate the Item Object based on array input.

public luya\cms\menu\Item generateItem ( $item )
$item array

The data of the item

                public function generateItem($item)
{
    // if item is already an object, return the created object.
    // This allows to pass arrays with luya\cms\menu\Item objects which has been created in
    // an earlier stage.
    if (is_object($item)) {
        return $item;
    }
    return Query::createItemObject($item, $this->lang, $this->getLoadedModel($item['id']));
}

            
getLoadedModel() public method

Get the model for a given id.

If the model was not preloaded by {{loadModels}} null is returned.

public null|luya\cms\models\Nav getLoadedModel ( $id )
$id integer

                public function getLoadedModel($id)
{
    return $this->_loadModels[$id] ?? null;
}

            
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()
{
}

            
key() public method

Iterator get current key.

public string key ( )
return string

The current key

                #[\ReturnTypeWillChange]
public function key()
{
    return key($this->data);
}

            
loadModels() public method

Load all models for ghe given Menu Query.

public array loadModels ( )
return array

An array where the key is the id of the nav model and value the {{luya\cms\models\Nav}} object.

                public function loadModels()
{
    if ($this->_loadModels === null) {
        $this->_loadModels = Nav::find()->indexBy('id')->where(['in', 'id', ArrayHelper::getColumn($this->data, 'nav_id')])->with(['properties.adminProperty'])->all();
    }
    return $this->_loadModels;
}

            
next() public method

Iterator go to next element.

public array next ( )

                #[\ReturnTypeWillChange]
public function next()
{
    return next($this->data);
}

            
rewind() public method

Iterator rewind.

public array rewind ( )

                #[\ReturnTypeWillChange]
public function rewind()
{
    return reset($this->data);
}

            
valid() public method

Iterator valid.

public boolean valid ( )

                #[\ReturnTypeWillChange]
public function valid()
{
    return key($this->data) !== null;
}