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

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

	beforeWrite ($flag)

	getStockWarehouse ()

	getStockAffiliateWarehouse ()

	delete ()

	afterObjectLoad ()

	canUserNotify ()

	linkSessionCart (Cart $cart)

	setCurrency (Currency $currency)

	getBaseCurrency ()

	checkProductsNum ()

	getFromSession ()

	removeConditionCheckers ()

	useFields ($post)

	getFieldsManager ()

	setUseAddr (?int $address_id)

	getAddress ($cache=true)

	setAddress (Address $address)

	clearAddressCache ()

	getWeight ($weight_unit=null, $cache=true)

	getDelivery ($cache=true)

	clearDeliveryCache ()

	getPayment ($cache=true)

	clearPaymentCache ()

	getSavedPaymentMethod ()

	getWarehouse ()

	getDeliveryCostText (Delivery $delivery)

	getDeliveryExtraText (Delivery $delivery)

	applyMyCurrency ($price)

	getMyCurrency ()

	getUser ()

	getCart ()

	canEdit ()

	getStatus ()

	getTotalPrice ($format=true, $use_currency=false)

	getAllowCurrencies ()

	getExtraInfo ()

	addExtraInfoLine ($title, $value, $data=null, $key=null, $type=self::EXTRAINFOLINE_TYPE_DEFAULT)

	getExtraInfoLine ($key=null)

	removeExtraInfoLine ($key=null, $type=null)

	addExtraKeyPair ($key, $value)

	getExtraKeyPair ($key=null)

	removeExtraKeyPair ($key)

	getPrintForms ()

	getShopCompany ()

	canOnlinePay ()

	checkoutCanOnlinePay ()

	getStartStatus ()

	canChangePayment ()

	getOnlinePayUrl ($absolute=false, $extra_params=[])

	getFiles ($access=['visible', 'afterpay'], $include_product_files=true)

	getDeliveryCost ()

	setAddressFromSelectedAddress ()

	getSelectedPvz ()

	getTrackUrl ()

	getCourierUser ()

	getManagerUser ()

	getLinkedDocuments ()

	getInventoryApi ()

	getDefaultPaymentMethod ()

	isRefreshMode ()

	setRefreshMode (bool $refresh_mode)

	getSpecialParam (string $key, $default=null)

	setSpecialParam (string $key, $value)

	resetOrderForCheckout ()

	clearErrors ()

	dbUpdate ()

	canDelete ()

	getCargos ($cache=true)

	getProductsInCargoStatus ()

	isAllProductsInCargo ()

	getAffectingCostValues ()

	getOrderCostId ()

	getExcludeKeysByRights (array $rights)

	getBeforeObject ()

Открытые члены унаследованные от OrmObject
	__construct ($id=null, $cache=true)

	getPrimaryKeyProperty ()

	saveInCache ($id)

	loadFromCache ($id)

