Class Shop_Order_Model

Shop_Order_Model

Core_ORM

Core_Entity

Shop_Order_Model

Package: HostCMS\Shop
Copyright: © 2005-2021 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Author: Hostmake LLC
Version: 6.x
Located at shop/order/model.php

Methods summary

`public Core_Entity`	# `markDeleted( )` Mark entity as deleted Mark entity as deleted Returns `Core_Entity` Overrides `Core_Entity::markDeleted`
`public`	# `__construct( integer $id = NULL )` Constructor. Constructor. Parameters `$id` entity ID Overrides `Core_Entity::__construct`
`public string`	# `companyBadge( Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller )` Backend badge Backend badge Parameters `$oAdmin_Form_Field` `$oAdmin_Form_Controller` Returns string
`public Core_Entity`	# `delete( mixed $primaryKey = NULL )` Delete object from database Delete object from database Parameters `$primaryKey` primary key for deleting object Returns `Core_Entity` Hostcms-event shop_order.onBeforeRedeclaredDelete Overrides `Core_Entity::delete`
`public Shop_Order_Model`	# `changeStatusPaid( )` Change cancel on opposite Change cancel on opposite Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforeChangeStatusPaid shop_order.onAfterChangeStatusPaid
`public Shop_Order_Model`	# `changeStatusPosted( )` Change posted Change posted Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforeChangeStatusPosted shop_order.onAfterChangeStatusPosted
`public float`	# `getAmount( )` Get amount of order Get amount of order Returns float
`public float`	# `getQuantity( )` Get quantity of items in an order Get quantity of items in an order Returns float
`public float`	# `getSum( )` Get sum of order Get sum of order Returns float
`public string`	# `sum( )` Get order sum with currency name Get order sum with currency name Returns string
`public float`	# `getWeight( )` Get order weight Get order weight Returns float
`public string`	# `weightBackend( )` Backend callback method Backend callback method Returns string
`public`	# `smallAvatarBackend( )`
`public Shop_Order_Model`	# `changeStatusCanceled( )` Change cancel on opposite Change cancel on opposite Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforeChangeStatusCanceled shop_order.onAfterChangeStatusCanceled
`public Shop_Order_Model`	# `cancel( )` Cancel the order Cancel the order Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforeCancel shop_order.onAfterCancel
`public Shop_Order_Model`	# `uncancel( )` Uncancel the order Uncancel the order Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforeUncancel shop_order.onAfterUncancel
`public boolean`	# `recalcDelivery( )` Recalc delivery price by delivery conditions Recalc delivery price by delivery conditions Returns boolean Hostcms-event shop_order.onBeforeRecalcDelivery shop_order.onAfterRecalcDelivery
`public array`	# `getByShopId( integer $shop_id )` Get orders by shop id Get orders by shop id Parameters `$shop_id` shop id Returns array
`public Shop_Order_Model`	# `showXmlCountry( boolean $showXmlCountry = TRUE )` Show country in XML Show country in XML Parameters `$showXmlCountry` Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlCurrency( boolean $showXmlCurrency = TRUE )` Show currency in XML Show currency in XML Parameters `$showXmlCurrency` Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlSiteuser( boolean $showXmlSiteuser = TRUE )` Show siteuser in XML Show siteuser in XML Parameters `$showXmlSiteuser` Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlItems( mixed $showXmlItems = TRUE )` Show items in XML Show items in XML Parameters `$showXmlItems` TRUE\|FALSE\|'not canceled' Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlDelivery( boolean $showXmlDelivery = TRUE )` Show delivery in XML Show delivery in XML Parameters `$showXmlDelivery` Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlPaymentSystem( boolean $showXmlPaymentSystem = TRUE )` Show payment system in XML Show payment system in XML Parameters `$showXmlPaymentSystem` Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlOrderStatus( boolean $showXmlOrderStatus = TRUE )` Show order's status in XML Show order's status in XML Parameters `$showXmlOrderStatus` Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `showXmlProperties( mixed $showXmlProperties = TRUE )` Show properties in XML Show properties in XML Parameters `$showXmlProperties` array of allowed properties ID or boolean Returns `Shop_Order_Model`
`public string`	# `getXml( )` Get XML for entity and children entities Get XML for entity and children entities Returns string Hostcms-event shop_order.onBeforeRedeclaredGetXml Overrides `Core_Entity::getXml`
`public stdObject`	# `getStdObject( $attributePrefix = '_' )` Get stdObject for entity and children entities Get stdObject for entity and children entities Returns stdObject Hostcms-event shop_order.onBeforeRedeclaredGetStdObject Overrides `Core_Entity::getStdObject`
`protected Shop_Order_Model`	# `_prepareData( )` Prepare entity and children entities Prepare entity and children entities Returns `Shop_Order_Model`
`protected`	# `_preparePropertyValue( Property_Value_Model $oProperty_Value )` Prepare Property Value Prepare Property Value Parameters `$oProperty_Value`
`public Shop_Order_Model`	# `paid( )` Pay the order Pay the order Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforePaid shop_order.onAfterPaid
`protected`	# `_paidShopDiscountcard( )`
`protected Shop_Order_Model`	# `_createNotification( )` Create notification for subscribers Create notification for subscribers Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `cancelPaid( )` Cancel payment Cancel payment Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforeCancelPaid shop_order.onAfterCancelPaid
`public`	# `checkShopOrderItemStatuses( )`
`protected Shop_Order_Model`	# `_deleteDigitalItems( )` Delete digital items Delete digital items Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `reserveItems( )` Reserve items for order Reserve items for order Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `deleteReservedItems( )` Delete reserved items for order Delete reserved items for order Returns `Shop_Order_Model`
`protected Shop_Order_Model`	# `_paidTransaction( )` Списание или возврат товара на склад, начисление и стронирование операций по лицевому счету Списание или возврат товара на склад, начисление и стронирование операций по лицевому счету Returns `Shop_Order_Model` Hostcms-event shop_order.onAfterSaveSiteuserTransaction
`public Shop_Order_Model`	# `post( )` Add entries Add entries Returns `Shop_Order_Model` Hostcms-event shop_order.onBeforePost shop_order.onAfterPost
`public Shop_Order_Model`	# `unpost( )` Remove all shop warehouse entries by document Remove all shop warehouse entries by document Returns `Shop_Order_Model`
`public string`	# `getOrderPath( )` Get item path include CMS_FOLDER Get item path include CMS_FOLDER Returns string
`public string`	# `getOrderHref( )` Get item href Get item href Returns string
`public Shop_Order_Model`	# `createDir( )` Create directory for item Create directory for item Returns `Shop_Order_Model`
`public array`	# `getPropertyValues( boolean $bCache = TRUE )` Values of all properties of item Значения всех свойств товара Values of all properties of item Значения всех свойств товара Parameters `$bCache` cache mode status Returns array Property_Value
`public Shop_Order_Model`	# `createInvoice( )` Generate invoice by invoice_template or set invoice like id Generate invoice by invoice_template or set invoice like id Returns `Shop_Order_Model`
`public Core_Entity`	# `copy( )` Copy object Copy object Returns `Core_Entity` Hostcms-event shop_order.onAfterRedeclaredCopy Overrides `Core_Entity::copy`
`public`	# `addCml( Core_SimpleXMLElement $oXml )` Add order CommerceML Add order CommerceML Parameters `$oXml` Hostcms-event shop_order.onBeforeGetCmlUserName shop_order.onAddCmlSelectShopOrderItems
`public string`	# `orderPopover( )` Get Popover Content Get Popover Content Returns string Hostcms-event shop_order.onBeforeOrderPopover
`public`	# `order_items( $oAdmin_Form_Field, $oAdmin_Form_Controller )`
`public string`	# `order_itemsBadge( Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller )` Backend badge Backend badge Parameters `$oAdmin_Form_Field` `$oAdmin_Form_Controller` Returns string
`public Shop_Order_Model`	# `sendMail( )` Send order e-mails Send order e-mails Returns `Shop_Order_Model`
`public`	# `date( )`
`public`	# `getFullAddress( )`
`public`	# `getCustomerName( )`
`public Shop_Order_Model`	# `addPurchaseDiscount( array $aOptions )` Add discounts to the shop_order Add discounts to the shop_order Parameters `$aOptions` array('amount' => $amount, 'quantity' => $quantity, 'prices' => $aDiscountPrices, 'applyDiscounts' => TRUE, 'applyDiscountCards' => TRUE) Returns `Shop_Order_Model`
`public integer`	# `ordersToday( )` Get the number of orders for today Get the number of orders for today Returns integer
`public integer`	# `ordersCurrentMonth( )` Get the number of orders for the current month Get the number of orders for the current month Returns integer
`public integer`	# `ordersCurrentYear( )` Get the number of orders for the current year Get the number of orders for the current year Returns integer
`public string`	# `shop_order_status_idBackend( $oAdmin_Form_Field, $oAdmin_Form_Controller )` Backend callback method Backend callback method Returns string
`public array`	# `getPrintlayoutReplaces( )` Get printlayout replaces Get printlayout replaces Returns array Hostcms-event shop_order.onAfterGetPrintlayoutReplaces
`public string`	# `propertyValue( integer $property_id, strint $format = '%2$s', string $separator = ', ' )` Get property value for SEO-templates Get property value for SEO-templates Parameters `$property_id` Property ID `$format` string format, e.g. '%s: %s'. %1$s - Property Name, %2$s - List of Values `$separator` separator Returns string
`public Shop_Order_Model`	# `historyPushPaid( )` Push paid history Push paid history Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `historyPushPosted( )` Push posted history Push posted history Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `historyPushCanceled( )` Push canceled history Push canceled history Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `historyPushChangeStatus( )` Push change status history Push change status history Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `historyPushChangeUser( )` Push change status history Push change status history Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `notifyBotsChangeStatus( )` Notify Bots Notify Bots Returns `Shop_Order_Model`
`public array`	# `getResponsibleUsers( )` Get responsible users Get responsible users Returns array
`public Shop_Order_Model`	# `backupRevision( )` Backup revision Backup revision Returns `Shop_Order_Model`
`public Shop_Order_Model`	# `rollbackRevision( integer $revision_id )` Rollback Revision Rollback Revision Parameters `$revision_id` Revision ID Returns `Shop_Order_Model`
`public string`	# `getTrashDescription( )` Get entity description Get entity description Returns string Overrides `Core_Entity::getTrashDescription`
`public Site_Model\|null`	# `getRelatedSite( )` Get Related Site Get Related Site Returns `Site_Model`\|null Hostcms-event shop_order.onBeforeGetRelatedSite shop_order.onAfterGetRelatedSite Overrides `Core_Entity::getRelatedSite`

