ModuleUser_EntityFriend
Package | modules.user |
---|---|
Inheritance | class ModuleUser_EntityFriend » Entity » LsObject |
Since | 1.0 |
Source Code | /classes/modules/user/entity/Friend.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 |
getFriendId() | При переданном параметре $sUserId возвращает тот идентификатор, | ModuleUser_EntityFriend |
getFriendStatus() | Возвращает статус дружбы | ModuleUser_EntityFriend |
getStatusByUserId() | Возвращает статус дружбы для конкретного пользователя | ModuleUser_EntityFriend |
getStatusFrom() | Возвращает статус заявки на добавления в друзья у отправителя | ModuleUser_EntityFriend |
getStatusTo() | Возвращает статус заявки на добавления в друзья у получателя | ModuleUser_EntityFriend |
getUserFrom() | Возвращает ID пользователя, который приглашает в друзья | ModuleUser_EntityFriend |
getUserId() | Получает идентификатор пользователя, | ModuleUser_EntityFriend |
getUserTo() | Возвращает ID пользователя, которого пришлашаем в друзья | ModuleUser_EntityFriend |
setStatusByUserId() | Возвращает статус дружбы для конкретного пользователя | ModuleUser_EntityFriend |
setStatusFrom() | Устанавливает статус заявки на добавления в друзья у отправителя | ModuleUser_EntityFriend |
setStatusTo() | Возвращает статус заявки на добавления в друзья у получателя | ModuleUser_EntityFriend |
setUserFrom() | Устанавливает ID пользователя, который приглашает в друзья | ModuleUser_EntityFriend |
setUserId() | Устанавливает ID пользователя | ModuleUser_EntityFriend |
setUserTo() | Устанавливает ID пользователя, которого пришлашаем в друзья | ModuleUser_EntityFriend |
Method Details
public string getFriendId(string|null $sUserId=NULL)
| ||
$sUserId | string|null | ID пользователя |
{return} | string |
public function getFriendId($sUserId=null) {
if(!$sUserId) {
$sUserId=$this->getUserId();
}
if($this->_getDataOne('user_from')==$sUserId) {
return $this->_aData['user_to'];
}
if($this->_getDataOne('user_to')==$sUserId) {
return $this->_aData['user_from'];
}
return false;
}
При переданном параметре $sUserId возвращает тот идентификатор, который не равен переданному
public int|null getFriendStatus()
| ||
{return} | int|null |
public function getFriendStatus() {
return $this->getStatusFrom()+$this->getStatusTo();
}
Возвращает статус дружбы
public bool|int getStatusByUserId(int $sUserId)
| ||
$sUserId | int | ID пользователя |
{return} | bool|int |
public function getStatusByUserId($sUserId) {
if($sUserId==$this->getUserFrom()) {
return $this->getStatusFrom();
}
if($sUserId==$this->getUserTo()) {
return $this->getStatusTo();
}
return false;
}
Возвращает статус дружбы для конкретного пользователя
public int|null getStatusFrom()
| ||
{return} | int|null |
public function getStatusFrom() {
return $this->_getDataOne('status_from');
}
Возвращает статус заявки на добавления в друзья у отправителя
public int|null getStatusTo()
| ||
{return} | int|null |
public function getStatusTo() {
return $this->_getDataOne('status_to') ? $this->_getDataOne('status_to') : ModuleUser::USER_FRIEND_NULL;
}
Возвращает статус заявки на добавления в друзья у получателя
public int|null getUserFrom()
| ||
{return} | int|null |
public function getUserFrom() {
return $this->_getDataOne('user_from');
}
Возвращает ID пользователя, который приглашает в друзья
public int getUserId()
| ||
{return} | int |
public function getUserId() {
return $this->_getDataOne('user');
}
Получает идентификатор пользователя, относительно которого был сделан запрос
public int|null getUserTo()
| ||
{return} | int|null |
public function getUserTo() {
return $this->_getDataOne('user_to');
}
Возвращает ID пользователя, которого пришлашаем в друзья
public bool setStatusByUserId(int $data, int $sUserId)
| ||
$data | int | Статус |
$sUserId | int | ID пользователя |
{return} | bool |
public function setStatusByUserId($data,$sUserId) {
if($sUserId==$this->getUserFrom()) {
$this->setStatusFrom($data);
return true;
}
if($sUserId==$this->getUserTo()) {
$this->setStatusTo($data);
return true;
}
return false;
}
Возвращает статус дружбы для конкретного пользователя
public void setStatusFrom(int $data)
| ||
$data | int |
public function setStatusFrom($data) {
$this->_aData['status_from']=$data;
}
Устанавливает статус заявки на добавления в друзья у отправителя
public void setStatusTo(int $data)
| ||
$data | int |
public function setStatusTo($data) {
$this->_aData['status_to']=$data;
}
Возвращает статус заявки на добавления в друзья у получателя
public void setUserFrom(int $data)
| ||
$data | int |
public function setUserFrom($data) {
$this->_aData['user_from']=$data;
}
Устанавливает ID пользователя, который приглашает в друзья
public void setUserId(int $data)
| ||
$data | int |
public function setUserId($data) {
$this->_aData['user']=$data;
}
Устанавливает ID пользователя
public void setUserTo(int $data)
| ||
$data | int |
public function setUserTo($data) {
$this->_aData['user_to']=$data;
}
Устанавливает ID пользователя, которого пришлашаем в друзья