1. class
  2. Xpressengine
  3. Support
  4. Tree
  5. Node

Node

abstract class Node extends DynamicModel implements NodeInterface

Class Node

Traits

Xpressengine\Support\Tree\TreeMakerTrait
Trait TreeMakerTrait

Constants

CREATED_AT

column nam of created at
UPDATED_AT

column nam of updated at
DELETED_AT

column nam of deleted at

Properties

static protected Keygen $keyGenerator from DynamicModel
static protected ConnectionResolverInterface $resolver The connection resolver instance. from DynamicModel
static protected array $macros The registered macros. from DynamicModel
protected array $proxyOptions from DynamicModel
protected bool $dynamic from DynamicModel
protected array $dynamicAttributes dynamic mode 애서 사용될 attributes from DynamicModel
protected NodeInterface $parent
protected Collection $children children collection of model
Collection $ancestors Collection$ancestors
Collection $descendants Collection$descendants

Methods

array
filter(array $args, array $columns = array())

$args 로 넘어온 데이터와 $columns 를 비교해서 $args 값을 거른다.

from DynamicModel
array
schema()

get table schema

from DynamicModel
void
fill(array $attributes)

fill

from DynamicModel
Keygen
getKeyGen()

get key generator

from DynamicModel
static void
setKeyGen(Keygen $keyGenerator)

Set key generator

from DynamicModel
static Connection
resolveConnection(string|null $connection = null)

Resolve a connection instance.

from DynamicModel
static ConnectionResolverInterface
getConnectionResolver()

Get the connection resolver instance.

from DynamicModel
static void
setConnectionResolver(ConnectionResolverInterface $resolver)

Set the connection resolver instance.

from DynamicModel
static void
unsetConnectionResolver()

Unset the connection resolver for models.

from DynamicModel
$this
setDynamic(bool $use)

dynamic query 사용하도록 설정

from DynamicModel
$this
setProxyOptions(array $options)

proxy option 설정

from DynamicModel
array
getProxyOptions()

get proxy option

from DynamicModel
array
getDynamicAttributes()

get dynamic attributes

from DynamicModel
Builder|DynamicModel
newEloquentBuilder(DynamicQuery $query)

Create a new Eloquent query builder for the model.

from DynamicModel
DynamicQuery
newBaseQueryBuilder()

Illuminate Model 의 newBaseQueryBuilder 변경 VirtualConnection 을 통해 DynamicQuery 를 사용하도록 처리

from DynamicModel
bool
performInsert(Builder $query, array $options = array())

No description

from DynamicModel
bool
save(array $options = array())

Save the model to the database.

from DynamicModel
static void
macro(string $name, callable $macro)

Register a custom macro.

from DynamicModel
static bool
hasMacro(string $name)

Checks if macro is registered.

from DynamicModel
mixed
callMacro(string $name, array $parameters = array())

call macro

from DynamicModel
mixed
getMacroValue(string $name)

get macro value

from DynamicModel
mixed
__call(string $method, array $parameters)

Handle dynamic method calls into the model.

from DynamicModel
mixed
__get(string $key)

Dynamically retrieve attributes on the model.

from DynamicModel
Tree
makeTree(array $nodes = array())

Make Tree instance

from TreeMakerTrait
BelongsTo
aggregator()

Aggregator relationship

BelongsToMany
ancestors(bool $without = true)

Ancestors relationship

BelongsToMany
descendants(bool $without = true)

Descendants relationship

string|int
getNodeIdentifier()

Get the unique identifier for the node

string
getNodeIdentifierName()

Get the unique identifier name for the node

string|int
getParentNodeIdentifier()

Get the parent identifier for the node

Node|Node
getParent()

Return the parent node or null

void
setParent(NodeInterface $node)

Set parent node

Collection
getChildren()

Return the child node items or empty array

void
setChildren(NodeInterface[] $children = array())

Set child nodes

