energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: TreeConverter

Source Location: /framework/TreeConverter.class.php

Class Overview



Конвертер для превращения древовидного массива в объект Tree По сути представляет из себя контейнер статических методов


Author(s):

  • dr.Pavka

Variables

Methods



Class Details

[line 24]
Конвертер для превращения древовидного массива в объект Tree По сути представляет из себя контейнер статических методов



Tags:

author:   dr.Pavka
final:  


[ Top ]


Class Variables

static $keyName =

[line 32]

Имя поля - ключа



Tags:

access:   private

Type:   string


[ Top ]

static $parentKeyName =

[line 40]

Имя поля - родительского ключа



Tags:

access:   private

Type:   string


[ Top ]

static $treeNodeList =

[line 49]

Список узлов



Tags:

access:   private

Type:   TreeNodeList


[ Top ]



Class Methods


static method convert [line 65]

static TreeNodeList convert( $data, string $keyName, string $parentKeyName)

Превращает переданный массив в дерево



Tags:

access:   public


Parameters:

array   $data   Загружаемые данные
string   $keyName   название поля содержащего идентификатор
string   $parentKeyName   название поля содержащего идентификатор родителя

[ Top ]

static method iterate [line 108]

static TreeNodeList iterate( $data, mixed $parent)

Рекурсивный метод итерации по исходному древовидному массиву



Tags:

access:   private


Parameters:

array   $data   массив данных в формате array(array('$keyName'=>$key, '$parentKeyName'=>$parentKey))
mixed   $parent   родительский объект (может быть TreeNode или TreeNodeList)

[ Top ]

static method validate [line 86]

static bool validate( $data)

Проверяет входные данные на валидность



Tags:

todo:   реализовать
access:   private


Parameters:

array   $data  

[ Top ]

constructor __construct [line 52]

TreeConverter __construct( )



Tags:

access:   private


[ Top ]

В создании документации нам помог: phpDocumentor