PHP Класс Webiny\Component\Entity\Attribute\Many2OneAttribute

Наследование: extends Webiny\Component\Entity\Attribute\AttributeAbstract, use trait Webiny\Component\StdLib\StdLibTrait
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$entityClass
$onDelete
$onSetNullCallback null | Closure
$updateExisting

Открытые методы

Метод Описание
__toString ( ) : mixed | null | string Get masked entity value when instance is being converted to string
_get ( $name ) : AbstractAttribute This method allows us to use simplified access to attributes (no autocomplete).
getAttribute ( $name ) : AbstractAttribute This method allows us to chain getAttribute calls on related entities.
getDbValue ( ) : string Get value that will be stored to database
getEntity ( ) : string Get entity class for this attribute
getOnDelete ( ) : string Get action to perform when parent entity is being deleted.
getUpdateExisting ( ) : boolean Is update of existing entity allowed?
getValue ( array $params = [], boolean $processCallbacks = true ) : boolean | null | AbstractEntity Get attribute value
onSetNull ( $callable )
setEntity ( string $entityClass ) Set entity class for this attribute
setOnDelete ( string $action = 'cascade' ) Set action to perform when parent entity is being deleted.
setUpdateExisting ( boolean | true $flag = true ) Allow update of existing entity
setValue ( null $value = null, boolean $fromDb = false ) Set attribute value

Защищенные методы

Метод Описание
validate ( &$value ) Perform validation against given value

Приватные методы

Метод Описание
loadEntity ( $id )

Описание методов

__toString() публичный Метод

Get masked entity value when instance is being converted to string
public __toString ( ) : mixed | null | string
Результат mixed | null | string

_get() публичный Метод

Ex: $person->company->name // Will output company name
public _get ( $name ) : AbstractAttribute
$name
Результат AbstractAttribute

getAttribute() публичный Метод

Ex: $person->getAttribute('company')->getAttribute('name')->getValue(); // This will output company name
public getAttribute ( $name ) : AbstractAttribute
$name
Результат AbstractAttribute

getDbValue() публичный Метод

Get value that will be stored to database
public getDbValue ( ) : string
Результат string

getEntity() публичный Метод

Get entity class for this attribute
public getEntity ( ) : string
Результат string

getOnDelete() публичный Метод

Get action to perform when parent entity is being deleted.
public getOnDelete ( ) : string
Результат string

getUpdateExisting() публичный Метод

Is update of existing entity allowed?
public getUpdateExisting ( ) : boolean
Результат boolean

getValue() публичный Метод

Get attribute value
public getValue ( array $params = [], boolean $processCallbacks = true ) : boolean | null | AbstractEntity
$params array
$processCallbacks boolean Process `onGet` callbacks
Результат boolean | null | Webiny\Component\Entity\AbstractEntity

onSetNull() публичный Метод

public onSetNull ( $callable )

setEntity() публичный Метод

Set entity class for this attribute
public setEntity ( string $entityClass )
$entityClass string

setOnDelete() публичный Метод

Set action to perform when parent entity is being deleted.
public setOnDelete ( string $action = 'cascade' )
$action string cascade|ignore Default value is 'ignore'

setUpdateExisting() публичный Метод

By default, only new Many2One records are created but updates are not allowed.
public setUpdateExisting ( boolean | true $flag = true )
$flag boolean | true

setValue() публичный Метод

Set attribute value
public setValue ( null $value = null, boolean $fromDb = false )
$value null
$fromDb boolean

validate() защищенный Метод

Perform validation against given value
protected validate ( &$value )
$value

Описание свойств

$entityClass защищенное свойство

protected $entityClass

$onDelete защищенное свойство

protected $onDelete

$onSetNullCallback защищенное свойство

protected null|Closure $onSetNullCallback
Результат null | Closure

$updateExisting защищенное свойство

protected $updateExisting