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

Class: DataDescription

Source Location: /framework/DataDescription.class.php

Class Overview

Object
   |
   --DataDescription

Мета-данные.


Author(s):

  • dr.Pavka

Implements interfaces:

  • Iterator (internal interface)

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 23]
Мета-данные.



Tags:

author:   dr.Pavka


[ Top ]


Class Variables

$currentIndex =  0

[line 41]



Tags:

var:   индекс текущего элемента (используется для итерации)
access:   private

Type:   int


[ Top ]

$fieldDescriptions =

[line 29]



Tags:

var:   мета-данные полей
access:   private

Type:   array


[ Top ]

$length =

[line 35]



Tags:

var:   количество полей данных
access:   private

Type:   int


[ Top ]



Class Methods


constructor __construct [line 49]

void __construct( )

Конструктор класса.



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

[ Top ]

method addFieldDescription [line 96]

void addFieldDescription( FieldDescription $fieldDescription)

Добавляет описание поля данных.



Tags:

access:   public


Parameters:

FieldDescription   $fieldDescription  

[ Top ]

method current [line 212]

mixed current( )

Возвращает текущий элемент.



Tags:

access:   public



Implementation of:
Iterator::current
[ Top ]

method getFieldDescriptionByName [line 123]

FieldDescription getFieldDescriptionByName( string $name)

Возвращает описание поля данных по имени поля, или false, если такого поля не существует.



Tags:

access:   public


Parameters:

string   $name  

[ Top ]

method getFieldDescriptionList [line 147]

array getFieldDescriptionList( )

Возвращает список имён полей данных.



Tags:

access:   public


[ Top ]

method getFieldDescriptions [line 137]

array getFieldDescriptions( )

Возвращает описания полей данных.



Tags:

access:   public


[ Top ]

method getLength [line 157]

int getLength( )

Возвращает количество полей данных.



Tags:

access:   public


[ Top ]

method intersect [line 168]

DataDescription intersect( DataDescription $otherDataDescr)

Создаёт пересечение описания данных с другим описанием данных.



Tags:

access:   public


Parameters:

DataDescription   $otherDataDescr  

[ Top ]

method key [line 223]

mixed key( )

Возвращает ключ текущего элемента.



Tags:

access:   public



Implementation of:
Iterator::key
[ Top ]

method load [line 65]

void load( $columnsInfo)

Загружает описание данных полученных из БД.



Tags:

see:   DBA::getColumnsInfo()
access:   public


Parameters:

array   $columnsInfo  

[ Top ]

method loadXML [line 80]

void loadXML( $xmlDescr)

Загружает описание данных полученных из конфигурационного XML файла.



Tags:

access:   public


Parameters:

SimpleXMLElement   $xmlDescr  

[ Top ]

method next [line 234]

void next( )

Перемещает итератор на следующий элемент.



Tags:

access:   public



Implementation of:
Iterator::next
[ Top ]

method removeFieldDescription [line 108]

void removeFieldDescription( FieldDescription $fieldDescription)

Удаляет описание поля данных.



Tags:

access:   public


Parameters:

FieldDescription   $fieldDescription  

[ Top ]

method rewind [line 202]

void rewind( )

Перемещает итератор на первый элемент.



Tags:

access:   public



Implementation of:
Iterator::rewind
[ Top ]

method valid [line 244]

boolean valid( )

Проверяет, существует ли текущий элемент.



Tags:

access:   public



Implementation of:
Iterator::valid
[ Top ]

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