Версия: 6.x
burger close
Класс Api
Граф наследования:Api:
EntityList HasMeterInterface BaseModel

Открытые члены

 __construct ()
 
 getMarkMatrix ($aid, $comment_type_id, $max_mark=5)
 
 getMeterApi ($user_id=null)
 
 replaceByIp ($bool)
 
 addComment ($aid, $type)
 
 markHelpful ($comment_id, $help)
 
 recountItemRatingByComment (\RS\Orm\OrmObject $object,\Comments\Model\Orm\Comment $comment)
 
 joinVoteInfo ()
 
 setCommentTypeFilter (Abstracttype $type_object)
 
 alreadyWrite ($aid, $ip=null)
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=[])
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=[])
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ()
 
 getOneItem ($id)
 
 getById ($id, $request=null)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=[])
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=[])
 
 multieditFormView ($tpl_path, $formfile, array $addparam=[])
 
 multiUpdate (array $data, $ids=[])
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 
- Открытые члены унаследованные от HasMeterInterface
 getMeterApi ()
 

Открытые статические члены

static getTypeList ()
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

Поля данных

const METER_COMMENT = 'rs-admin-menu-comments'
 
const COMMENT_TYPE_FOLDER = '/model/commenttype'
 
 $replace_by_ip = false
 
- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

Защищенные данные

 $config
 
- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = []
 
 $parsePrefixes = ['&' => 'AND'
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

Дополнительные унаследованные члены

- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

Конструктор(ы)

__construct ( )

Методы

addComment (   $aid,
  $type 
)

Сохраняет POST с комментарием от текущего пользователя

Аргументы
integer$aid- ID объекта, к которому привязывается комментарий
string$type- Класс комментария
Возвращает
bool
alreadyWrite (   $aid,
  $ip = null 
)

Возвращает true, если комментарий с $ip уже присутствует для данного объекта

Аргументы
integer$aidID объекта, к которому привязан комментарий
string | null$ipIP-адрес. Если не задан, то берется текущий
Возвращает
bool
getMarkMatrix (   $aid,
  $comment_type_id,
  $max_mark = 5 
)

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

Аргументы
string$aidID объекта связанного с комментарием
string$comment_type_id
Возвращает
array
getMeterApi (   $user_id = null)

Возвращает API по работе со счетчиками

Возвращает
static getTypeList ( )
static

Возвращает Все существующие типы комментариев

Возвращает
array|null
Исключения
\RS\Exceptionвызывается, если присутствует неверный тип комментария
joinVoteInfo ( )

Устанавливаем условие, чтобы загружалась информация о голосованиях.

markHelpful (   $comment_id,
  $help 
)

Добавляет или убавляет рейтинг комментарию

Аргументы
integer$comment_id
mixed$help- yes или no
recountItemRatingByComment ( \RS\Orm\OrmObject  $object,
\Comments\Model\Orm\Comment  $comment 
)

Подсчитывает рейтинг элемента или товара на основе количества комментариев Подсчёт на основе комментария

Аргументы
\RS\Orm\OrmObject$object- объект элемента к которому делали комментарий
\Comments\Model\Orm\Comment$comment- объект комментария
replaceByIp (   $bool)

Устанавливает, нужно ли заменять комментарии, если они оставлены с одного IP

Аргументы
bool$bool- Если true, то заменять
Возвращает
void
setCommentTypeFilter ( Abstracttype  $type_object)

Устанавливает фильтр по типу комментария

Аргументы
Abstracttype$type_object
Возвращает
Api

Поля

$config
protected
$replace_by_ip = false
const COMMENT_TYPE_FOLDER = '/model/commenttype'
const METER_COMMENT = 'rs-admin-menu-comments'