Class luya\cms\admin\importers\BlockImporter

Inheritanceluya\cms\admin\importers\BlockImporter » luya\console\Importer » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.0

CMS Blocks Importer.

Public Properties

Hide inherited properties

Property Type Description Defined By
$importer luya\console\interfaces\ImportControllerInterface Importer object. luya\console\Importer
$module luya\base\Module The module context object. luya\console\Importer
$queueListPosition integer The priority between 0 and 100 where to Import command should be queued. luya\console\Importer

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Class constructor containing the importer object from where its called. luya\console\Importer
__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
addLog() Add something to the output. Wrapper method from importer. luya\console\Importer
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
getImporter() Returns the import object to use the importers methods. luya\console\Importer
getModule() Returns the module object where the command has been found. luya\console\Importer
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
replaceDsSeparator() Replace {{DS}} separator. luya\cms\admin\importers\BlockImporter
run() Each Importer Class must contain a run method. luya\cms\admin\importers\BlockImporter

Protected Methods

Hide inherited methods

Method Description Defined By
createBlockObject() Create a block object based from the class name. luya\cms\admin\importers\BlockImporter
getBlockGroupId() The the group of a block based on the block object. luya\cms\admin\importers\BlockImporter
getBlockIdsByPath() Get an array of ids for a given path. luya\cms\admin\importers\BlockImporter
handleBlockDefinitions() Handle an array with definitions whether they are files or folders. luya\cms\admin\importers\BlockImporter
handleBlockDefintionInDirectories() Handle a block defintion for different folders luya\cms\admin\importers\BlockImporter
saveBlock() Save a block by its given full class name. luya\cms\admin\importers\BlockImporter
saveBlockByPath() Save a block by its path, this will extract the namespace of the block in order to save it. luya\cms\admin\importers\BlockImporter
saveBlocksFromFolder() Save all blocks from a given folder. luya\cms\admin\importers\BlockImporter

Constants

Hide inherited constants

Constant Value Description Defined By
QUEUE_POSITION_FIRST 0 luya\console\Importer
QUEUE_POSITION_LAST 100 luya\console\Importer
QUEUE_POSITION_MIDDLE 50 luya\console\Importer

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: luya\console\Importer::__construct()

Class constructor containing the importer object from where its called.

public void __construct ( luya\console\interfaces\ImportControllerInterface $importer, luya\base\Module $module, $config = [] )
$importer luya\console\interfaces\ImportControllerInterface

Import Object \luya\commands\ImportController.

$module
$config

                public function __construct(ImportControllerInterface $importer, Module $module, $config = [])
{
    $this->_importer = $importer;
    $this->_module = $module;
    
    parent::__construct($config);
}

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

            
addLog() public method

Defined in: luya\console\Importer::addLog()

Add something to the output. Wrapper method from importer.

$this->addLog('new block <ID> have been found and added to database');
public void addLog ( $value )
$value string

The value to be written for the log output.

                public function addLog($value)
{
    $this->getImporter()->addLog(get_called_class(), $value);
}

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

            
createBlockObject() protected method

Create a block object based from the class name.

protected object|mixed createBlockObject ( $className )
$className string

                protected function createBlockObject($className)
{
    return Yii::createObject(['class' => $className]);
}

            
getBlockGroupId() protected method

The the group of a block based on the block object.

protected integer getBlockGroupId ( luya\cms\base\BlockInterface $blockObject )
$blockObject luya\cms\base\BlockInterface

                protected function getBlockGroupId(BlockInterface $blockObject)
{
    $groupClassName = $blockObject->blockGroup();
    $groupClassName = '\\'  . ltrim($groupClassName, '\\');
    $groupObject = Yii::createObject(['class' => $groupClassName]);
    $group = BlockGroup::findOne(['identifier' => $groupObject->identifier()]);
    if ($group) {
        $group->updateAttributes([
            'name' => $groupObject->label(),
            'class' => $groupClassName,
            'is_deleted' => false,
        ]);
        return $group->id;
    } else {
        $model = new BlockGroup();
        $model->name = $groupObject->label();
        $model->identifier = $groupObject->identifier();
        $model->created_timestamp = time();
        $model->class = $groupClassName;
        if ($model->save()) {
            $this->addLog("Insert new block group {$model->name}.");
            return $model->id;
        }
    }
    return 0;
}

            
getBlockIdsByPath() protected method (available since version 2.0.0)

