PHP Класс Node

S -> P P -> T R I I -> P I -> e R -> '[]' N O R -> N O O -> '{' P '}' O -> e N -> 'token=name' T -> 'token=type'

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$actsAs	array	Behaviors used by the Model
$belongsTo	array	Model associations: belongsTo
$filterArgs	array	Filter search fields
$findMethods
$guid	string	Guid
$name	string	Model name
$type	string	If the Model is associated to Node model, this variable holds the Node type value
$validate	array	Validation

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

Метод	Описание
beforeFind ( $queryData ) : array	beforeFind callback
beforeSave ( $options = [] ) : boolean	beforeSave callback
filterNodes ( $data = [] ) : array	Return filter condition for Nodes
filterPublishedNodes ( $data = [] ) : array	Return filter condition for Nodes
formatData ( array $data, string $typeAlias = self::DEFAULT_TYPE ) : array	Format data for saving
isUniquePerType ( array $fields, boolean $or = true ) : boolean	Returns false if any fields passed match any (by default, all if $or = false) of their matching values.
saveNode ( $data, $typeAlias = self::DEFAULT_TYPE ) : mixed	Create/update a Node record
updateAllNodesPaths ( ) : boolean \| array	Update values for all nodes 'path' field

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

Метод	Описание
_findPromoted ( $state, $query, $results = [] )	Find promoted nodes
_findPublished ( $state, $query, $results = [] )	Search published nodes
_findViewById ( $state, $query, $results = [] )	Find a single node by id
_findViewBySlug ( $state, $query, $results = [] )	Find a single node by slug
_getNodeRelativePath ( array $node ) : string	getNodeRelativePath
_getType ( array $data ) : string	_getType
_mergeQueryFilters ( &$query, $key, $values ) : void	mergeQueryFilters

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

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

Find promoted nodes

См. также: Model::find()

См. также: Model::_findAll()

protected _findPromoted ( $state, $query, $results = [] )

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

$query options: - q: term to search - roleId: Role Id - typeAlias: Type alias

protected _findPublished ( $state, $query, $results = [] )

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

Find a single node by id

protected _findViewById ( $state, $query, $results = [] )

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

Find a single node by slug

protected _findViewBySlug ( $state, $query, $results = [] )

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

getNodeRelativePath

protected _getNodeRelativePath ( array $node ) : string
$node	array	Node array
Результат	string	relative node path

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

_getType

protected _getType ( array $data ) : string
$data	array	Node data
Результат	string	type

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

mergeQueryFilters

См. также: Node::_findPromoted()

protected _mergeQueryFilters ( &$query, $key, $values ) : void
Результат	void

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

beforeFind callback

public beforeFind ( $queryData ) : array
Результат	array

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

beforeSave callback

public beforeSave ( $options = [] ) : boolean
Результат	boolean

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

Return filter condition for Nodes

public filterNodes ( $data = [] ) : array
Результат	array	Array of conditions

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

Return filter condition for Nodes

public filterPublishedNodes ( $data = [] ) : array
Результат	array	Array of conditions

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

Format data for saving

public formatData ( array $data, string $typeAlias = self::DEFAULT_TYPE ) : array
$data	array	Node and related data, eg Taxonomy and Role
$typeAlias	string	string Node type alias
Результат	array	formatted data

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

Returns false if any fields passed match any (by default, all if $or = false) of their matching values.

public isUniquePerType ( array $fields, boolean $or = true ) : boolean
$fields	array	Field/value pairs to search (if no values specified, they are pulled from $this->data)
$or	boolean	If false, all fields specified must match in order for a false return value
Результат	boolean	False if any records matching any fields are found

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

Create/update a Node record

public saveNode ( $data, $typeAlias = self::DEFAULT_TYPE ) : mixed
$data		array Node data
$typeAlias		string Node type alias
Результат	mixed	see Model::saveAll()

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

Update values for all nodes 'path' field

См. также: Model::saveMany()

public updateAllNodesPaths ( ) : boolean \| array
Результат	boolean \| array	Depending on atomicity

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

$actsAs публичное свойство

Behaviors used by the Model

public array $actsAs
Результат	array

$belongsTo публичное свойство

Model associations: belongsTo

public array $belongsTo
Результат	array

$filterArgs публичное свойство

Filter search fields

public array $filterArgs
Результат	array

$findMethods публичное свойство

public $findMethods

$guid публичное свойство

Guid

public string $guid
Результат	string

$name публичное свойство

Model name

public string $name
Результат	string

$type публичное свойство

If the Model is associated to Node model, this variable holds the Node type value

public string $type
Результат	string

$validate публичное свойство

Validation

public array $validate
Результат	array