Открытые члены унаследованные от AbstractObject
static	__construct ()

	__destruct ()

	fillDefaults ()

	getClassParameter ($key=null)

	setClassParameter ($key, $value=null)

	issetClassParameter ($key=null)

	setLocalParameter ($key, $value=null)

	getLocalParameter ($key, $default=null)

	getParameter ($key, $default=null)

	setPropertyIterator (PropertyIterator $iterator)

	checkRights ($bool)

	clear ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	__set ($offset, $value)

	__get ($offset)

	offsetUnset ($offset)

	getShortAlias ()

	load ($primaryKeyValue=null)

	insert ($ignore=false, $on_duplicate_update_keys=[], $on_duplicate_uniq_fields=[])

	update ($primaryKey=null)

	replace ()

	delete ()

	exists ($primaryKeyValue)

	getFromArray (array $data, $remove_prefix=null, $mark_modify=true, $call_afterload_event=false)

	getValues ()

	isModified ($property)

	getPropertyIterator ()

	appendProperty (array $properties)

	_getTableArray ()

	getPrimaryKeyProperty ()

	getProperties ()

	getProp ($offset)

	save ($primaryKeyValue=null, $user_post=[], $post_var=null, $files_var=null)

	replaceOn ($bool)

	setWriteBit ($n)

	usePostKeys (array $keys)

	excludePostKeys (array $keys)

	checkData ($user_post=[], $post_var=null, $files_var=null, $usekeys=null, $exclude=null, $flag=self::UPDATE_FLAG)

	fillFromPost ($user_post=[], $post_var=null, $files_var=null, $usekeys=null, $exclude=null)

	validateData ($flag=self::UPDATE_FLAG)

	validate ()

	setCheckFields (array $fields)

	escapeFields (array $escape_fields)

	escapeAll ($bool)

	checkField ($property)

	addError ($string, $form=null)

	addErrors ($array, $form=null)

	getLastError ()

	getErrors ()

	getErrorsStr ()

	hasError ()

	getFormError ()

	getErrorsByForm ($key=null, $sep=null)

	getDisplayErrors ()

	noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)

	getNonFormErrors ()

	clearErrors ()

	setTemporaryId ()

	setFormTemplate ($template)

	dbUpdate ()

	addIndex ($fields, $type=self::INDEX_KEY, $name=null, $using=null)

	getIndexes ()

	getForm (array $tpl_vars=null, $switch=null, $is_multiedit=false, $template=null, $tpl_maker=null, $tpl_folder=null)

	getPropertyView ($key, $attributes=[], $view_params=[])

	getHiddenKeyVal ()

	addHiddenFields ($keys, $value=null)

	addDebugActions (array $actions, $local=false)

	addDebugAction (\RS\Debug\Action\AbstractAction $action, $local=false)

	getDebugAttributes ()

	beforeWrite ($save_flag)

	afterWrite ($save_flag)

	afterObjectLoad ()

	getDebugActions ()

	dropTable ()

	exportErrors ()

	current ()

	key ()

	next ()

	rewind ()

	valid ()

	__sleep ()

	__wakeup ()

	__clone ()

	__isset ($offset)

	getRightRead ()

	getRightCreate ()

	getRightUpdate ()

	getRightDelete ()

	getHtmlEncodedFields ()

Открытые члены унаследованные от AcceptBehavior
	attachInstanceBehavior (BehaviorAbstract $behavior_class)

	detachInstanceBehavior (BehaviorAbstract $behavior_class=null)

	getAttachedBehaviors ()

	behaviorMethodExists ($method_name)

	__call ($method_name, $arguments)

Открытые члены унаследованные от AcceptBehaviorInterface
	attachInstanceBehavior (\RS\Behavior\BehaviorAbstract $behavior_class)

	detachInstanceBehavior (\RS\Behavior\BehaviorAbstract $behavior_class=null)

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

static	regionList ()

Открытые статические члены унаследованные от OrmObject
static	loadSingle ($id)

Открытые статические члены унаследованные от AbstractObject
static	loadByWhere ($expr, array $values=null, $prefix= 'AND', $in_prefix= 'AND')

static	_getTable ()

static	chkDepend ($coreobj, $value, $real_errtext, $real_chk, array $conditions, $real_params=[])

static	destroyClass ()

Открытые статические члены унаследованные от AcceptBehavior
static	attachClassBehavior (BehaviorAbstract $behavior_class)

static	detachClassBehavior (BehaviorAbstract $behavior_class=null)

Открытые статические члены унаследованные от AcceptBehaviorInterface
static	attachClassBehavior (\RS\Behavior\BehaviorAbstract $behavior_class)

static	detachClassBehavior (\RS\Behavior\BehaviorAbstract $behavior_class=null)

Поля данных
const	USER_TYPE_NOREGISTER = 'noregister'

const	USER_TYPE_USER = 'user'

const	USER_TYPE_COMPANY = 'company'

const	USER_TYPE_PERSON = 'person'

const	EXTRAINFOLINE_TYPE_DEFAULT = 'default'

const	EXTRAINFOLINE_TYPE_DELIVERY = 'delivery'

const	EXTRAKEYPAIR_DELIVERY_EXTRA = 'delivery_extra'

const	DOCUMENT_TYPE_ORDER = 'order'

const	ORDER_SESS_VAR = 'ORDER-ORMOBJECT'

const	SPECIAL_CHECKOUT_FORBID_VALIDATE = 'checkout_forbid_validate'

const	SPECIAL_DISABLE_CHECK_QUANTITY = 'checkout_disable_check_quantity'

const	SPECIAL_DISABLE_UPDATE_PRODUCTS_STOCK = 'disable_update_products_stock'

const	PRODUCT_IN_CARGO_STATUS_NONE = 'none'

const	PRODUCT_IN_CARGO_STATUS_PARTIALLY = 'partially'

const	PRODUCT_IN_CARGO_STATUS_FULLY = 'fully'

const	CREATOR_PLATFORM_SITE = 'site'

