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

Class: FieldDescription

Source Location: /framework/FieldDescription.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --FieldDescription

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


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: DBWorker

DBWorker::__construct()
Конструктор класса.
DBWorker::dateToString()
Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate()
Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString()
Возвращает дату в виде строки прописью
DBWorker::_translate()
Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

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

$additionalProperties =

[line 215]

Хэш вида array(propertyName => propertyValue).



Tags:

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

Type:   Object


[ Top ]

$availableValues =

[line 163]



Tags:

var:   набор возможных значений (для полей типа select)
access:   private

Type:   array


[ Top ]

$isMultilanguage =

[line 207]



Tags:

var:   данные в поле мультиязычные?
access:   private

Type:   boolean


[ Top ]

$length =  true

[line 223]

Для полей не имеющих длины устанавливается в true.



Tags:

var:   длина поля
access:   private

Type:   int


[ Top ]

$mode =  self::FIELD_MODE_EDIT

[line 195]



Tags:

var:   режим отображения поля
access:   private

Type:   int


[ Top ]

$name =

[line 169]



Tags:

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

Type:   string


[ Top ]

$rights =

[line 201]



Tags:

var:   уровень прав на данное поле
access:   private

Type:   int


[ Top ]

$systemName =

[line 177]

Для полей из БД, включает имя таблицы: tableName[name]



Tags:

var:   системное имя поля
access:   private

Type:   string


[ Top ]

$systemType =

[line 189]



Tags:

var:   тип поля в БД
access:   private

Type:   string


[ Top ]

$type =

[line 183]



Tags:

var:   визуальный тип поля
access:   private

Type:   string


[ Top ]



Class Methods


static method computeRights [line 825]

static int computeRights( $methodRights, [ $RORights = null], [ $FCRights = null])

Определяет значение режима отображения элемента



Tags:

access:   public


Parameters:

   $methodRights  
   $RORights  
   $FCRights  

[ Top ]

static method intersect [line 722]

static FieldDescription intersect( FieldDescription $configFieldDescription, FieldDescription $dbFieldDescription)

Пересечение мета-данных конфигурации и мета-данных, полученных из БД.



Tags:

access:   public


Parameters:

FieldDescription   $configFieldDescription   основное описание
FieldDescription   $dbFieldDescription   дополнительное описание

[ Top ]

constructor __construct [line 232]

void __construct( [string $name = self::EMPTY_FIELD_NAME])

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



Tags:

access:   public


Overrides DBWorker::__construct() (Конструктор класса.)

Parameters:

string   $name   имя поля

[ Top ]

method convertType [line 646]

string convertType( string $systemType)

Конвертирует тип поля из системного типа в визуальный.



Tags:

access:   protected


Parameters:

string   $systemType  

[ Top ]

method getAvailableValues [line 813]

array getAvailableValues( )

Возвращает набор возможных значений поля.



Tags:

access:   public


[ Top ]

method getLength [line 336]

int getLength( )

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



Tags:

return:   | true
access:   public


[ Top ]

method getMode [line 563]

int getMode( )

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



Tags:

access:   public


[ Top ]

method getName [line 315]

string getName( )

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



Tags:

access:   public


[ Top ]

method getPropertyNames [line 620]

array getPropertyNames( )

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



Tags:

access:   public


[ Top ]

method getPropertyValue [line 631]

mixed getPropertyValue( string $name)

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



Tags:

access:   public


Parameters:

string   $name  

[ Top ]

method getRights [line 584]

int getRights( )

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



Tags:

access:   public


[ Top ]

method getSystemName [line 357]

string getSystemName( )

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



Tags:

access:   public


[ Top ]

method getSystemType [line 542]

string getSystemType( )

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



Tags:

access:   public


[ Top ]

method getType [line 519]

string getType( )

Возвращает визуальный тип поля.



Tags:

access:   public


[ Top ]

method isMultilanguage [line 774]

boolean isMultilanguage( )

Возвращает флаг мультиязычности данных.



Tags:

access:   public


[ Top ]

method loadArray [line 254]

boolean loadArray( $fieldInfo)

Загружает описание поля из массива.



Tags:

access:   public


Parameters:

array   $fieldInfo  

[ Top ]

method loadAvailableValues [line 788]

void loadAvailableValues( mixed $values, string $keyName, string $valueName)

Загружает набор возможных значений поля.



Tags:

see:   QAL::select()
access:   public


Parameters:

mixed   $values   набор значений
string   $keyName   имя поля-ключа
string   $valueName   имя поля основного значения

