Версия: 4.x
Класс Order
Граф наследования:Order:
OrmObject AbstractObject AcceptBehavior AcceptBehaviorInterface

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

ORM Объект - заказ.

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

 _init ()
 
 getProductsHash ()
 
 afterWrite ($flag)
 
 delete ()
 
 afterObjectLoad ()
 
 canUserNotify ()
 
 linkSessionCart (\Shop\Model\Cart $cart)
 
 setCurrency (\Catalog\Model\Orm\Currency $currency)
 
 checkProductsNum ()
 
 incProductsNum ($warehouse=false)
 
 decProductsNum ()
 
 getFromSession ()
 
 removeConditionCheckers ()
 
 useFields ($post)
 
 getFieldsManager ()
 
 getAddress ($cache=true)
 
 setAddress (Address $address)
 
 getWeight ($weight_unit=null, $cache=true)
 
 getDelivery ()
 
 getPayment ()
 
 getWarehouse ()
 
 getDeliveryCostText (Delivery $delivery)
 
 getDeliveryExtraText (Delivery $delivery)
 
 applyMyCurrency ($price)
 
 getMyCurrency ()
 
 getUser ()
 
 getCart ()
 
 canEdit ()
 
 getStatus ()
 
 getTotalPrice ($format=true, $use_currency=false)
 
 getSuccessTransactions ()
 
 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 ()
 
 canChangePayment ()
 
 getOnlinePayUrl ($absolute=false)
 
 getFiles ($access=array('visible', 'afterpay'), $include_product_files=true)
 
 getDeliveryCost ()
 
 setDefaultAddress ()
 
 getTrackUrl ()
 
 getCourierUser ()
 
 getLinkedDocuments ()
 
 getInventoryApi ()
 
- Открытые члены унаследованные от OrmObject
 __construct ($id=null, $cache=true)
 
 getPrimaryKeyProperty ()
 
 saveInCache ($id)
 
 loadFromCache ($id)
 
- Открытые члены унаследованные от AbstractObject
 __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=array(), $on_duplicate_uniq_fields=array())
 
 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)
 
 _getTable ()
 
 _getTableArray ()
 
 getPrimaryKeyProperty ()
 
 getProperties ()
 
 getProp ($offset)
 
 save ($primaryKeyValue=null, $user_post=array(), $post_var=null, $files_var=null)
 
 replaceOn ($bool)
 
 setWriteBit ($n)
 
 usePostKeys (array $keys)
 
 excludePostKeys (array $keys)
 
 checkData ($user_post=array(), $post_var=null, $files_var=null, $usekeys=null, $exclude=null, $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=array(), $view_params=array())
 
 getHiddenKeyVal ()
 
 addHiddenFields ($keys, $value=null)
 
 addDebugActions (array $actions, $local=false)
 
 addDebugAction (\RS\Debug\Action\AbstractAction $action, $local=false)
 
 getDebugAttributes ()
 
 cloneSelf ()
 
 beforeWrite ($save_flag)
 
 afterWrite ($save_flag)
 
 afterObjectLoad ()
 
 getDebugActions ()
 
 dropTable ()
 
 exportErrors ()
 
 current ()
 
 key ()
 
 next ()
 
 rewind ()
 
 valid ()
 
 __sleep ()
 
 __wakeup ()
 
 __clone ()
 
 getRightRead ()
 
 getRightCreate ()
 
 getRightUpdate ()
 
 getRightDelete ()
 
- Открытые члены унаследованные от 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 chkDepend ($coreobj, $value, $real_errtext, $real_chk, array $conditions, $real_params=array())
 
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 ACL_WRITE_ORDER_BIT = 2
 
const DOCUMENT_TYPE_ORDER = 'order'
 
const ORDER_SESS_VAR = 'ORDER-ORMOBJECT'
 
 $products_hash = null
 
 $cache_weigth = null
 
 $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'
 
 $_self_class
 
 $_local_id
 
- Поля данных унаследованные от AcceptBehavior
 $class_behaviors = array()
 
 $cache_behavior_instances = array()
 
 $instance_behaviors = array()
 

Статические открытые данные

static $table = 'order'
 
- Статические открытые данные унаследованные от OrmObject
static $self_cache = array()
 
- Статические открытые данные унаследованные от AbstractObject
static $table = null
 
static $iterator = 0
 
static $init_default_method = '_initDefaults'
 
static $local = array()
 
static $default_local_parameters
 
static $class = array()
 
static $default_class_parameters
 

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

 $use_generated_order_num = null
 
- Защищенные данные унаследованные от AbstractObject
 $_values = array()
 

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

static $currency
 
- Статические защищенные данные унаследованные от OrmObject
static $self_singleton_cache = array()
 
- Статические защищенные данные унаследованные от AbstractObject
static $db = DB_NAME
 

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

- Защищенные члены унаследованные от OrmObject
 _init ()
 
