class BlockControl extends Control (View source)

Properties

$error from ConcreteObject
protected $ptComposerControlIdentifier from Control
protected $ptComposerControlName from Control
protected $ptComposerControlIconSRC from Control
protected $ptComposerControlIconFormatter from Control
protected $ptComposerControl from Control
protected $ptComposerControlRequiredByDefault from Control
protected $ptComposerControlRequiredOnThisRequest from Control
protected $ptComposerControlCustomLabel from Control
protected $ptComposerControlDescription from Control
protected $btID
protected $ptComposerControlTypeHandle
protected $bt
protected $b
protected $controller

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

render($label, $customTemplate, $description)

No description

publishToPage(Page $c, $data, $controls)

No description

validate()

No description

addAssetsToRequest(Controller $cnt)

No description

export($node)

No description

onPageDraftCreate(Page $c)

No description

setPageTypeComposerControlName($ptComposerControlName)

No description

from Control
from Control
setPageTypeComposerControlCustomLabel($label)

No description

from Control
setPageTypeComposerControlDescription($description)

No description

from Control
setPageObject($page)

No description

from Control
getPageObject()

No description

from Control
setTargetParentPageID($ptTargetParentPageID)

No description

from Control
getTargetParentPageID()

No description

from Control
from Control
getPageTypeComposerControlDisplayName($format = 'html')

No description

from Control
setPageTypeComposerControlIconSRC($ptComposerControlIconSRC)

No description

from Control
setPageTypeComposerControlIconFormatter($ptComposerControlIconFormatter)

No description

from Control
from Control
setPageTypeComposerControlIdentifier($ptComposerControlIdentifier)

No description

from Control
field($key)

No description

from Control
getRequestValue($args = false)

No description

from Control
static 
getList(Type $pagetype)

No description

from Control
objectExists()

No description

from Control
setBlockTypeID($btID)

No description

getBlockTypeID()

No description

getBlockTypeObject()

No description

getController($obj)

No description

action($task)

No description

inc($file, $args = [])

No description

recordPageTypeComposerOutputBlock(Block $block)

No description

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

getPageTypeComposerControlCustomTemplates()

render($label, $customTemplate, $description)

Parameters

$label
$customTemplate
$description

publishToPage(Page $c, $data, $controls)

Parameters

Page $c
$data
$controls

validate()

getPageTypeComposerControlDraftValue()

addAssetsToRequest(Controller $cnt)

Parameters

Controller $cnt

export($node)

Parameters

$node

shouldPageTypeComposerControlStripEmptyValuesFromPage()

isPageTypeComposerControlValueEmpty()

removePageTypeComposerControlFromPage()

pageTypeComposerFormControlSupportsValidation()

onPageDraftCreate(Page $c)

Parameters

Page $c

setPageTypeComposerControlName($ptComposerControlName)

Parameters

$ptComposerControlName

setPageTypeComposerFormControlRequired($req)

Parameters

$req

setPageTypeComposerControlCustomLabel($label)

Parameters

$label

getPageTypeComposerControlCustomLabel()

setPageTypeComposerControlDescription($description)

Parameters

$description

getPageTypeComposerControlDescription()

setPageObject($page)

Parameters

$page

getPageObject()

setTargetParentPageID($ptTargetParentPageID)

Parameters

$ptTargetParentPageID

getTargetParentPageID()

isPageTypeComposerFormControlRequiredOnThisRequest()

getPageTypeComposerControlName()

getPageTypeComposerControlDisplayName($format = 'html')

Parameters

$format

setPageTypeComposerControlIconSRC($ptComposerControlIconSRC)

Parameters

$ptComposerControlIconSRC

setPageTypeComposerControlIconFormatter($ptComposerControlIconFormatter)

Parameters

$ptComposerControlIconFormatter

getPageTypeComposerControlIcon()

setPageTypeComposerControlIdentifier($ptComposerControlIdentifier)

Parameters

$ptComposerControlIdentifier

getPageTypeComposerControlIdentifier()

getPageTypeComposerControlTypeObject()

getPageTypeComposerControlTypeHandle()

setPageTypeComposerFormLayoutSetControlObject(FormLayoutSetControl $setcontrol)

Parameters

FormLayoutSetControl $setcontrol

getPageTypeComposerFormLayoutSetControlObject()

field($key)

Parameters

$key

getRequestValue($args = false)

Parameters

$args

FormLayoutSetControl addToPageTypeComposerFormLayoutSet(FormLayoutSet $set, $import = false)

Parameters

FormLayoutSet $set
$import

Return Value

FormLayoutSetControl

canPageTypeComposerControlSetPageName()

getPageTypeComposerControlPageNameValue(Page $dc)

Parameters

Page $dc

static getList(Type $pagetype)

Parameters

Type $pagetype

isPageTypeComposerControlRequiredByDefault()

objectExists()

setBlockTypeID($btID)

Parameters

$btID

getBlockTypeID()

getPageTypeComposerControlBlockObject(Page $c)

Parameters

Page $c

setPageTypeComposerControlBlockObject($b)

Parameters

$b

getBlockTypeObject()

protected getController($obj)

Parameters

$obj

action($task)

Parameters

$task

inc($file, $args = [])

Parameters

$file
$args

recordPageTypeComposerOutputBlock(Block $block)

Parameters

Block $block