class BlockController extends AbstractController (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from ApplicationAwareTrait
protected $helpers
protected $sets from AbstractController
protected $action from AbstractController
protected $request from AbstractController
protected $parameters from AbstractController
$headerItems
$blockViewRenderOverride
protected $record
protected $block
protected $bID
protected $btDescription
protected $btName
protected $btHandle
protected $btIsInternal
protected $btSupportsInlineAdd
protected $btIgnorePageThemeGridFrameworkContainer
protected $btSupportsInlineEdit
protected $btCopyWhenPropagate
protected $btIncludeAll
protected $btInterfaceWidth
protected $btInterfaceHeight
protected $btHasRendered
protected $btCacheBlockRecord
protected $btCacheBlockOutput
protected $btCacheBlockOutputLifetime
protected $btCacheBlockOutputOnPost
protected $btCacheBlockOutputForRegisteredUsers
protected $bActionCID
protected $btExportPageColumns
protected $btExportFileColumns
protected $btExportPageTypeColumns
protected $btExportPageFeedColumns
protected $btWrapperClass
protected $btDefaultSet
protected $btFeatures
protected $btFeatureObjects
protected $identifier
protected $btTable
protected bool $supportSavingNullValues Set this to true if the data sent to the save/performSave methods can contain NULL values that should be persisted.

Methods

setApplication(Application $app)

Setter method for the application

__construct(BlockType $obj = null)

Instantiates the block controller.

mixed
getRequest()

No description

setRequest(mixed $request)

No description

requireAsset()

No description

addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

set($key, $val)

No description

getSets()

No description

getHelperObjects()

No description

get($key = null, $defaultValue = null)

No description

getTask()

No description

getAction()

No description

getParameters()

No description

on_start()

No description

on_before_render()

No description

isPost() deprecated

No description

post($field = false, $defaultValue = null)

No description

redirect()

No description

runTask($action, $parameters)

No description

runAction($action, $parameters = array())

No description

request($key = null)

No description

getBlockTypeInSetName()

No description

getIdentifier()

No description

getBlockTypeWrapperClass()

No description

mixed
install(string $path)

Installs the current block's DB xml file. If a block needs to do more than this, this should be overridden.

render(string $view)

Renders a view in the block's folder.

validate($args)

No description

getBlockControllerData()

No description

performSave(array $args, bool $loadExisting = false)

Persist the block options.

save(array $args)

Run when a block is added or edited. Automatically saves block data against the block's database table. If a block needs to do more than this (save to multiple tables, upload files, etc.

cacheBlockRecord()

No description

getPermissionsObject() deprecated

No description

getBlockTypeDefaultSet()

No description

getPermissionObject()

Gets the permissions object for this controller's block.

duplicate($newBID)

Automatically run when a block is duplicated. This most likely happens when a block is edited: a block is first duplicated, and then presented to the user to make changes.

__wakeup()

No description

setBlockObject($b)

Sets the block object for this controller.

load()

Loads the BlockRecord class based on its attribute names.

getBlockTypeFeatureObjects()

No description

export(SimpleXMLElement $blockNode)

No description

getBlockTypeDatabaseTable()

No description

import($page, $arHandle, SimpleXMLElement $blockNode)

No description

getImportData($blockNode, $page)

No description

importAdditionalData($b, $blockNode)

No description

setPassThruBlockController(PageController $controller)

No description

getPassThruActionAndParameters($parameters)

No description

isValidControllerTask($method, $parameters = [])

No description

cacheBlockOutput()

No description

cacheBlockOutputOnPost()

No description

getCollectionObject()

No description

field($fieldName)

No description

getBlockObject()

Gets the generic Block object attached to this controller's instance.

$void
delete()

Automatically run when a block is deleted. This removes the special data from the block's specific database table. If a block needs to do more than this this method should be overridden.

outputAutoHeaderItems()

No description

registerViewAssets($outputContent = '')

No description

setupAndRun($method)

No description

Area
getAreaObject()

Gets the Area object attached to this controller's instance.

setAreaObject($a)

No description

uninstall()

No description

string
getBlockTypeName()

Returns the name of the block type.

int
getInterfaceWidth()

Returns the width of the block type's interface when presented in page.

int
getInterfaceHeight()

Returns the height of the block type's interface when presented in page.

string
getBlockTypeDescription()

Returns the description of the block type.

getBlockTypeHelp()

Returns HTML that will be shown when a user wants help for a given block type.

isCopiedWhenPropagated()

No description

bool
includeAll()

Returns whether this block type is included in all versions. Default is false - block types are typically versioned but sometimes it makes sense not to do so.

bool
isBlockTypeInternal()

Returns whether this block type is internal to Concrete. If it's internal it's not displayed in the front end interface. Examples include the LibraryFile block.

bool
supportsInlineEdit()

if a the current BlockType supports inline edit or not.

bool
supportsInlineAdd()

if a the current BlockType supports inline add or not.

bool
ignorePageThemeGridFrameworkContainer()

If true, container classes will not be wrapped around this block type in edit mode (if the theme in question supports a grid framework.

getJavaScriptStrings()

Returns a key/value array of strings that is used to translate items when used in javascript.

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct(BlockType $obj = null)

Instantiates the block controller.

Parameters

BlockType $obj |Block $obj

mixed getRequest()

Return Value

mixed

setRequest(mixed $request)

Parameters

mixed $request

requireAsset()

addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

Parameters

string $item

addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

Parameters

string $item

set($key, $val)

Parameters

$key
$val

getSets()

shouldRunControllerTask()

getHelperObjects()

get($key = null, $defaultValue = null)

Parameters

$key
$defaultValue

getTask()

getAction()

getParameters()

on_start()

on_before_render()

isPost() deprecated

deprecated

post($field = false, $defaultValue = null)

Parameters

$field
$defaultValue

redirect()

runTask($action, $parameters)

Parameters

$action
$parameters

runAction($action, $parameters = array())

Parameters

$action
$parameters

request($key = null)

Parameters

$key

getBlockTypeInSetName()

getBlockTypeExportPageColumns()

getIdentifier()

getBlockTypeWrapperClass()

mixed install(string $path)

Installs the current block's DB xml file. If a block needs to do more than this, this should be overridden.

public function install($path) { $this->doMySpecialInstallMethod(); $this->doSecondSpecialInstallMethod(); parent::install($path); } .

There are several different possible return values: Returns FALSE if $btTable is set but no db.xml file exists. Otherwise returns object with two properties: ->result (a boolean), and ->message (a string). If ->result is true, the installation was successful (although the db.xml file might only have one field declared which will cause C5 to have problems later on, so you you will want to check for that separately). If ->result is false, the installation failed and you can check ->message for the explanation (usually -- sometimes ->message will be blank, in which case there's either a malformed db.xml file or an "unknown database error"). See concrete/models/block_types.php::doInstallBlockType() for usage example.

Parameters

string $path

Return Value

mixed boolean or object having ->result (boolean) and ->message (string) properties

render(string $view)

Renders a view in the block's folder.

public function view() { // The view() method is automatically run when a block is viewed $this->render("other_special_view"); // don't use .php } .

Parameters

string $view

validate($args)

Parameters

$args

getBlockControllerData()

protected performSave(array $args, bool $loadExisting = false)

Persist the block options.

Parameters

array $args An array that contains the block options
bool $loadExisting Shall we initialize the record to be saved with the current data?

save(array $args)

Run when a block is added or edited. Automatically saves block data against the block's database table. If a block needs to do more than this (save to multiple tables, upload files, etc.

.. it should override this.

Parameters

array $args

cacheBlockRecord()

getPermissionsObject() deprecated

deprecated

getBlockTypeDefaultSet()

getPermissionObject()

Gets the permissions object for this controller's block.

BlockRecord duplicate($newBID)

Automatically run when a block is duplicated. This most likely happens when a block is edited: a block is first duplicated, and then presented to the user to make changes.

Parameters

$newBID

Return Value

BlockRecord $newInstance

__wakeup()

setBlockObject($b)

Sets the block object for this controller.

Parameters

$b

protected load()

Loads the BlockRecord class based on its attribute names.

getBlockTypeFeatureObjects()

export(SimpleXMLElement $blockNode)

Parameters

SimpleXMLElement $blockNode

getBlockTypeDatabaseTable()

import($page, $arHandle, SimpleXMLElement $blockNode)

Parameters

$page
$arHandle
SimpleXMLElement $blockNode

protected getImportData($blockNode, $page)

Parameters

$blockNode
$page

protected importAdditionalData($b, $blockNode)

Parameters

$b
$blockNode

setPassThruBlockController(PageController $controller)

Parameters

PageController $controller

validateAddBlockPassThruAction(Checker $ap, BlockType $bt)

Parameters

Checker $ap
BlockType $bt

validateEditBlockPassThruAction(Block $b)

Parameters

Block $b

validateComposerAddBlockPassThruAction(Type $type)

Parameters

Type $type

validateComposerEditBlockPassThruAction(Block $b)

Parameters

Block $b

getPassThruActionAndParameters($parameters)

Parameters

$parameters

isValidControllerTask($method, $parameters = [])

Parameters

$method
$parameters

cacheBlockOutput()

cacheBlockOutputForRegisteredUsers()

cacheBlockOutputOnPost()

getBlockTypeCacheOutputLifetime()

getCollectionObject()

field($fieldName)

Parameters

$fieldName

Block getBlockObject()

Gets the generic Block object attached to this controller's instance.

Return Value

Block $b

$void delete()

Automatically run when a block is deleted. This removes the special data from the block's specific database table. If a block needs to do more than this this method should be overridden.

Return Value

$void

outputAutoHeaderItems()

registerViewAssets($outputContent = '')

Parameters

$outputContent

setupAndRun($method)

Parameters

$method

Area getAreaObject()

Gets the Area object attached to this controller's instance.

Return Value

Area $a

setAreaObject($a)

Parameters

$a

uninstall()

string getBlockTypeName()

Returns the name of the block type.

Return Value

string $btName

int getInterfaceWidth()

Returns the width of the block type's interface when presented in page.

Return Value

int

int getInterfaceHeight()

Returns the height of the block type's interface when presented in page.

Return Value

int

string getBlockTypeDescription()

Returns the description of the block type.

Return Value

string

getBlockTypeHelp()

Returns HTML that will be shown when a user wants help for a given block type.

isCopiedWhenPropagated()

bool includeAll()

Returns whether this block type is included in all versions. Default is false - block types are typically versioned but sometimes it makes sense not to do so.

Return Value

bool

bool isBlockTypeInternal()

Returns whether this block type is internal to Concrete. If it's internal it's not displayed in the front end interface. Examples include the LibraryFile block.

Return Value

bool

bool supportsInlineEdit()

if a the current BlockType supports inline edit or not.

Return Value

bool

bool supportsInlineAdd()

if a the current BlockType supports inline add or not.

Return Value

bool

bool ignorePageThemeGridFrameworkContainer()

If true, container classes will not be wrapped around this block type in edit mode (if the theme in question supports a grid framework.

Return Value

bool

getJavaScriptStrings()

Returns a key/value array of strings that is used to translate items when used in javascript.