Граф наследования:OrderApi:

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

API для работы с заказами

Открытые члены
	__construct ()

	getMeterApi ($user_id=null)

	getStatistic ()

	getOrderYears ($order_filter=self::ORDER_FILTER_ALL, $lastrange=5)

	ordersByYears ($order_filter=self::ORDER_FILTER_ALL, $show_type=self::ORDER_SHOW_TYPE_NUM, $lastrange=5, $cache=true)

	ordersByMonth ($order_filter=self::ORDER_FILTER_ALL, $show_type=self::ORDER_SHOW_TYPE_NUM, $lastrange=1, $cache=true)

	getStatusCounts ()

	generateOrderNum ($order)

	getUserOrdersCount ($user_id)

	getReport (OrmRequest $request)

	addOrderExtraDataByStep (Order $order, $step= 'order', $order_extra=[])

	searchCityByRegionOrCountry ($query, $region_id=null, $country_id=null)

	multiUpdate (array $data, $ids=[])

	search ($term, $fields, $limit)

	getSiteIdByOrderId ($order_id)

Открытые члены унаследованные от HasMeterInterface
	getMeterApi ()

Открытые статические члены
static	getUsersManagers ()

static	getUsersManagersName ($root=[])

static	getCreatorPlatformsListTitles ($first=[])

Поля данных
const	METER_ORDER = 'rs-admin-menu-allorders'

const	ORDER_FILTER_ALL = 'all'

const	ORDER_FILTER_SUCCESS = 'success'

const	ORDER_SHOW_TYPE_NUM = 'num'

const	ORDER_SHOW_TYPE_SUMM = 'summ'

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

__construct ( )

Методы

addOrderExtraDataByStep	(	Order	$order,
			$step = `'order'`,
			$order_extra = `[]`
	)

Добавляет массив дополнительных экстра данных в заказ, которые будут отображаться в заказе в админ панели

Аргументы

Order	$order	- объект заказа
string	$step	- идентификатор шага оформления (address, delivery, payment, confirm)
array	$order_extra	- массив доп. данных

Возвращает: void

generateOrderNum ( $order )

Генерирует уникальный идентификатор заказа

Аргументы

Order $order - объект заказа

Возвращает: string

static getCreatorPlatformsListTitles ( $first = [] )

static

Возвращает список возможных платформ для создания сайта

Аргументы

array $first

Возвращает: array

getMeterApi ( $user_id = null )

Возвращает класс, который отвечает за управление счетчиками просмотров

Аргументы

integer|null user_id ID пользователя. Если пользователь не задан, то используется текущий пользователь

Возвращает

getOrderYears	(	$order_filter = `self::ORDER_FILTER_ALL`,
		$lastrange = `5`
	)

Возвращает года, за которые есть статистика

Аргументы

string	$order_filter
int	$lastrange	максимальное количество годов в списке

Возвращает: array

getReport ( OrmRequest $request )

Создаёт отчёт о заказах за выбранный период и при заданных параметрах

Аргументы

OrmRequest $request - объект запроса списка заказов

Возвращает: array

getSiteIdByOrderId ( $order_id )

Возвращает id сайта, которому принадлежит заказ

Аргументы

int $order_id - id заказа

Возвращает: int

getStatistic ( )

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

Возвращает: array

getStatusCounts ( )

Возвращает количество заказов для каждого из существующих статусов

Возвращает: array

getUserOrdersCount ( $user_id )

Возвращает количество заказов, оформленных пользователем

Аргументы

integer $user_id - id пользователя

Возвращает: Order|false

static getUsersManagers ( )

static

Возвращает список пользователей-менеджеров заказов. Группа, пользователи которой считаются менеджерами устанавливается в настройках модуля Магазин

Возвращает: array

static getUsersManagersName ( $root = [] )

static

Возвращает список пользователей-менеджеров заказов. Группа, пользователи которой считаются менеджерами устанавливается в настройках модуля Магазин

Аргументы

string[] $root - список который будет добавлен в начало

Возвращает: string[]

multiUpdate	(	array	$data,
			$ids = `[]`
	)

Обновляет свойства у группы объектов

Аргументы

array	$data	- ассоциативный массив со значениями обновляемых полей
array	$ids	- список id объектов, которые нужно обновить

Возвращает: integer - возвращает количество обновленных элементов

ordersByMonth	(	$order_filter = `self::ORDER_FILTER_ALL`,
		$show_type = `self::ORDER_SHOW_TYPE_NUM`,
		$lastrange = `1`,
		$cache = `true`
	)

Возвращает даты заказов, сгруппированные по годам. Для видета статистики

Аргументы

mixed	$lastrange
string	$show_type
string	$order_filter	фильтр заказов. Если all - то все заказы, success - только завершенные
bool	$cache	- флаг кэширования, если true, то кэш будет использоваться

Возвращает: array

ordersByYears	(	$order_filter = `self::ORDER_FILTER_ALL`,
		$show_type = `self::ORDER_SHOW_TYPE_NUM`,
		$lastrange = `5`,
		$cache = `true`
	)

Возвращает даты заказов, сгруппированные по годам. Для видета статистики

Аргументы

string	$order_filter	фильтр заказов. Если all - то все заказы, success - только завершенные
string	$show_type
mixed	$lastrange
bool	$cache	- флаг кэширования, если true, то кэш будет использоваться

Возвращает: array

search	(	$term,
		$fields,
		$limit
	)

Ищет заказ по различным полям

Аргументы

string	$term	поисковая строка
array	$fields	массив с полями, в которых необходимо произвести поиск
integer	$limit	максимальное количество результирующих строк

Возвращает: array

searchCityByRegionOrCountry	(	$query,
		$region_id = `null`,
		$country_id = `null`
	)

Ищет город по части слова

Аргументы

string	$query	- часть слова города для его запроса
int	$region_id	- id региона
int	$country_id	- id страны

Возвращает: Region[]

Поля

const METER_ORDER = 'rs-admin-menu-allorders'

Идентификатор счетчика заказов

const ORDER_FILTER_ALL = 'all'

const ORDER_FILTER_SUCCESS = 'success'

const ORDER_SHOW_TYPE_NUM = 'num'

const ORDER_SHOW_TYPE_SUMM = 'summ'

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

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

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

Поля данных

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

Методы

Поля