PHP Class Craft\Neo_BlockModel

Inheritance: extends craft\BaseElementModel
Afficher le fichier Open project: benjamminf/craft-neo

Méthodes publiques

Свойство Type Description
$modified boolean Used to indicate whether this block needs to be saved to the database.

Protected Properties

Свойство Type Description
$elementType Protected properties

Méthodes publiques

Méthode Description
getAncestors ( integer | null $dist = null ) : craft\ElementCriteriaModel Returns the block's ancestors.
getChildren ( null $field = null ) : craft\ElementCriteriaModel Returns the block's children.
getDescendants ( integer | null $dist = null ) : craft\ElementCriteriaModel Returns the block's descendants.
getField ( ) : craft\FieldModel | null Returns the field the block is associated with.
getFieldLayout ( ) : craft\FieldLayoutModel | null Returns the field layout the block is associated with.
getLocales ( ) : array Returns the locale ID's the block is available in.
getNextSibling ( ) : Neo_BlockModel | null Returns the block's next sibling.
getOwner ( ) : craft\BaseElementModel | null Returns the element that this block belongs as a field value to.
getParent ( ) : Neo_BlockModel | null Returns the block's parent.
getPrevSibling ( ) : Neo_BlockModel | null Returns the block's previous sibling.
getSiblings ( ) : craft\ElementCriteriaModel Returns the block's siblings.
getType ( ) : Neo_BlockTypeModel | null Returns the block's type.
setAllElements ( array $elements ) Allows memoizing all blocks (including this one) for a particular field.
setOwner ( craft\BaseElementModel $owner ) Allow the owner to be manually memoized, so that getOwner doesn't have to perform a DB query to find the owner.

Méthodes protégées

Méthode Description
defineAttributes ( ) Protected methods

Method Details

defineAttributes() protected méthode

Protected methods
protected defineAttributes ( )

getAncestors() public méthode

Returns the block's ancestors.
public getAncestors ( integer | null $dist = null ) : craft\ElementCriteriaModel
$dist integer | null
Résultat craft\ElementCriteriaModel

getChildren() public méthode

Returns the block's children.
public getChildren ( null $field = null ) : craft\ElementCriteriaModel
$field null - This is a deprecated parameter
Résultat craft\ElementCriteriaModel

getDescendants() public méthode

Returns the block's descendants.
public getDescendants ( integer | null $dist = null ) : craft\ElementCriteriaModel
$dist integer | null
Résultat craft\ElementCriteriaModel

getField() public méthode

Returns the field the block is associated with.
public getField ( ) : craft\FieldModel | null
Résultat craft\FieldModel | null

getFieldLayout() public méthode

Returns the field layout the block is associated with.
public getFieldLayout ( ) : craft\FieldLayoutModel | null
Résultat craft\FieldLayoutModel | null

getLocales() public méthode

Returns the locale ID's the block is available in.
public getLocales ( ) : array
Résultat array

getNextSibling() public méthode

Returns the block's next sibling.
public getNextSibling ( ) : Neo_BlockModel | null
Résultat Neo_BlockModel | null

getOwner() public méthode

Returns the element that this block belongs as a field value to.
public getOwner ( ) : craft\BaseElementModel | null
Résultat craft\BaseElementModel | null

getParent() public méthode

Returns the block's parent.
public getParent ( ) : Neo_BlockModel | null
Résultat Neo_BlockModel | null

getPrevSibling() public méthode

Returns the block's previous sibling.
public getPrevSibling ( ) : Neo_BlockModel | null
Résultat Neo_BlockModel | null

getSiblings() public méthode

Returns the block's siblings.
public getSiblings ( ) : craft\ElementCriteriaModel
Résultat craft\ElementCriteriaModel

getType() public méthode

Returns the block's type.
public getType ( ) : Neo_BlockTypeModel | null
Résultat Neo_BlockTypeModel | null

setAllElements() public méthode

This is used for Live Preview mode, where certain methods, like getAncestors, create element criteria models which need a local set of blocks to query against.
public setAllElements ( array $elements )
$elements array

setOwner() public méthode

This is useful for Live Preview mode, where blocks might belong to a new owner, which won't have an ID yet.
public setOwner ( craft\BaseElementModel $owner )
$owner craft\BaseElementModel

Property Details

$elementType protected_oe property

Protected properties
protected $elementType

$modified public_oe property

Used to indicate whether this block needs to be saved to the database.
public bool $modified
Résultat boolean