void
addChild(NodeInterface $node)

Add child node

bool
hasChild()

Check having child and return the boolean result.

Collection
children()

Returns children collection

Tree
getDescendantTree(bool $withSelf = false)

Get a descendant tree collection of model

int
getDescendantCount()

Returns a number of descendants

int
getDepth()

Get the depth value of model

Collection
getBreadcrumbs()

get breadcrumbs

Builder
scopeRoots(Builder $query)

Scope for get node items of root

Builder
scopeProgenitors(Builder $query, Aggregator $aggregator)

Scope for get node items of progenitor

string
getClosureTable()

Get the pivot table for model's hierarchy

string
getAncestorName()

Get the ancestor key name of pivot table

string
getDescendantName()

Get the descendant key name of pivot table

string
getDepthName()

Get the depth key name of pivot table

string
getParentIdName()

Get the parent key name for model

string
getAggregatorModel()

Get the aggregator model name for model

string
getAggregatorKeyName()

Get the aggregator key name for model

Details

in DynamicModel at line 103
array filter(array $args, array $columns = array())

$args 로 넘어온 데이터와 $columns 를 비교해서 $args 값을 거른다.

처리중인 $columns 와 같은 이름을 데이터만 리턴됨 이 처리는 dynamic 을 통해 proxy 를 처리 할 경우에 대해서 동작됨

Parameters

array $args insert, update data
array $columns table columns

Return Value

array

in DynamicModel at line 124
private array schema()

get table schema

Return Value

array

in DynamicModel at line 135
void fill(array $attributes)

fill

Parameters

array $attributes attributes

Return Value

void

in DynamicModel at line 150
Keygen getKeyGen()

get key generator

Return Value

Keygen

in DynamicModel at line 164
static void setKeyGen(Keygen $keyGenerator)

Set key generator

Parameters

Keygen $keyGenerator key generator

Return Value

void

in DynamicModel at line 175
static Connection resolveConnection(string|null $connection = null)

Resolve a connection instance.

Parameters

string|null $connection connection name

Return Value

Connection

in DynamicModel at line 185
static ConnectionResolverInterface getConnectionResolver()

Get the connection resolver instance.

Return Value

ConnectionResolverInterface

in DynamicModel at line 196
static void setConnectionResolver(ConnectionResolverInterface $resolver)

Set the connection resolver instance.

Parameters

ConnectionResolverInterface $resolver resolver

Return Value

void

in DynamicModel at line 206
static void unsetConnectionResolver()

Unset the connection resolver for models.

Return Value

void

in DynamicModel at line 217
$this setDynamic(bool $use)

dynamic query 사용하도록 설정

Parameters

bool $use use dynamic query

Return Value

$this

in DynamicModel at line 228
$this setProxyOptions(array $options)

proxy option 설정

Parameters

array $options proxy options

Return Value

$this

in DynamicModel at line 239
array getProxyOptions()

get proxy option

Return Value

array

in DynamicModel at line 249
array getDynamicAttributes()

get dynamic attributes

Return Value

array

in DynamicModel at line 261
Builder|DynamicModel newEloquentBuilder(DynamicQuery $query)

Create a new Eloquent query builder for the model.

Xpressengine\Database\Eloquent\Builder 울 사용하도록 변경

Parameters

DynamicQuery $query dynamic query builder

Return Value

Builder|DynamicModel

in DynamicModel at line 272
protected DynamicQuery newBaseQueryBuilder()

Illuminate Model 의 newBaseQueryBuilder 변경 VirtualConnection 을 통해 DynamicQuery 를 사용하도록 처리

Return Value

DynamicQuery

in DynamicModel at line 291
protected bool performInsert(Builder $query, array $options = array())

Parameters

Builder $query Illuminate database eloquent buildere
array $options options

Return Value

bool

in DynamicModel at line 305
bool save(array $options = array())

Save the model to the database.