Get an array of ids for a given path.

protected array getBlockIdsByPath ( $path )
$path string
return array

An array with block ids or an empty array if not found.

                protected function getBlockIdsByPath($path)
{
    if (is_file($path)) {
        $id = $this->saveBlockByPath($path);
        if ($id) {
            return [$id];
        }
    } elseif (is_dir($path)) {
        return $this->saveBlocksFromFolder($path);
    }
    return [];
}

            
getImporter() public method

Defined in: luya\console\Importer::getImporter()

Returns the import object to use the importers methods.

public luya\console\interfaces\ImportControllerInterface getImporter ( )
return luya\console\interfaces\ImportControllerInterface

The importer object.

                public function getImporter()
{
    return $this->_importer;
}

            
getModule() public method (available since version 1.0.8)

Defined in: luya\console\Importer::getModule()

Returns the module object where the command has been found.

public luya\base\Module getModule ( )

                public function getModule()
{
    return $this->_module;
}

            
handleBlockDefinitions() protected method (available since version 1.0.8)

Handle an array with definitions whether they are files or folders.

protected array handleBlockDefinitions ( array $definitions )
$definitions array

                protected function handleBlockDefinitions(array $definitions)
{
    // A list of directories which should be prefix to the current block definition,
    // as a block definition can contain an alias with a full path, we need an empty "prefix"
    // directory, which is represented as `null` value at the end of the array.
    $directories = array_unique([Yii::getAlias('@app'), getcwd(), null]);
    $ids = [];
    foreach ($definitions as $blockDefinition) {
        // find an alias for the defintion (@app/xyz/Block)
        $block = Yii::getAlias($blockDefinition, false);
        // if there is no alias, or not found, switch back to original name
        if ($block === false) {
            $block = $blockDefinition;
        }
        $ids = array_merge($ids, $this->handleBlockDefintionInDirectories($directories, $block));
    }
    return $ids;
}

            
handleBlockDefintionInDirectories() protected method (available since version 2.0.0)

Handle a block defintion for different folders