- Защищенные члены унаследованные от AbstractObject
 initProperties ()
 
 _init ()
 
 _initDefaults ()
 
 afterInit ()
 
 getStorageInstance ()
 
 _tableName ($with_quotes=true)
 
 getPropertyHash ($is_multiedit, $switch=null)
 
- Защищенные статические члены унаследованные от OrmObject
static getIdHash ($id)
 

Методы

_init ( )
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- значение для сохранения
Возвращает
afterObjectLoad ( )

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

afterWrite (   $flag)
applyMyCurrency (   $price)

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

Аргументы
float$price
Возвращает
double
canChangePayment ( )

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

Возвращает
bool
canEdit ( )

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

Возвращает
bool
canOnlinePay ( )

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

canUserNotify ( )

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

Возвращает
bool
checkProductsNum ( )

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

static currentOrder ( )
static

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

Возвращает
Order
decProductsNum ( )

Уменьшить количество остатков на величину заказа

delete ( )

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

Возвращает
boolean - true, в случае успеха
getAddress (   $cache = true)

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

Возвращает
getAllowCurrencies ( )

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

Возвращает
array
getCart ( )

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

Возвращает
getCourierUser ( )

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

Возвращает
getDelivery ( )

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

Возвращает
Delivery
getDeliveryCost ( )

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

Возвращает
float
getDeliveryCostText ( Delivery  $delivery)

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

Аргументы
Delivery$delivery
Возвращает
string
getDeliveryExtraText ( Delivery  $delivery)
getExtraInfo ( )

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

Возвращает
array
getExtraInfoLine (   $key = null)

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

Аргументы
string$key- ключ в секции extrainfo, если не указан, то возвращает всю секцию
Возвращает
mixed
getExtraKeyPair (   $key = null)

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

Аргументы
string$key- ключ в секции extrakeypair, если не указан, то возвращает всю секцию
Возвращает
mixed
getFieldsManager ( )

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

Возвращает
getFiles (   $access = array('visible', 'afterpay'),
  $include_product_files = true 
)

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

Аргументы
string  |  array$access- уровень доступа
bool$include_product_files- если true, то в результатах будет выведены и список файлов товаров, доступных после оплаты
Возвращает
[]
getFromSession ( )

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

Возвращает
void
getInventoryApi ( )
getLinkedDocuments ( )
getMyCurrency ( )

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

Возвращает
getOnlinePayUrl (   $absolute = false)

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

Аргументы
bool$absolute- Если true, то будет возвращен абсолютный URL
Возвращает
string
getPayment ( )

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

Возвращает
Payment
getPrintForms ( )

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

Возвращает
array
getProductsHash ( )

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

Возвращает
string
getShopCompany ( )

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

Возвращает
getStatus ( )

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

Возвращает
UserStatus
getSuccessTransactions ( )

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

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

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

Аргументы
bool$format- Если true, то стоимость будет отформатирована
bool$use_currency- Если true, то стоимость будет возвращена, в валюте в которой оформлялся заказ
Возвращает
float
getTrackUrl ( )

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

Возвращает
string
getUser ( )

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

Возвращает
getWarehouse ( )

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

Возвращает
getWeight (   $weight_unit = null,
  $cache = true 
)

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

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

Увеличить количество остатков на величину заказа

Аргументы
integer | boolean$warehouse- id склада на который будет возвращены количества товаров
linkSessionCart ( \Shop\Model\Cart  $cart)

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

Аргументы
\Shop\Model\Cart$cart- загруженный объект корзины в режиме PREORDER или EMPTY
Возвращает
Order
static regionList ( )
static

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

removeConditionCheckers ( )

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

Возвращает
void
removeExtraInfoLine (   $key = null,
  $type = null 
)

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

Аргументы
string$key- ключ в секции extrainfo
string$type- тип инфолинии
Возвращает
removeExtraKeyPair (   $key)

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

Аргументы
string$key- ключ
Возвращает
setAddress ( Address  $address)

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

Аргументы
Address$address
Возвращает
Order
setCurrency ( \Catalog\Model\Orm\Currency  $currency)

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

Аргументы
\Catalog\Model\Orm\Currency$currency
Возвращает
Order
setDefaultAddress ( )

Устанавливает адрес по умолчанию, если это возможно

Исключения
RS
RS
RS
useFields (   $post)

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

Возвращает
array

Поля

$address
$cache_weigth = null
$currency
staticprotected
$order_cart
$products_hash = null
$session_cart
$table = 'order'
static
Order $this_before_write
$use_generated_order_num = null
protected
const ACL_WRITE_ORDER_BIT = 2
const DOCUMENT_TYPE_ORDER = 'order'
const EXTRAINFOLINE_TYPE_DEFAULT = 'default'
const EXTRAINFOLINE_TYPE_DELIVERY = 'delivery'
const ORDER_SESS_VAR = 'ORDER-ORMOBJECT'
const USER_TYPE_COMPANY = 'company'
const USER_TYPE_NOREGISTER = 'noregister'
const USER_TYPE_PERSON = 'person'
const USER_TYPE_USER = 'user'