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

Class: Field

Source Location: /framework/Field.class.php

Class Overview

Object
   |
   --Field

Поле данных.


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 22]
Поле данных.



Tags:

author:   dr.Pavka


[ Top ]


Class Variables

$currentIndex =  0

[line 54]



Tags:

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

Type:   int


[ Top ]

$data = array()

[line 40]



Tags:

var:   данные поля
access:   private

Type:   array


[ Top ]

$name =

[line 34]



Tags:

var:   имя поля
access:   private

Type:   string


[ Top ]

$properties = array()

[line 28]



Tags:

var:   набор дополнительных свойств
access:   private

Type:   array


[ Top ]

$rights =

[line 48]

Если права не указаны - используются права из FieldDescription (наследуются).



Tags:

var:   права пользователя на поле
access:   private

Type:   int


[ Top ]



Class Methods


constructor __construct [line 63]

Field __construct( string $name)

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



Tags:

access:   public


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

Parameters:

string   $name   иям поля

[ Top ]

method addRowData [line 147]

void addRowData( mixed $data)

Добавляет строку данных.



Tags:

access:   public


Parameters:

mixed   $data  

[ Top ]

method current [line 259]

mixed current( )

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



Tags:

access:   public



Implementation of:
Iterator::current
[ Top ]

method getData [line 105]

array getData( )

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



Tags:

access:   public


[ Top ]

method getName [line 75]

string getName( )

Возвращает имя поля.



Tags:

access:   public


[ Top ]

method getRights [line 185]

int getRights( )

Возвращает уровень прав на поле.



Tags:

access:   public


[ Top ]

method getRowCount [line 195]

int getRowCount( )

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



Tags:

access:   public


[ Top ]

method getRowData [line 116]

mixed getRowData( int $rowIndex)

Возвращает данные указанной строки.



Tags:

access:   public


Parameters:

int   $rowIndex   индекс строки

[ Top ]

method getRowProperties [line 235]

array getRowProperties( int $index)

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



Tags:

access:   public


Parameters:

int   $index   индекс строки

[ Top ]

method getRowProperty [line 220]

mixed getRowProperty( int $index, string $propertyName)

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



Tags:

access:   public


Parameters:

int   $index   индекс строки
string   $propertyName   имя свойства

[ Top ]

method key [line 269]

mixed key( )

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



Tags:

access:   public



Implementation of:
Iterator::key
[ Top ]

method next [line 279]

void next( )

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



Tags:

access:   public



Implementation of:
Iterator::next
[ Top ]

method removeRowData [line 131]

mixed removeRowData( int $rowIndex)

Удаляет данные указанной строки.



Tags:

access:   public


Parameters:

int   $rowIndex   индекс строки

[ Top ]

method rewind [line 249]

void rewind( )

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



Tags:

access:   public



Implementation of:
Iterator::rewind
[ Top ]

method setData [line 89]

void setData( mixed $data, [bool $setForAll = false])

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



Tags:

access:   public


Parameters:

mixed   $data  
bool   $setForAll   - установить для всех строчек только для перепределения данных в случае если поле только создано то нужно заполнять через итератор

[ Top ]

method setRights [line 175]

void setRights( int $rights)

Устанавливает уровень прав на поле.



Tags:

access:   public


Parameters:

int   $rights   уровень прав

[ Top ]

method setRowData [line 159]

boolean setRowData( int $rowIndex, mixed $newData)

Устанавливает данные в указанной строке.



Tags:

access:   public


Parameters:

int   $rowIndex   индекс строки
mixed   $newData   новые данные

[ Top ]

method setRowProperty [line 208]

void setRowProperty( int $index, string $propertyName, mixed $propertyValue)

Устанавливает дополнтельное свойство строки.



Tags:

access:   public


Parameters:

int   $index   индекс строки
string   $propertyName   имя свойства
mixed   $propertyValue   значение свойства

[ Top ]

method valid [line 289]

boolean valid( )

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



Tags:

access:   public



Implementation of:
Iterator::valid
[ Top ]

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