protected array handleBlockDefintionInDirectories ( array $directories, $blockDefinition )
$directories array
$blockDefinition string

                protected function handleBlockDefintionInDirectories(array $directories, $blockDefinition)
{
    $results = [];
    foreach ($directories as $directoryPath) {
        $path = rtrim((string) $directoryPath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . ltrim((string) $blockDefinition, DIRECTORY_SEPARATOR);
        $path = $this->replaceDsSeparator($path);
        if (isset($results[$path])) {
            continue;
        }
        $blockIds = $this->getBlockIdsByPath($path);
        if (!empty($blockIds)) {
            $results[$path] = $blockIds;
        }
    }
    if (empty($results)) {
        $this->addLog("Unable to find '{$blockDefinition}' in any of those paths '".implode(",", $directories)."'");
    }
    $return = [];
    foreach ($results as $path => $ids) {
        $return = array_merge($return, $ids);
    }
    return $return;
}

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

            
replaceDsSeparator() public method

Replace {{DS}} separator.

public string replaceDsSeparator ( $path )
$path string

                public function replaceDsSeparator($path)
{
    return str_replace('{{DS}}', DIRECTORY_SEPARATOR, $path);
}

            
run() public method

Each Importer Class must contain a run method.

public void run ( )

                public function run()
{
    // when the setup timestamp is not yet set, its a fresh installation, therefore skip the 1.0.0 generic block upgrade
    // otherwise its an existing/upgrading instance which is doing the import command.
    if (!Config::has(Config::CONFIG_SETUP_COMMAND_TIMESTAMP)) {
        Config::set('100genericBlockUpdate', true);
    }
    if (!Config::has('100genericBlockUpdate')) {
        throw new Exception("You have to run the generic block updater. ./vendor/bin/luya cms/updater/generic");
    }
    $exists = [];
    foreach ($this->getImporter()->getDirectoryFiles('blocks') as $file) {
        $exists[] = $this->saveBlock($file['ns']);
    }
    foreach (Yii::$app->packageInstaller->configs as $config) {
        $exists = array_merge($exists, $this->handleBlockDefinitions($config->blocks));
    }
    // provide backwards compatibility for core 1.0.7 and below
    if ($this->hasProperty('module')) {
        $exists = array_merge($exists, $this->handleBlockDefinitions($this->module->blocks));
    }
    foreach (Block::find()->all() as $block) {
        if (!class_exists($block->class)) {
            $this->addLog("[!] The block {$block->class} used {$block->usageCount} times, does not exists anymore. You should either use migrate or cleanup command.");
        }
    }
    // remove unused block groups
    foreach (BlockGroup::find()->andWhere(['not in', 'id', $this->blockGroupIds])->all() as $oldBlockGroup) {
        if ($oldBlockGroup->delete()) {
            $this->addLog('Old blockgroup has been deleted: ' . $oldBlockGroup->name);
        }
    }
    return $this->addLog("Block importer finished with ".count($exists) . " blocks.");
}

            
saveBlock() protected method

Save a block by its given full class name.

Example full class name: luya\cms\blocks\ModuleBlock

protected \luya\cms\admin\importers\number saveBlock ( $fullClassName )
$fullClassName string

                protected function saveBlock($fullClassName)
{
    // ensure all classes start with trailing slash class name definition like `\foo\bar\Class`
    $fullClassName = '\\'  . ltrim($fullClassName, '\\');
    $model = Block::find()->where(['class' => $fullClassName])->one();
    $blockObject = $this->createBlockObject($fullClassName);
    $blockGroupId = $this->getBlockGroupId($blockObject);
    if (!in_array($blockGroupId, $this->blockGroupIds)) {
        $this->blockGroupIds[] = $blockGroupId;
    }
    $log = "block {$fullClassName}: ";
    if (!$model) {
        $model = new Block();
        $model->group_id = $blockGroupId;
        $model->class = $fullClassName;
        if ($model->save()) {
            $log .= "Added to database";
        } else {
            $log .= "Error while saving";
        }
    } elseif ($model->group_id != $blockGroupId) {
        $log .= 'Updated group id"';
        $model->updateAttributes(['group_id' => $blockGroupId]);
    } else {
        $log .= 'remains the same, nothing to update';
    }
    $this->addLog($log);
    return $model->id;
}

            
saveBlockByPath() protected method

Save a block by its path, this will extract the namespace of the block in order to save it.

Example path: /apps/myblocks/ExampleBlock.php

Example path: `

protected \luya\cms\admin\importers\number|boolean saveBlockByPath ( $path )
$path string

                protected function saveBlockByPath($path)
{
    $info = FileHelper::classInfo($path);
    if ($info) {
        $className = $info['namespace'] . '\\' . $info['class'];
        return $this->saveBlock($className);
    }
    $this->addLog("Unable to find block namespace for file '{$path}'.");
    return false;
}

            
saveBlocksFromFolder() protected method (available since version 1.0.8)

Save all blocks from a given folder.

protected \luya\cms\admin\importers\number[]|boolean[] saveBlocksFromFolder ( $folder )
$folder string

                protected function saveBlocksFromFolder($folder)
{
    $ids = [];
    if (is_dir($folder)) {
        foreach (FileHelper::findFiles($folder) as $blockItem) {
            $ids[] = $this->saveBlockByPath($blockItem);
        }
    }
    return $ids;
}