Methods inherited from Core_Entity

__call(), _getCopiedName(), addAllowedTag(), addEntities(), addEntity(), addForbiddenTag(), addForbiddenTags(), addXmlTag(), applyMarksDeleted(), changeCopiedName(), clear(), clearEntities(), clearEntitiesAfterGetXml(), clearXmlTags(), create(), factory(), find(), findAll(), getCount(), getEntities(), getFieldIDs(), getFields(), getForbiddenTags(), getMarksDeleted(), getName(), getNameColumn(), getRelations(), getTableColums(), getXmlTagName(), getXmlTags(), removeForbiddenTag(), setCheck(), setMarksDeleted(), setXmlTagName(), undelete(), update()

Methods inherited from Core_ORM

__clone(), __get(), __isset(), __set(), __toString(), _convertPropertyValue(), _getRelation(), _init(), _load(), _loadColumnCacheDefaultValues(), _loadColumns(), _onAfterLoad(), _onBeforeLoad(), _relations(), _setDefaultValues(), _setPreloadValues(), add(), changed(), check(), chunk(), clearColumnCache(), clearRelationCache(), clearRelationModelCache(), deleteAll(), getChangedData(), getClassName(), getDatabase(), getFirst(), getLast(), getModelName(), getPrimaryKey(), getPrimaryKeyName(), getTableColumns(), getTableName(), isCallable(), isEmptyPrimaryKey(), load(), loaded(), queryBuilder(), remove(), save(), setDatabaseDriver(), setRelations(), setValues(), toArray()

