Версия: 6.x
burger close
Открытые члены | Открытые статические члены | Поля данных | Защищенные данные | Статические защищенные данные
Класс AffiliateApi
Граф наследования:AffiliateApi:
TreeCookieList TreeList EntityList BaseModel

Подробное описание

Класс для организации выборок ORM объекта. В этом классе рекомендуется также реализовывать любые дополнительные методы, связанные с заявленной в конструкторе моделью

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

 __construct ()
 
 sortAffiliatesAlphabetically ()
 
 setSubTools (TableType\Actions $tools)
 
- Открытые члены унаследованные от TreeCookieList
 __construct (AbstractObject $orm_element, array $options=[])
 
 getOpenedElements ()
 
 getClosedElement ()
 
- Открытые члены унаследованные от TreeList
 setDeleteChild ($bool)
 
 isDeleteChild ()
 
 setParentField ($field)
 
 getParentField ()
 
 getPathToFirst ($id, $cache=true)
 
 getParentIds ($ids, $cache=true)
 
 getByAlias ($alias, $parent=null)
 
 getTreeList ($parent_id=0, array $first_elements=[])
 
 getSelectList ($parent_id=0, array $first=[])
 
 del (array $ids)
 
 queryParents ($id)
 
 queryGetChilds ($parent_id, $order=null)
 
 moveElement ($from, $to, $flag, OrmRequest $extra_expr=null, $new_parent_id=null)
 
 multiEditCheck ($element, $post, $ids)
 
 addFilterControl (FilterControl $filter_control)
 
 isEnableTreePreload ()
 
 setEnableTreePreload ($enable_tree_preload)
 
- Открытые члены унаследованные от 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)
 
 __set ($name, $value)
 
 __get ($name)
 
 __isset ($name)
 
 __unset ($name)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

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

static staticSelectList ($parent_id=0, $first=[])
 
static staticRootList ()
 
static getAffiliateIdByDomains ($cache=true)
 
static getCurrentAffiliate ()
 
static setCurrentAffiliate (Orm\Affiliate $affiliate, $write_to_cookie=false)
 
static needRecheck ()
 
static getAffiliateByIp ($ip)
 
static getNearAffiliate ($lat, $lng)
 
- Открытые статические члены унаследованные от TreeList
static staticTreeList ($parent_id=0, $first_elements=[])
 
static staticSelectList ($parent_id=0, $first=[])
 
static FindSubFolder (array $list)
 
static getChildsId ($ids)
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

Поля данных

const SESSION_GEOIP_AFFILIATE_ID = 'affiliate_geoip'
 
const COOKIE_AFFILIATE_ID = 'affiliate'
 
const COOKIE_ALREADY_SELECT = 'affiliate_already_select'
 
- Поля данных унаследованные от TreeCookieList
 $uniq
 
- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

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

 $need_recheck = false
 
 $sub_tools
 
- Защищенные данные унаследованные от TreeCookieList
 $opened_elements = null
 
- Защищенные данные унаследованные от TreeList
 $parent_field
 
 $enable_tree_preload = true
 
 $delete_child = true
 
- Защищенные данные унаследованные от 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'
 
 $cache_alias = []
 
 $options = []
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

Статические защищенные данные

static $current_affiliate
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

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

- Защищенные члены унаследованные от TreeList
 getAllParentIdsArray ($cache=true)
 
 getFakeNodesFromStringArray ($items)
 
 recursiveConvertTreeToSelectList (array $tree, $parent_id, $level=0)
 
- Защищенные члены унаследованные от 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)
 
- Защищенные статические члены унаследованные от TreeList
static recursiveGetChildIdsFromTree (array $tree, $id)
 

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

__construct ( )

Методы

static getAffiliateByIp (   $ip)
static

Возвращает город по IP адресу

Аргументы
string$ip- IP адрес
Возвращает
| false
static getAffiliateIdByDomains (   $cache = true)
static

Возвращает ассотиативный массив, где в ключах доменное имя, в а значении ID филиала

Аргументы
bool$cache
Возвращает
array|mixed
static getCurrentAffiliate ( )
static

Возвращает объект текущего филиала

Возвращает
Affiliate
static getNearAffiliate (   $lat,
  $lng 
)
static

Возвращает ближайший для указанных коорднат Филиал

Аргументы
float$lat- широта
float$lng- долгота
Возвращает
| false
static needRecheck ( )
static

Возвращает true, если необходимо подтвердить у пользователя его город

Возвращает
bool
static setCurrentAffiliate ( Orm\Affiliate  $affiliate,
  $write_to_cookie = false 
)
static

Устанавливает текущий филиал

Аргументы
Orm\Affiliate$affiliate- филиал
boolean$write_to_cookie- записывать в куки? true - да
Возвращает
void
setSubTools ( TableType\Actions  $tools)

Устанавливает состав инструментов для отображения в админ. панели для не корневых филиалов

Аргументы
\RS\Html\Table\Type\Actions$tools
Возвращает
void
sortAffiliatesAlphabetically ( )

сортирует филиалы по алфавиту

Возвращает
void
Исключения
DbException
static staticRootList ( )
static

Возвращает список элементов первого уровня + корневой элемент

Возвращает
array
static staticSelectList (   $parent_id = 0,
  $first = [] 
)
static

Аналог getSelectList, только для статичского вызова

Аргументы
int$parent_id= id корневого элемента дерева
array$first= значения, которые нужно добавить в начало списка
Возвращает
array

Поля

$current_affiliate
staticprotected
$need_recheck = false
protected
$sub_tools
protected
const COOKIE_AFFILIATE_ID = 'affiliate'
const COOKIE_ALREADY_SELECT = 'affiliate_already_select'
const SESSION_GEOIP_AFFILIATE_ID = 'affiliate_geoip'