const	CREATOR_PLATFORM_API = 'api'

	$address

	$order_cart

	$session_cart

	$this_before_write

Поля данных унаследованные от AbstractObject
const	INSERT_FLAG = 'insert'

const	UPDATE_FLAG = 'update'

const	REPLACE_FLAG = 'replace'

const	INDEX_PRIMARY = 'primary key'

const	INDEX_UNIQUE = 'unique'

const	INDEX_KEY = 'index'

const	INDEX_FULLTEXT = 'fulltext'

Поля данных унаследованные от AcceptBehavior
	$class_behaviors = []

	$cache_behavior_instances = []

	$instance_behaviors = []

Защищенные данные
	$use_generated_order_num = null

	$products_hash = null

	$cache_weigth = []

	$cache_delivery

	$cache_payment

	$refresh_mode = false

	$my_currency

	$cargos

Защищенные данные унаследованные от AbstractObject
	$_values = []

	$_self_class

	$_local_id

Статические защищенные данные
static	$table = 'order'

Статические защищенные данные унаследованные от OrmObject
static	$self_singleton_cache = []

Статические защищенные данные унаследованные от AbstractObject
static	$db = DB_NAME

static	$table = null

static	$iterator = 0

static	$init_default_method = '_initDefaults'

static	$local = []

static	$default_local_parameters

static static	$class = []

static	$default_class_parameters

Дополнительные унаследованные члены
Статические открытые данные унаследованные от OrmObject
static	$self_cache = []

Защищенные члены унаследованные от OrmObject
	_init ()

Защищенные члены унаследованные от AbstractObject
	initProperties ()

	_init ()

	_initDefaults ()

	afterInit ()

	getStorageInstance ()

	getTableEngine ()

	getPropertyHash ($is_multiedit, $switch=null)

Защищенные статические члены унаследованные от OrmObject
static	getIdHash ($id)

Защищенные статические члены унаследованные от AbstractObject
static	_tableName ($with_quotes=true)

static	_dbName ($with_quotes=true)

Методы

addExtraInfoLine	(	$title,
		$value,
		$data = `null`,
		$key = `null`,
		$type = `self::EXTRAINFOLINE_TYPE_DEFAULT`
	)

Добавляет дополнительную информацию к заказу

Аргументы

string	$title	- Название информации
mixed	$value	- Значение
mixed	$data	- доп. сведения (если есть)
mixed	$key	- уникальный идентификатор информации
mixed	$type	- тип инфостроки

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

addExtraKeyPair	(	$key,
		$value
	)

Добавляет в скрытую(которая не будет выводится) секцию с данными ваши данные по ключу

Аргументы

string	$key	- ключ
mixed	$value	- значение для сохранения

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

afterObjectLoad ( )

Функция срабатывает после загрузки объекта

applyMyCurrency ( $price )

Применяет валюту заказа к заданной цене

Аргументы

float $price

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

beforeWrite ( $flag )

Функция срабатывает перед записью заказа

Аргументы

string $flag - insert или update

Возвращает: null|bool

Исключения

RSException

canChangePayment ( )

Проверяет можно ли сменить оплату в заказе

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

canDelete ( )

Возвращает true, если клиент может самостоятельно удалить свой заказ Он это может сделать, если заказ находится в статусе Новый или Ожидает оплату или в дублерах данных статусов.

заказ не должен быть оплачен

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

canEdit ( )

Возможно ли редактирование заказа. Возвращает false если были удалены налоги либо скидки, идентфикаторы которых присутсвуют в этом заказе

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

canOnlinePay ( )

Возвращает true если для этого заказа возможна online-оплата

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

canUserNotify ( )

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

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

Исключения

RSException

checkoutCanOnlinePay ( )

Возвращает true если после сохранения этого заказа для него будет возможна online-оплата

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

checkProductsNum ( )

Проверяет наличие всех товаров в корзине

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

Исключения

RSException

clearAddressCache ( )

Очищает кэшированный адрес

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

clearDeliveryCache ( )

Сбрасывает кэш доставки, при следующем вызове getDelivery будет создан новый объект доставки

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

clearErrors ( )

Очищает все ошибки в объекте

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

clearPaymentCache ( )

Сбрасывает кэш оплаты, при следующем вызове getPayment будет создан новый объект оплаты

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

static currentOrder ( )

static

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

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

dbUpdate ( )

Приводит базу данных в соответствие со структурой объекта

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

delete ( )

Удаляет объект из хранилища

Возвращает: boolean - true, в случае успеха