Parameters

array $options options

Return Value

bool

in DynamicModel at line 321
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name macro name
callable $macro callable

Return Value

void

in DynamicModel at line 332
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name macro name

Return Value

bool

in DynamicModel at line 343
mixed callMacro(string $name, array $parameters = array())

call macro

Parameters

string $name macro name
array $parameters parameters

Return Value

mixed

in DynamicModel at line 359
mixed getMacroValue(string $name)

get macro value

Parameters

string $name macro name

Return Value

mixed

in DynamicModel at line 376
mixed __call(string $method, array $parameters)

Handle dynamic method calls into the model.

Parameters

string $method method
array $parameters parameters

Return Value

mixed

in DynamicModel at line 391
mixed __get(string $key)

Dynamically retrieve attributes on the model.

Parameters

string $key key

Return Value

mixed

in TreeMakerTrait at line 31
protected Tree makeTree(array $nodes = array())

Make Tree instance

Parameters

array $nodes node items

Return Value

Tree

at line 56
BelongsTo aggregator()

Aggregator relationship

Return Value

BelongsTo

at line 67
BelongsToMany ancestors(bool $without = true)

Ancestors relationship

Parameters

bool $without without self node when value is true

Return Value

BelongsToMany

at line 90
BelongsToMany descendants(bool $without = true)

Descendants relationship

Parameters

bool $without without self node when value is true

Return Value

BelongsToMany

at line 111
string|int getNodeIdentifier()

Get the unique identifier for the node

Return Value

string|int

at line 121
string getNodeIdentifierName()

Get the unique identifier name for the node

Return Value

string

at line 131
string|int getParentNodeIdentifier()

Get the parent identifier for the node

Return Value

string|int

at line 141
Node|Node getParent()

Return the parent node or null

Return Value

Node|Node

at line 158
void setParent(NodeInterface $node)

Set parent node

Parameters

NodeInterface $node parent node

Return Value

void

at line 168
Collection getChildren()

Return the child node items or empty array

Return Value

Collection

at line 183
void setChildren(NodeInterface[] $children = array())

Set child nodes

Parameters

NodeInterface[] $children children node interfaces

Return Value

void

at line 194
void addChild(NodeInterface $node)

Add child node

Parameters

NodeInterface $node child node

Return Value

void

at line 204
bool hasChild()

Check having child and return the boolean result.

Return Value

bool

at line 214
protected Collection children()

Returns children collection

Return Value

Collection

at line 229
Tree getDescendantTree(bool $withSelf = false)

Get a descendant tree collection of model

Parameters

bool $withSelf flag for descendant tree with self

Return Value

Tree

at line 244
int getDescendantCount()

Returns a number of descendants

Return Value

int

at line 261
int getDepth()

Get the depth value of model

Return Value

int

at line 271
Collection getBreadcrumbs()

get breadcrumbs

Return Value

Collection

at line 295
Builder scopeRoots(Builder $query)

Scope for get node items of root

Parameters

Builder $query query builder

Return Value

Builder

at line 307
Builder scopeProgenitors(Builder $query, Aggregator $aggregator)

Scope for get node items of progenitor

Parameters

Builder $query query builder
Aggregator $aggregator category instance

Return Value

Builder

at line 317
abstract string getClosureTable()

Get the pivot table for model's hierarchy

Return Value

string

at line 324
abstract string getAncestorName()

Get the ancestor key name of pivot table

Return Value

string

at line 331
abstract string getDescendantName()

Get the descendant key name of pivot table

Return Value

string

at line 338
abstract string getDepthName()

Get the depth key name of pivot table

Return Value

string

at line 345
abstract string getParentIdName()

Get the parent key name for model

Return Value

string

at line 352
abstract string getAggregatorModel()

Get the aggregator model name for model

Return Value

string

at line 359
abstract string getAggregatorKeyName()

Get the aggregator key name for model

Return Value

string