| Property | Type | Description | |
|---|---|---|---|
| $cacheEnabled | Whether the caching property should be displayed or not inside the block. | ||
| $config | Provide the configuration array which is inside the config() method of the block. | ||
| $dryRun | If dry run is enabled the content of the block will be returned but no files will be created. This is usefull for unit testing. | ||
| $extras | An array with the list of extras which are generated during the var creator process, example content 'foo' => 'value', | ||
| $isContainer | Whether the block is a container/layout block or not this will enable/dsiable the $isContainer property | ||
| $moduleName | If type is module the name of the module must be provided with this $moduleName property. | ||
| $phpdoc | An array with all phpdoc comments which should be added to the admin template, exmaple content ['{{extras.foobar}}']. | ||
| $type | The type of block, valid app (static::TYPE_APP) or module (static::TYPE_TMODULE) values. | ||
| $viewFileDoc | Am array with additional docblocks messages to render inside the view file. |
| Method | Description | |
|---|---|---|
| actionCreate ( ) : number | Wizzard to create a new CMS block. | |
| generateViewFile ( string $blockClassName ) : string | Generate the view file for the block. | |
| getBlockName ( ) : string | Getter method fro $blockName. | |
| setBlockName ( string $name ) | Setter method for $blockName, ensure the correct block name. |
| Method | Description | |
|---|---|---|
| getFileBasePath ( ) : string | Get the full base path to the folder of the module | |
| getFileNamespace ( ) : string | Get the file namespace based on its type. |
| Method | Description | |
|---|---|---|
| getExtraVarDef ( $type, $varName, $func ) | ||
| getModuleProposal ( ) : array | Get an array with all modules where you can generate blocks for. | |
| getVariableTypeOption ( $type ) | ||
| getVariableTypes ( ) | ||
| getVariableTypesOptions ( ) | ||
| hasVariableTypeOption ( $type ) | ||
| placeholderCreator ( $prefix ) | ||
| varCreator ( string $prefix, string $typeCast ) : array | Create a variable based of user input. |
| public actionCreate ( ) : number | ||
| return | number | |
| public generateViewFile ( string $blockClassName ) : string | ||
| $blockClassName | string | The name of the block class. |
| return | string | The rendered view file. |
| public getBlockName ( ) : string | ||
| return | string | Get the ensured block name. |
| protected getFileBasePath ( ) : string | ||
| return | string | The full path to the module folder. |
| protected getFileNamespace ( ) : string | ||
| return | string | The full qualified namespace based on the type |
| public setBlockName ( string $name ) | ||
| $name | string | The name of the block. |
| public $cacheEnabled |
| public $config |
| public $dryRun |
| public $extras |
| public $isContainer |
| public $moduleName |
| public $phpdoc |
| public $type |