getAddress ( $cache = true )

Возвращает объект адреса доставки

Аргументы

bool $cache - использовать кэш

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

getAffectingCostValues ( )

Возвращает массив значений текущего заказа, влияющих на стоимость данного заказа Из этих значений можно высчитывать хэш заказа, имеющего уникальную стоимость.

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

getAllowCurrencies ( )

Возвращает список из базовой валюты и валюты в которой оформлен заказ

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

getBaseCurrency ( )

Возвращает объект базовой валюты

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

getBeforeObject ( )

Возвращает текущий объект до внесения изменений

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

getCargos ( $cache = true )

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

Аргументы

bool $cache

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

getCart ( )

Возвращает объект с позициями оформленного заказа

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

getCourierUser ( )

Возвращает курьера, назначенного на данный заказ

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

getDefaultPaymentMethod ( )

Возвращает признак способа расчета по умолчанию для данного заказа

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

getDelivery ( $cache = true )

Возвращает объект способа доставки

Аргументы

bool $cache

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

getDeliveryCost ( )

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

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

getDeliveryCostText ( Delivery $delivery )

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

Аргументы

Delivery $delivery

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

getDeliveryExtraText ( Delivery $delivery )

Возвращает дополнительный произвольный текст для данной доставки (обычно срок доставки)

Аргументы

Delivery $delivery

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

getExcludeKeysByRights ( array $rights )

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

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

getExtraInfo ( )

Возвращает дополнительные пары ключ => значение для отображения в админ. панели в разделе "Информация о заказе"

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

getExtraInfoLine ( $key = null )

Возвращет данные из секции "extrainfo"

Аргументы

string $key - ключ в секции extrainfo, если не указан, то возвращает всю секцию

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

getExtraKeyPair ( $key = null )

Возвращет данные из секции "extrakeypair"

Аргументы

string $key - ключ в секции extrakeypair, если не указан, то возвращает всю секцию

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

getFieldsManager ( )

Возвращает объект, управляющий дополнительными полями, заданными в настройках модуля

Возвращает

getFiles	(		$access = `['visible'`,
		'afterpay']	,
			$include_product_files = `true`
	)

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

Аргументы

string \| array	$access	- уровень доступа
bool	$include_product_files	- если true, то в результатах будет выведены и список файлов товаров, доступных после оплаты

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

getFromSession ( )

Загружает объект данными из сессии. После вызова данного метода, любые изменения в объект будут сохраняться в сессию

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

getInventoryApi ( )

Возвращает API Складского учета

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

getLinkedDocuments ( )

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

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

getManagerUser ( )

Возвращает менеджера, назначенного на данный заказ

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

getMyCurrency ( )

Возвращает валюту, в которой был оформлен заказ

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

getOnlinePayUrl	(	$absolute = `false`,
		$extra_params = `[]`
	)

Возвращайет URL для оплаты заказа в случае выбора online способа оплаты

Аргументы

bool	$absolute	- Если true, то будет возвращен абсолютный URL
array	$extra_params	- Дополнительные параметры, которые необходимо добавить к URL

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

getOrderCostId ( )

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

Это либо тип цен пользователя, который оформлял заказ, либо Тип цен филиала, с которым был оформлен заказ либо цена по умолчанию

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

getPayment ( $cache = true )

Возвращает объект способа оплаты

Аргументы

bool $cache

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

getPrintForms ( )

Возвращает список объектов для печати текущего заказа

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

getProductsHash ( )

Фукнция срабатывает после записи объекта в БД

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

Исключения

RSException

getProductsInCargoStatus ( )

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

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

getSavedPaymentMethod ( )

Возвращает объект сохранённого способа платежа

Возвращает: SavedPaymentMethod|null

getSelectedPvz ( )

Возвращает указанный в заказе ПВЗ

Возвращает: Pvz|null

getShopCompany ( )

Возвращает объект компании(с реквизитами), которая поставляет услуги для данного заказа

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

getSpecialParam	(	string	$key,
			$default = `null`
	)

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

Аргументы

string	$key	- флаг
mixed	$default	- значение по умолчанию

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

getStartStatus ( )

Возвращает стартовый статус заказа

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

getStatus ( )

Возвращает объект статуса заказа

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

getStockAffiliateWarehouse ( )

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

Возвращает: WareHouse|bool

getStockWarehouse ( )

Возвращает склад на котором должно происходить изменение остатков

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

getTotalPrice	(	$format = `true`,
		$use_currency = `false`
	)

