ModuleTopic_EntityTopicPhoto
Package | modules.topic |
---|---|
Inheritance | class ModuleTopic_EntityTopicPhoto » Entity » LsObject |
Since | 1.0 |
Source Code | /classes/modules/topic/entity/TopicPhoto.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 |
getDescription() | Возвращает описание фото | ModuleTopic_EntityTopicPhoto |
getId() | Возвращает ID фото | ModuleTopic_EntityTopicPhoto |
getPath() | Вовзращает полный веб путь до фото | ModuleTopic_EntityTopicPhoto |
getTargetTmp() | Возвращает ключ временного владельца | ModuleTopic_EntityTopicPhoto |
getTopicId() | Возвращает ID топика | ModuleTopic_EntityTopicPhoto |
getWebPath() | Возвращает полный веб путь до фото определенного размера | ModuleTopic_EntityTopicPhoto |
setDescription() | Устанавливает описание фото | ModuleTopic_EntityTopicPhoto |
setTargetTmp() | Устанавливает ключ временного владельца | ModuleTopic_EntityTopicPhoto |
setTopicId() | Устанавливает ID топика | ModuleTopic_EntityTopicPhoto |
Method Details
getDescription()
method
public string|null getDescription()
| ||
{return} | string|null |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#54 (show)
public function getDescription() {
return $this->_getDataOne('description');
}
Возвращает описание фото
getId()
method
public int|null getId()
| ||
{return} | int|null |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#30 (show)
public function getId() {
return $this->_getDataOne('id');
}
Возвращает ID фото
getPath()
method
public mixed|null getPath()
| ||
{return} | mixed|null |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#62 (show)
public function getPath() {
return $this->_getDataOne('path');
}
Вовзращает полный веб путь до фото
getTargetTmp()
method
public string|null getTargetTmp()
| ||
{return} | string|null |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#46 (show)
public function getTargetTmp() {
return $this->_getDataOne('target_tmp');
}
Возвращает ключ временного владельца
getTopicId()
method
public int|null getTopicId()
| ||
{return} | int|null |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#38 (show)
public function getTopicId() {
return $this->_getDataOne('topic_id');
}
Возвращает ID топика
getWebPath()
method
public null|string getWebPath(string|null $sWidth=NULL)
| ||
$sWidth | string|null | Размер фото, например, '100' или '150crop' |
{return} | null|string |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#71 (show)
public function getWebPath($sWidth = null) {
if ($this->getPath()) {
if ($sWidth) {
$aPathInfo=pathinfo($this->getPath());
return $aPathInfo['dirname'].'/'.$aPathInfo['filename'].'_'.$sWidth.'.'.$aPathInfo['extension'];
} else {
return $this->getPath();
}
} else {
return null;
}
}
Возвращает полный веб путь до фото определенного размера
setDescription()
method
public void setDescription(string $sDescription)
| ||
$sDescription | string |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#105 (show)
public function setDescription($sDescription) {
$this->_aData['description'] = $sDescription;
}
Устанавливает описание фото
setTargetTmp()
method
public void setTargetTmp(string $sTargetTmp)
| ||
$sTargetTmp | string |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#97 (show)
public function setTargetTmp($sTargetTmp) {
$this->_aData['target_tmp'] = $sTargetTmp;
}
Устанавливает ключ временного владельца
setTopicId()
method
public void setTopicId(int $iTopicId)
| ||
$iTopicId | int |
Source Code: /classes/modules/topic/entity/TopicPhoto.entity.class.php#89 (show)
public function setTopicId($iTopicId) {
$this->_aData['topic_id'] = $iTopicId;
}
Устанавливает ID топика