PHP Class Xpressengine\Support\Sorter

Author: XE Developers ([email protected])

显示文件 Open project: xpressengine/xpressengine

Protected Properties

Property	Type	Description
$befores		다른 key에 의해 beforeKey로 지정된 key들의 배열이다. sort하는 과정에서 사용된다.
$relations		추가된 key의 before key를 저장하는 배열이다. 아래와 같은 형식으로 저장된다. [ '{key}' => ['beforeKey1','beforeKey2',...], ... ]
$resolved		sort가 실행됐을 경우, traversing 과정에서 거쳐간 key의 목록이다.
$tails		add 메소드를 통해 등록된 key의 목록이다. key로 등록될 경우 이 배열에 추가되며 targetKey로 등록된 key는 제외될 수 있다. sort하는 과정에서 사용된다.

Public Methods

Method	Description
add ( string \| string[] $keys, string $relation = null, string \| string[] $targetKeys = [] ) : void	key들 간의 우선순위를 주입하는 메소드이다.
sort ( null \| array $keyList = null ) : array	등록된 key들의 관계를 이용하여 key 목록을 정렬하여 반환한다.

Method Details

add() public method

주어진 key와 targetKey 사이에는 relation에 의해 주어진 관계를 갖는다는 것을 의미한다. 만약 A가 B보다 먼저 실행되어야 한다면 아래와 같이 이 메소드를 사용할 수 있다. $sorter-add('B',Sorter::BEFORE,'A'); or $sorter-add('A',Sorter::AFTER,'B');

public add ( string \| string[] $keys, string $relation = null, string \| string[] $targetKeys = [] ) : void
$keys	string \| string[]	관계를 정의할 key, 복수의 key를 입력할 경우 배열로 입력할 수 있다.
$relation	string	Sorter::BEFORE('<') \| Sorter::AFTER('>'). key와
$targetKeys	string \| string[]	key와 관계를 정의할 대상 key. 복수의 key를 입력할 경우 배열로 입력할 수 있다.
return	void

sort() public method

keyList가 주어질 경우, keyList에 지정된 key들만을 대상으로 정렬하여 반환한다.

public sort ( null \| array $keyList = null ) : array
$keyList	null \| array	정렬의 대상이 되는 key의 목록
return	array

Property Details

$befores protected_oe property

다른 key에 의해 beforeKey로 지정된 key들의 배열이다. sort하는 과정에서 사용된다.

protected $befores

$relations protected_oe property

추가된 key의 before key를 저장하는 배열이다. 아래와 같은 형식으로 저장된다. [ '{key}' => ['beforeKey1','beforeKey2',...], ... ]

protected $relations

$resolved protected_oe property

sort가 실행됐을 경우, traversing 과정에서 거쳐간 key의 목록이다.

protected $resolved

$tails protected_oe property

add 메소드를 통해 등록된 key의 목록이다. key로 등록될 경우 이 배열에 추가되며 targetKey로 등록된 key는 제외될 수 있다. sort하는 과정에서 사용된다.

protected $tails