[ Top ]

method loadXML [line 281]

boolean loadXML( $fieldInfo)

Загружает описание поля из XML-описания.



Tags:

access:   public


Parameters:

SimpleXMLElement   $fieldInfo  

[ Top ]

method removeProperty [line 610]

void removeProperty( string $name)

Удаляет свойство поля.



Tags:

access:   public


Parameters:

string   $name  

[ Top ]

method setLength [line 347]

void setLength( int $length)

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



Tags:

access:   public


Parameters:

int   $length  

[ Top ]

method setMode [line 553]

void setMode( int $mode)

Устанавливает режим отображения поля.



Tags:

access:   public


Parameters:

int   $mode  

[ Top ]

method setProperty [line 596]

void setProperty( string $name, mixed $value)

Добавляет свойство поля.



Tags:

access:   public


Parameters:

string   $name  
mixed   $value  

[ Top ]

method setRights [line 574]

void setRights( int $rights)

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



Tags:

access:   public


Parameters:

int   $rights  

[ Top ]

method setSystemName [line 326]

void setSystemName( string $systemName)

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



Tags:

access:   public


Parameters:

string   $systemName  

[ Top ]

method setSystemType [line 531]

void setSystemType( string $systemType)

Устанавливает системный тип поля, одновременно устанавливая на основании его визуальный тип.



Tags:

access:   public


Parameters:

string   $systemType  

[ Top ]

method setType [line 368]

void setType( string $type)

Устанавливает визуальный тип поля.



Tags:

access:   public


Parameters:

string   $type  

[ Top ]

method validate [line 758]

boolean validate( mixed $data)

Проверяет корректность переданных данных.



Tags:

access:   public


Parameters:

mixed   $data  

[ Top ]


Class Constants

EMPTY_FIELD_NAME =  'DUMMY'

[line 27]

Имя поля для которого не указано имя :)


[ Top ]

FIELD_MODE_EDIT =  2

[line 152]

Режим редактирования


[ Top ]

FIELD_MODE_FC =  3

[line 157]

Полный контроль


[ Top ]

FIELD_MODE_NONE =  0

[line 142]

Поле не отображается


[ Top ]

FIELD_MODE_READ =  1

[line 147]

Только для чтения


[ Top ]

FIELD_TYPE_BOOL =  'boolean'

[line 91]

Булево значение


[ Top ]

FIELD_TYPE_CUSTOM =  'custom'

[line 127]

Пользовательский тип поля (может содержать любые данные)


[ Top ]

FIELD_TYPE_DATE =  'date'

[line 116]

Дата


[ Top ]

FIELD_TYPE_DATETIME =  'datetime'

[line 111]

Дата и время


[ Top ]

FIELD_TYPE_EMAIL =  'email'

[line 51]

E-mail


[ Top ]

FIELD_TYPE_FILE =  'file'

[line 76]

Файл


[ Top ]

FIELD_TYPE_FLOAT =  'float'

[line 66]

Число с плавающей точкой


[ Top ]

FIELD_TYPE_HIDDEN =  'hidden'

[line 121]

Скрытое поле


[ Top ]

FIELD_TYPE_HTML_BLOCK =  'htmlblock'

[line 96]

HTML блок


[ Top ]

FIELD_TYPE_IMAGE =  'image'

[line 71]

Изображение


[ Top ]

FIELD_TYPE_INT =  'integer'

[line 61]

Целое число


[ Top ]

FIELD_TYPE_MULTI =  'multi'

[line 106]

Множественный выбор из нескольких вариантов


[ Top ]

FIELD_TYPE_PFILE =  'pfile'

[line 81]

Приватный файл


[ Top ]

FIELD_TYPE_PHONE =  'phone'

[line 56]

Телефонный номер


[ Top ]

FIELD_TYPE_PRFILE =  'prfile'

[line 86]

Защищенный файл


[ Top ]

FIELD_TYPE_PWD =  'password'

[line 46]

Пароль


[ Top ]

FIELD_TYPE_SELECT =  'select'

[line 101]

Единичный выбор из нескольких вариантов


[ Top ]

FIELD_TYPE_STRING =  'string'

[line 36]

Строка


[ Top ]

FIELD_TYPE_TEXT =  'text'

[line 41]

Текст


[ Top ]

FIELD_TYPE_VIDEO =  'video'

[line 133]

Поле содержит видео данные

в формате flv если установлен ffmpeg - конвертируется из одного из поддерживаемых форматов



[ Top ]


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