ModuleUser_EntityField
Package | modules.user |
---|---|
Inheritance | class ModuleUser_EntityField » Entity » LsObject |
Since | 1.0 |
Source Code | /classes/modules/user/entity/Field.entity.class.php |
Сущность пользовательского поля у пользователя
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
_aData | array | Данные сущности, на этот массив мапятся методы set* и get* | Entity |
aValidateErrors | array | Список ошибок валидации в разрезе полей, например | Entity |
aValidateRules | array | Список правил валидации полей | Entity |
sPrimaryKey | null|string | Имя поля с первичным ключом в БД | Entity |
sValidateScenario | string | Сценарий валиадции полей | Entity |
Public Methods
Method | Description | Defined By |
---|---|---|
Init() | Метод инициализации сущности, вызывается при её создании | Entity |
_Validate() | Выполняет валидацию данных сущности | Entity |
__call() | Ставим хук на вызов неизвестного метода и считаем что хотели вызвать метод какого либо модуля | Entity |
__construct() | Если передать в конструктор ассоциативный массив свойств и их значений, то они автоматом загрузятся в сущность | Entity |
_addValidateError() | Добавляет для поля ошибку в список ошибок | Entity |
_clearValidateErrors() | Очищает список всех ошибок или для конкретного поля | Entity |
_createValidators() | Создает и возвращает список валидаторов для сущности | Entity |
_getData() | Получает массив данных сущности | Entity |
_getDataArray() | Рекурсивное преобразование объекта и вложенных объектов в массив | Entity |
_getDataOne() | Возвращает данные по конкретному полю | Entity |
_getPrimaryKey() | Получение первичного ключа сущности (ключ, а не значение!) | Entity |
_getPrimaryKeyValue() | Возвращает значение первичного ключа/поля | Entity |
_getValidateError() | Возвращает первую ошибку для поля или среди всех полей | Entity |
_getValidateErrors() | Возвращает список ошибок для всех полей или одного поля | Entity |
_getValidateScenario() | Возвращает текущий сценарий валидации | Entity |
_getValidators() | Возвращает список валидаторов с учетом текущего сценария | Entity |
_hasValidateErrors() | Проверяет есть ли ошибки валидации | Entity |
_setData() | Устанавливает данные сущности | Entity |
_setValidateScenario() | Устанавливает сценарий валидации | Entity |
getId() | Возвращает ID поля | ModuleUser_EntityField |
getName() | Возвращает имя поля(уникальное) | ModuleUser_EntityField |
getPattern() | Возвращает паттерн подстановки поля | ModuleUser_EntityField |
getTitle() | Возвращает заголовок/описание поля | ModuleUser_EntityField |
getType() | Возвращает тип поля | ModuleUser_EntityField |
getValue() | Возвращает значение поля у пользователя | ModuleUser_EntityField |
setId() | Устанавливает ID поля | ModuleUser_EntityField |
setName() | Устанавливает имя поля(уникальное) | ModuleUser_EntityField |
setPattern() | Устанавливает паттерн подстановки поля | ModuleUser_EntityField |
setTitle() | Устанавливает заголовок/описание поля | ModuleUser_EntityField |
setType() | Устанавливает тип поля | ModuleUser_EntityField |
setValue() | Устанавливает значение поля у пользователя | ModuleUser_EntityField |
Method Details
getId()
method
public int|null getId()
| ||
{return} | int|null |
Source Code: /classes/modules/user/entity/Field.entity.class.php#30 (show)
public function getId() {
return $this->_getDataOne('id');
}
Возвращает ID поля
getName()
method
public string|null getName()
| ||
{return} | string|null |
Source Code: /classes/modules/user/entity/Field.entity.class.php#38 (show)
public function getName(){
return $this->_getDataOne('name');
}
Возвращает имя поля(уникальное)
getPattern()
method
public string|null getPattern()
| ||
{return} | string|null |
Source Code: /classes/modules/user/entity/Field.entity.class.php#62 (show)
public function getPattern(){
return $this->_getDataOne('pattern');
}
Возвращает паттерн подстановки поля
getTitle()
method
public string|null getTitle()
| ||
{return} | string|null |
Source Code: /classes/modules/user/entity/Field.entity.class.php#54 (show)
public function getTitle(){
return $this->_getDataOne('title');
}
Возвращает заголовок/описание поля
getType()
method
public string|null getType()
| ||
{return} | string|null |
Source Code: /classes/modules/user/entity/Field.entity.class.php#46 (show)
public function getType(){
return $this->_getDataOne('type');
}
Возвращает тип поля
getValue()
method
public string getValue(bool $bEscapeValue=false, bool $bTransformed=false)
| ||
$bEscapeValue | bool | Экранировать значение |
$bTransformed | bool | Применять паттерн или нет |
{return} | string |
Source Code: /classes/modules/user/entity/Field.entity.class.php#72 (show)
public function getValue($bEscapeValue = false, $bTransformed = false){
if (!isset($this->_aData['value']) || !$this->_aData['value']) return '';
if ($bEscapeValue) $this->_aData['value'] = htmlspecialchars($this->_aData['value']);
if ($bTransformed) {
if (!$this->_aData['pattern']) return $this->_aData['value'];
$sReturn=str_replace('{*}', $this->_aData['value'], $this->_aData['pattern']);
/**
* Грязный хак сайта в профиле (
* @todo Сделать валидацию полей в профиле
*/
if ($this->getName()=='www') {
$sReturn=str_replace(array('http://http://','http://https://'),array('http://','https://'),$sReturn);
}
return $sReturn;
} else {
return (isset($this->_aData['value'])) ? $this->_aData['value'] : '';
}
}
Возвращает значение поля у пользователя
setId()
method
public void setId(int $iId)
| ||
$iId | int |
Source Code: /classes/modules/user/entity/Field.entity.class.php#98 (show)
public function setId($iId) {
$this->_aData['id']=$iId;
}
Устанавливает ID поля
setName()
method
public void setName(string $sName)
| ||
$sName | string |
Source Code: /classes/modules/user/entity/Field.entity.class.php#106 (show)
public function setName($sName) {
$this->_aData['name']=$sName;
}
Устанавливает имя поля(уникальное)
setPattern()
method
public void setPattern(string $sPattern)
| ||
$sPattern | string |
Source Code: /classes/modules/user/entity/Field.entity.class.php#130 (show)
public function setPattern($sPattern) {
$this->_aData['pattern']=$sPattern;
}
Устанавливает паттерн подстановки поля
setTitle()
method
public void setTitle(string $sTitle)
| ||
$sTitle | string |
Source Code: /classes/modules/user/entity/Field.entity.class.php#122 (show)
public function setTitle($sTitle) {
$this->_aData['title']=$sTitle;
}
Устанавливает заголовок/описание поля
setType()
method
public void setType(string $sName)
| ||
$sName | string |
Source Code: /classes/modules/user/entity/Field.entity.class.php#114 (show)
public function setType($sName) {
$this->_aData['type']=$sName;
}
Устанавливает тип поля
setValue()
method
public void setValue(string $sValue)
| ||
$sValue | string |
Source Code: /classes/modules/user/entity/Field.entity.class.php#138 (show)
public function setValue($sValue) {
$this->_aData['value']=$sValue;
}
Устанавливает значение поля у пользователя