Возвращает общую стоимость заказа

Аргументы

bool	$format	- Если true, то стоимость будет отформатирована
bool	$use_currency	- Если true, то стоимость будет возвращена, в валюте в которой оформлялся заказ

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

getTrackUrl ( )

Возвращает адрес для отслеживания доставки заказа

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

getUser ( )

Возвращает пользователя, оформившего заказ

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

getWarehouse ( )

Возвращает объект выбранного склада

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

getWeight	(	$weight_unit = `null`,
		$cache = `true`
	)

Возращает вес заказа в граммах

Аргументы

null \| string	$weight_unit	- идентификатор единицы измерения, в которй нужно получить вес (соотношение к граммам)
bool	$cache	- использовать кэш

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

Исключения

RSException

isAllProductsInCargo ( )

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

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

isRefreshMode ( )

Возвращает значение флага "пересчёт данных заказа без сохранения"

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

linkSessionCart ( Cart $cart )

Привязывает корзину к заказу

Аргументы

Cart $cart - загруженный объект корзины в режиме PREORDER или EMPTY

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

static regionList ( )

static

Возвращает список регионов в стране

removeConditionCheckers ( )

Удаляет чекеры, которые используются при оформлении заказа в клиентской части

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

removeExtraInfoLine	(	$key = `null`,
		$type = `null`
	)

Удаляет данные из секции "extrainfo"

Аргументы

string	$key	- ключ в секции extrainfo
string	$type	- тип инфолинии

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

removeExtraKeyPair ( $key )

Удаляет в скрытую секцию с данными по ключу

Аргументы

string $key - ключ

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

resetOrderForCheckout ( )

Очищает поля в объекте заказа, которые должны быть пустыми перед оформлением нового заказа.

setAddress ( Address $address )

Устанавливает объект адреса доставки, в случае если адрес доставки еще не существует в БД

Аргументы

Address $address

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

setAddressFromSelectedAddress ( )

Пробует установить адрес по "выбранному адресу"

setCurrency ( Currency $currency )

Сохраняет параметры валюты, в которой оформляется заказ

Аргументы

Currency $currency

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

setRefreshMode ( bool $refresh_mode )

Устанавливает значение флага "пересчёт данных заказа без сохранения"

Аргументы

bool $refresh_mode

setSpecialParam	(	string	$key,
			$value
	)

Устанавливает специальный параметр, список возможных параметров находится в константах класса

Аргументы

string	$key	- флаг
bool	$value	- значение

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

setUseAddr ( ?int $address_id )

Устанавливает id адреса доставки

Аргументы

int $address_id - id адреса доставки

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

useFields ( $post )

Возвращает поля, которые удовлетворяют условиям condition. Условия задают в каком случае поля должны запрашиваться и проверяться из POST

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

Поля

$address

$cache_delivery

protected

$cache_payment

protected

$cache_weigth = []

protected

$cargos

protected

$my_currency

protected

$order_cart

$products_hash = null

protected

$refresh_mode = false

protected

$session_cart

$table = 'order'

staticprotected

$this_before_write

$use_generated_order_num = null

protected

const CREATOR_PLATFORM_API = 'api'

const CREATOR_PLATFORM_SITE = 'site'

const DOCUMENT_TYPE_ORDER = 'order'

const EXTRAINFOLINE_TYPE_DEFAULT = 'default'

const EXTRAINFOLINE_TYPE_DELIVERY = 'delivery'

const EXTRAKEYPAIR_DELIVERY_EXTRA = 'delivery_extra'

const ORDER_SESS_VAR = 'ORDER-ORMOBJECT'

const PRODUCT_IN_CARGO_STATUS_FULLY = 'fully'

const PRODUCT_IN_CARGO_STATUS_NONE = 'none'

const PRODUCT_IN_CARGO_STATUS_PARTIALLY = 'partially'

const SPECIAL_CHECKOUT_FORBID_VALIDATE = 'checkout_forbid_validate'

const SPECIAL_DISABLE_CHECK_QUANTITY = 'checkout_disable_check_quantity'

const SPECIAL_DISABLE_UPDATE_PRODUCTS_STOCK = 'disable_update_products_stock'

const USER_TYPE_COMPANY = 'company'

const USER_TYPE_NOREGISTER = 'noregister'

const USER_TYPE_PERSON = 'person'

const USER_TYPE_USER = 'user'

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

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

Поля данных

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

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

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

Методы

Поля