Constants summary

`integer`	`TYPE`	# `5`

Properties summary

`protected array`	`$_propertyValues` Values of all properties of item Values of all properties of item	# `NULL`
`public integer`	`$order_items` Backend property Backend property	# `1`
`protected string`	`$_nameColumn` Column consist item's name Column consist item's name	# `'invoice'`
`protected array`	`$_hasMany` One-to-many or many-to-many relations One-to-many or many-to-many relations	# `array( 'shop_order_item' => array(), 'shop_item_reserved' => array(), 'shop_siteuser_transaction' => array(), 'shop_discountcard_bonus' => array(), 'shop_purchase_discount_coupon' => array(), 'shop_order_history' => array() )`
`protected array`	`$_preloadValues` List of preloaded values List of preloaded values	# `array( 'shop_country_location_city_area_id' => 0, 'shop_country_location_city_id' => 0, 'shop_country_location_id' => 0, 'shop_country_id' => 0, 'unloaded' => 0 )`
`protected array`	`$_belongsTo` Belongs to relations Belongs to relations	# `array( 'shop' => array(), 'shop_company' => array('model' => 'Company', 'foreign_key' => 'company_id'), 'shop_country_location' => array(), 'shop_country' => array(), 'shop_country_location_city' => array(), 'shop_country_location_city_area' => array(), 'shop_delivery' => array(), 'shop_delivery_condition' => array(), 'siteuser' => array(), 'shop_currency' => array(), 'shop_order_status' => array(), 'shop_payment_system' => array(), 'source' => array(), 'user' => array() )`
`protected array`	`$_sorting` Default sorting for models Default sorting for models	# `array( 'shop_orders.datetime' => 'ASC', )`
`protected array`	`$_forbiddenTags` Forbidden tags. If list of tags is empty, all tags will show. Forbidden tags. If list of tags is empty, all tags will show.	# `array( 'deleted', 'user_id', 'datetime', 'payment_datetime', 'status_datetime', )`
`protected boolean`	`$_showXmlCountry` Show countries data in XML Show countries data in XML	# `FALSE`
`protected boolean`	`$_showXmlCurrency` Show currency data in XML Show currency data in XML	# `FALSE`
`protected boolean`	`$_showXmlSiteuser` Show siteuser data in XML Show siteuser data in XML	# `FALSE`
`protected mixed`	`$_showXmlItems` Show order items data in XML Show order items data in XML	# `FALSE`
`protected boolean`	`$_showXmlDelivery` Show delivery data in XML Show delivery data in XML	# `FALSE`
`protected boolean`	`$_showXmlPaymentSystem` Show payment systems data in XML Show payment systems data in XML	# `FALSE`
`protected boolean`	`$_showXmlOrderStatus` Show order statuses data in XML Show order statuses data in XML	# `FALSE`
`protected boolean`	`$_showXmlProperties` Show properties in XML Show properties in XML	# `FALSE`
`protected`	`$_oShop_Discountcard`	# `NULL`

Properties inherited from Core_Entity

$_allowedTags, $_cacheAllowedTags, $_cacheFieldIDs, $_cacheForbiddenTags, $_cacheShortcodeTags, $_changeCopiedName, $_check, $_childrenEntities, $_clearEntitiesAfterGetXml, $_hasRevisions, $_marksDeleted, $_shortcodeTags, $_tagName, $_typicalForbiddenTags, $_xmlTags

Classes

Exceptions

Functions

Class Shop_Order_Model

Methods summary

Returns

Overrides

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Hostcms-event

Overrides

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Hostcms-event

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Hostcms-event

Overrides

Returns

Hostcms-event

Overrides

Returns

Parameters

Returns

Hostcms-event

Returns

Returns

Hostcms-event

Returns

Returns

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Hostcms-event