Documentation

Shop_Order_Model extends Core_Entity
in package

HostCMS

Shop

Shop_Order_Model

Constants

TYPE = 5: TYPE

Properties

$config : mixed: ORM config
$order_items : int: Backend property
$reviews : int: Callback property_id
$rollback : mixed: Backend property
$_aComments : array<string|int, mixed>: Array of comments, [parent_id] => array(comments)
$_allowedTags : array<string|int, mixed>: Allowed tags. If list of tags is empty, all tags will show.
$_attributes : array<string|int, mixed>: Entity Attributes
$_belongsTo : array<string|int, mixed>: Belongs to relations
$_changeCopiedName : bool: Change copied name is necessary, default FALSE
$_changedColumns : array<string|int, mixed>: List of changed columns
$_commentsActivity : string: What comments show in XML? (active|inactive|all)
$_dataValues : array<string|int, mixed>: data-values, e.g. dataMyValue
$_forbiddenTags : array<string|int, mixed>: Forbidden tags. If list of tags is empty, all tags will show.
$_hasMany : array<string|int, mixed>: One-to-many or many-to-many relations
$_hasOne : array<string|int, mixed>: One-to-one relations
$_hasRevisions : mixed: Has revisions
$_marksDeleted : mixed: Marks deleted entity
$_modelColumns : array<string|int, mixed>: List of columns in model with values
$_modelName : mixed: Model name, e.g. 'book' for 'Book_Model'
$_nameColumn : string: Column consist item's name
$_oShop_Discountcard : mixed
$_preloadValues : array<string|int, mixed>: List of preloaded values
$_primaryKey : string: Primary key
$_propertyValues : array<string|int, mixed>: Values of all properties of item
$_queryBuilder : Core_QueryBuilder_Select: Select query builder
$_shortcodeTags : array<string|int, mixed>: List of Shortcodes tags
$_showXmlCommentProperties : bool: Show shop order properties in XML
$_showXmlComments : bool: Show comments data in XML
$_showXmlCommentsRating : bool: Show comments rating data in XML
$_showXmlCountry : bool: Show countries data in XML
$_showXmlCurrency : bool: Show currency data in XML
$_showXmlDelivery : bool: Show delivery data in XML
$_showXmlItems : mixed: Show order items data in XML
$_showXmlOrderStatus : bool: Show order statuses data in XML
$_showXmlPaymentSystem : bool: Show payment systems data in XML
$_showXmlProperties : bool: Show properties in XML
$_showXmlSiteuser : bool: Show siteuser data in XML
$_skipColumns : array<string|int, mixed>: List of skipped columns from table
$_sorting : array<string|int, mixed>: Default sorting for models
$_tableColumns : array<string|int, mixed>: List of columns in table
$_tableName : mixed: Table name, e.g. 'books' for 'Book_Model'
$_typicalForbiddenTags : array<string|int, mixed>: Typical forbidden tags.
$_xmlSortPropertiesValues : mixed: Sort properties values in XML

Methods

__call() : mixed: Triggered when invoking inaccessible methods in an object context
__construct() : mixed: Constructor.
add() : self: Add related object. If main object does not save, it will save.
addAllowedTag() : self: Add tag to allowed tags list
addAllowedTags() : self: Add tags to allowed tags list
addAttribute() : self: Add entity attribute
addCml() : mixed: Add order CommerceML
addEntities() : self: Add children entities
addEntity() : self: Add a children entity
addForbiddenTag() : self: Add tag to forbidden tags list
addForbiddenTags() : self: Add tags to forbidden tags list
addPurchaseDiscount() : self: Add discounts to the shop_order
addXmlTag() : self: Add external tag for entity
applyMarksDeleted() : self: Apply markDeleted flag if is set
backupRevision() : self: Backup revision
cancel() : self: Cancel the order
cancelPaid() : self: Cancel payment
changeCopiedName() : self: Set if change copied name is necessary
changed() : bool: Check model has been changed.
changeStatusCanceled() : self: Change cancel on opposite
changeStatusPaid() : self: Change cancel on opposite
changeStatusPosted() : self: Change posted
check() : self: Check model values. If model has incorrect value, one will correct or call exception.
checkShopOrderItemStatuses() : mixed
checkShopOrderStatusDeadline() : self: Check shop order status deadline
chunk() : bool: Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE
clear() : self: Clear object
clearEntities() : self: Clear enities
clearEntitiesAfterGetXml() : self: Clear all entities after XML generation
clearXmlTags() : mixed: Clear external XML tags for entity.
commentsActivity() : self: Set comments filter rule
companyBadge() : string: Backend badge
copy() : Core_Entity: Copy object
create() : self: Insert new object data into database
createDir() : self: Create directory for item
createInvoice() : self: Generate invoice by invoice_template or set invoice like id
date() : mixed
delete() : Core_Entity: Delete object from database
deleteAll() : self: Delete all object
deleteReservedItems() : self: Delete reserved items for order
factory() : mixed: Create and return an object of model
find() : self: Find object in database and load one. Use clear() before find() with conditions!
findAll() : array<string|int, mixed>: Find all objects
getAllowedTags() : array<string|int, mixed>: Get allowed tags list
getAmount() : float: Get amount of order
getByShopId() : array<string|int, mixed>: Get orders by shop id
getChangedData() : array<string|int, mixed>: Get changed columns with values
getClassName() : string: Get Model CallsName
getCount() : int|false: Get count object
getCustomerName() : mixed
getDatabaseDriver() : string: Get name of Database Driver
getDataValues() : array<string|int, mixed>: Get dataValues
getEntities() : array<string|int, mixed>: Get children entities
getEntityType() : int: Get Entity Type
getFieldIDs() : array<string|int, mixed>: Get visible field's IDs
getFields() : array<string|int, mixed>: Get field's values
getFirst() : null|Core_ORM: Get fist entity, ordered by primary key
getForbiddenTags() : array<string|int, mixed>: Get forbidden tags list
getFullAddress() : mixed
getLast() : null|Core_ORM: Get last entity, ordered by primary key
getMarksDeleted() : string: Get column name for marks deleted
getModelName() : string: Get model name, e.g. 'book' for 'Book_Model'
getName() : string: Get entity name
getNameColumn() : string: Get Name Column
getOrderHref() : string: Get item href
getOrderPath() : string: Get item path include CMS_FOLDER
getPrimaryKey() : mixed: Get primary key value
getPrimaryKeyName() : string: Get primary key name
getPrintlayoutReplaces() : array<string|int, mixed>: Get printlayout replaces
getPropertyValues() : array<string|int, mixed>: Values of all properties of item Значения всех свойств товара
getQuantity() : float: Get quantity of items in an order
getRelatedSite() : Site_Model|null: Get Related Site
getRelations() : array<string|int, mixed>: Get $this->_relations
getResponsibleUsers() : array<string|int, mixed>: Get responsible users
getStdObject() : stdObject: Get stdObject for entity and children entities
getSum() : float: Get sum of order
getTableColumns() : array<string|int, mixed>: Get tableColumns
getTableColums() : array<string|int, mixed>: Get table columns. Fix wrong method name
getTableName() : string: Get table name
getTextPropertyValue() : string: Get text values of property
getTrashDescription() : string: Get entity description
getWeight() : float: Get order weight
getXml() : string: Get XML for entity and children entities
getXmlTagName() : string: Get tag name
getXmlTags() : array<string|int, mixed>: Get external XML tags for entity.
historyPushCanceled() : self: Push canceled history
historyPushChangeStatus() : self: Push change status history
historyPushChangeUser() : self: Push change status history
historyPushPaid() : self: Push paid history
historyPushPosted() : self: Push posted history
isCallable() : bool: Verify that the contents of a variable can be called as a function
isEmptyPrimaryKey() : bool: Check is primary key NULL
markDeleted() : Core_Entity: Mark entity as deleted
merge() : self: Merge list item with another one
notifyBotsChangeStatus() : self: Notify Bots
order_items() : mixed
order_itemsBadge() : string: Backend badge
orderPopover() : string: Get Popover Content
ordersCurrentMonth() : int: Get the number of orders for the current month
ordersCurrentYear() : int: Get the number of orders for the current year
ordersToday() : int: Get the number of orders for today
paid() : self: Pay the order
post() : self: Add entries
propertyValue() : string: Get property value for SEO-templates
queryBuilder() : Core_QueryBuilder_Select: Get query builder for select
recalcDelivery() : bool: Recalc delivery price by delivery conditions
remove() : self: Remove related object. If main object does not save, it will save.
removeAllowedTag() : self: Remove tag from allowed tags list
removeForbiddenTag() : self: Remove tag from forbidden tags list
reserveItems() : self: Reserve items for order
reviewsBadge() : string: Backend badge
rollbackRevision() : self: Rollback Revision
save() : self: Save object. Uses self::update() or self::create()
sendMail() : self: Send order e-mails
setCheck() : self: Set _check flag
setComments() : self: Set array of comments for getXml()
setDatabaseDriver() : mixed: Set name of Database Driver
setMarksDeleted() : self: Set column name for marks deleted
setRelations() : self: Set $this->_relations
setXmlTagName() : self: Set name of XML node
shop_order_status_idBackend() : string: Backend callback method
showXmlCommentProperties() : self: Show shop order properties in XML
showXmlComments() : self: Add comments XML to item
showXmlCommentsRating() : self: Add Comments Rating XML to item
showXmlCountry() : self: Show country in XML
showXmlCurrency() : self: Show currency in XML
showXmlDelivery() : self: Show delivery in XML
showXmlItems() : self: Show items in XML
showXmlOrderStatus() : self: Show order's status in XML
showXmlPaymentSystem() : self: Show payment system in XML
showXmlProperties() : self: Show properties in XML
showXmlSiteuser() : self: Show siteuser in XML
smallAvatarBackend() : mixed
sum() : string: Get order sum with currency name
toArray() : array<string|int, mixed>: Convert Object to Array
uncancel() : self: Uncancel the order
undelete() : self: Turn off deleted status
unpost() : self: Remove all shop warehouse entries by document
update() : self: Update object data into database
weightBackend() : string: Backend callback method
_addComments() : self: Add comments into object XML
_createNotification() : self: Create notification for subscribers
_deleteDigitalItems() : self: Delete digital items
_getCopiedName() : mixed: Get the name of a new copied object
_isTagAvailable() : bool: Is $tagName Available
_paidShopDiscountcard() : mixed
_paidTransaction() : self: Списание или возврат товара на склад, начисление и стронирование операций по лицевому счету
_prepareData() : self: Prepare entity and children entities
_preparePropertyValue() : mixed: Prepare Property Value
getDatabase() : Core_DataBase: Get Database

TYPE


    public
        int
    TYPE
    = 5

$config

ORM config


    public
    static    mixed
    $config
     = \NULL

$order_items

Backend property


    public
        int
    $order_items
     = 1

$reviews

Callback property_id


    public
        int
    $reviews
     = 1

$rollback

Backend property


    public
        mixed
    $rollback
     = 0

$_aComments

Array of comments, [parent_id] => array(comments)


    protected
        array<string|int, mixed>
    $_aComments
     = array()

$_allowedTags

Allowed tags. If list of tags is empty, all tags will show.


    protected
        array<string|int, mixed>
    $_allowedTags
     = array()

$_attributes

Entity Attributes


    protected
        array<string|int, mixed>
    $_attributes
     = array()

$_belongsTo

Belongs to relations


    protected
        array<string|int, mixed>
    $_belongsTo
     = array('company_account' => 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())

$_changeCopiedName

Change copied name is necessary, default FALSE


    protected
        bool
    $_changeCopiedName
     = \FALSE

$_changedColumns

List of changed columns


    protected
        array<string|int, mixed>
    $_changedColumns
     = array()

$_commentsActivity

What comments show in XML? (active|inactive|all)


    protected
        string
    $_commentsActivity
     = 'active'

$_dataValues

data-values, e.g. dataMyValue


    protected
        array<string|int, mixed>
    $_dataValues
     = array()

$_forbiddenTags

Forbidden tags. If list of tags is empty, all tags will show.


    protected
        array<string|int, mixed>
    $_forbiddenTags
     = array('deleted', 'user_id', 'datetime', 'payment_datetime', 'status_datetime')

$_hasMany

One-to-many or many-to-many relations


    protected
        array<string|int, mixed>
    $_hasMany
     = array('comment' => array('through' => 'comment_shop_order'), 'shop_order_item' => array(), 'shop_item_reserved' => array(), 'shop_siteuser_transaction' => array(), 'shop_discountcard_bonus' => array(), 'shop_discountcard_bonus_transaction' => array(), 'shop_purchase_discount_coupon' => array(), 'shop_order_history' => array())

$_hasOne

One-to-one relations


    protected
        array<string|int, mixed>
    $_hasOne
     = array()


// Relation one-to-one for Book-Comment:
protected $_hasOne = array('comment' => array());


// Equivalence relation one-to-one for Book-Comment with detailed conditions:
// comment - Model name
// foreign_key - Foreign key
protected $_hasOne = array('comment' => array(
'foreign_key' => 'book_id'
	));

$_hasRevisions

Has revisions


    protected
        mixed
    $_hasRevisions
     = \FALSE

$_marksDeleted

Marks deleted entity


    protected
        mixed
    $_marksDeleted
     = 'deleted'

$_modelColumns

List of columns in model with values


    protected
        array<string|int, mixed>
    $_modelColumns
     = array()

$_modelName

Model name, e.g. 'book' for 'Book_Model'


    protected
        mixed
    $_modelName
     = \NULL

$_nameColumn

Column consist item's name


    protected
        string
    $_nameColumn
     = 'invoice'

$_oShop_Discountcard


    protected
        mixed
    $_oShop_Discountcard
     = \NULL

$_preloadValues

List of preloaded values


    protected
        array<string|int, mixed>
    $_preloadValues
     = 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)

$_primaryKey

Primary key


    protected
        string
    $_primaryKey
     = 'id'

$_propertyValues

Values of all properties of item


    protected
        array<string|int, mixed>
    $_propertyValues
     = \NULL

$_queryBuilder

Select query builder


    protected
        Core_QueryBuilder_Select
    $_queryBuilder
     = \NULL

$_shortcodeTags

List of Shortcodes tags


    protected
        array<string|int, mixed>
    $_shortcodeTags
     = array()

$_showXmlCommentProperties

Show shop order properties in XML


    protected
        bool
    $_showXmlCommentProperties
     = \FALSE

$_showXmlComments

Show comments data in XML


    protected
        bool
    $_showXmlComments
     = \FALSE

$_showXmlCommentsRating

Show comments rating data in XML


    protected
        bool
    $_showXmlCommentsRating
     = \FALSE

$_showXmlCountry

Show countries data in XML


    protected
        bool
    $_showXmlCountry
     = \FALSE

$_showXmlCurrency

Show currency data in XML


    protected
        bool
    $_showXmlCurrency
     = \FALSE

$_showXmlDelivery

Show delivery data in XML


    protected
        bool
    $_showXmlDelivery
     = \FALSE

$_showXmlItems

Show order items data in XML


    protected
        mixed
    $_showXmlItems
     = \FALSE

$_showXmlOrderStatus

Show order statuses data in XML


    protected
        bool
    $_showXmlOrderStatus
     = \FALSE

$_showXmlPaymentSystem

Show payment systems data in XML


    protected
        bool
    $_showXmlPaymentSystem
     = \FALSE

$_showXmlProperties

Show properties in XML


    protected
        bool
    $_showXmlProperties
     = \FALSE

$_showXmlSiteuser

Show siteuser data in XML


    protected
        bool
    $_showXmlSiteuser
     = \FALSE

$_skipColumns

List of skipped columns from table


    protected
        array<string|int, mixed>
    $_skipColumns
     = array()

$_sorting

Default sorting for models


    protected
        array<string|int, mixed>
    $_sorting
     = array('shop_orders.datetime' => 'ASC')

$_tableColumns

List of columns in table


    protected
        array<string|int, mixed>
    $_tableColumns
     = array()

$_tableName

Table name, e.g. 'books' for 'Book_Model'


    protected
        mixed
    $_tableName
     = \NULL

$_typicalForbiddenTags

Typical forbidden tags.


    protected
        array<string|int, mixed>
    $_typicalForbiddenTags
     = array()

$_xmlSortPropertiesValues

Sort properties values in XML


    protected
        mixed
    $_xmlSortPropertiesValues
     = \TRUE

__call()

Triggered when invoking inaccessible methods in an object context


    public
                    __call(string $name, array<string|int, mixed> $arguments) : mixed

Parameters

$name : string: method name
$arguments : array<string|int, mixed>: arguments

__construct()

Constructor.


    public
                    __construct([int $id = NULL ]) : mixed

Parameters

$id : int = NULL: entity ID

add()

Add related object. If main object does not save, it will save.


    public
                    add(Core_ORM $model[, string $relation = NULL ]) : self

Parameters

$model : Core_ORM
$relation : string = NULL

Return values

self

addAllowedTag()

Add tag to allowed tags list


    public
                    addAllowedTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

addAllowedTags()

Add tags to allowed tags list


    public
                    addAllowedTags(array<string|int, mixed> $aTags) : self

Parameters

$aTags : array<string|int, mixed>: array of tags

Return values

self

addAttribute()

Add entity attribute


    public
                    addAttribute(string $name, string $value) : self

Parameters

$name : string
$value : string

Return values

self

addCml()

Add order CommerceML


    public
                    addCml(Core_SimpleXMLElement $oXml) : mixed

Parameters

$oXml : Core_SimpleXMLElement

addEntities()

Add children entities


    public
                    addEntities(array<string|int, mixed> $aChildrenEntities) : self

Parameters

$aChildrenEntities : array<string|int, mixed>

Return values

self

addEntity()

Add a children entity


    public
                    addEntity(Core_Entity $oChildrenEntity) : self

Parameters

$oChildrenEntity : Core_Entity

Return values

self

addForbiddenTag()

Add tag to forbidden tags list


    public
                    addForbiddenTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

addForbiddenTags()

Add tags to forbidden tags list


    public
                    addForbiddenTags(array<string|int, mixed> $aTags) : self

Parameters

$aTags : array<string|int, mixed>: array of tags

Return values

self

addPurchaseDiscount()

Add discounts to the shop_order


    public
                    addPurchaseDiscount(array<string|int, mixed> $aOptions) : self

Parameters

$aOptions : array<string|int, mixed>: array('amount' => $amount, 'quantity' => $quantity, 'prices' => $aDiscountPrices, 'applyDiscounts' => TRUE, 'applyDiscountCards' => TRUE)

Return values

self

addXmlTag()

Add external tag for entity


    public
                    addXmlTag(string $tagName, string $tagValue[, array<string|int, mixed> $attributes = array() ]) : self

Parameters

$tagName : string: tag name
$tagValue : string: tag value
$attributes : array<string|int, mixed> = array(): attributes

Return values

self

applyMarksDeleted()

Apply markDeleted flag if is set


    public
                    applyMarksDeleted() : self

Return values

self

backupRevision()

Backup revision


    public
                    backupRevision() : self

Return values

self

cancel()

Cancel the order


    public
                    cancel() : self

Return values

self

cancelPaid()

Cancel payment


    public
                    cancelPaid() : self

Return values

self

changeCopiedName()

Set if change copied name is necessary


    public
                    changeCopiedName(bool $changeCopiedName) : self

Parameters

$changeCopiedName : bool: mode

Return values

self

changed()

Check model has been changed.


    public
                    changed() : bool

Return values

bool

changeStatusCanceled()

Change cancel on opposite


    public
                    changeStatusCanceled() : self

Return values

self

changeStatusPaid()

Change cancel on opposite


    public
                    changeStatusPaid() : self

Return values

self

changeStatusPosted()

Change posted


    public
                    changeStatusPosted() : self

Return values

self

check()

Check model values. If model has incorrect value, one will correct or call exception.


    public
                    check([bool $exception = FALSE ]) : self


$object = Core_ORM::factory('Book', 1);
$object->value = 123;
$object->check(TRUE)->save();

Parameters

$exception : bool = FALSE: Call exception (TRUE) or correct value (FALSE). Default FALSE.

Return values

self

checkShopOrderItemStatuses()


    public
                    checkShopOrderItemStatuses() : mixed

checkShopOrderStatusDeadline()

Check shop order status deadline


    public
                    checkShopOrderStatusDeadline() : self

Return values

self

chunk()

Retrieve a small chunk and feeds each one into $callback for processing. It stops looping when $callback returns FALSE


    public
                    chunk(int $count, callable $callback[, bool $bCache = TRUE ]) : bool

Parameters

$count : int: chunk size
$callback : callable
$bCache : bool = TRUE: use cache

Return values

bool

clear()

Clear object


    public
                    clear() : self

Return values

self

clearEntities()

Clear enities


    public
                    clearEntities() : self

Return values

self

clearEntitiesAfterGetXml()

Clear all entities after XML generation


    public
                    clearEntitiesAfterGetXml([bool $clear = TRUE ]) : self

Parameters

$clear : bool = TRUE: mode

Return values

self

clearXmlTags()

Clear external XML tags for entity.


    public
                    clearXmlTags() : mixed

commentsActivity()

Set comments filter rule


    public
                    commentsActivity([string $commentsActivity = 'active' ]) : self

Parameters

$commentsActivity : string = 'active': (active|inactive|all)

Return values

self

companyBadge()

Backend badge


    public
                    companyBadge(Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller) : string

Parameters

$oAdmin_Form_Field : Admin_Form_Field
$oAdmin_Form_Controller : Admin_Form_Controller

Return values

string

copy()

Copy object


    public
                    copy() : Core_Entity

Return values

Core_Entity

create()

Insert new object data into database


    public
                    create() : self

Return values

self

createDir()

Create directory for item


    public
                    createDir() : self

Return values

self

createInvoice()

Generate invoice by invoice_template or set invoice like id


    public
                    createInvoice() : self

Return values

self

date()


    public
                    date() : mixed

delete()

Delete object from database


    public
                    delete([mixed $primaryKey = NULL ]) : Core_Entity

Parameters

$primaryKey : mixed = NULL: primary key for deleting object

Return values

Core_Entity

deleteAll()

Delete all object


    public
                    deleteAll([bool $bCache = TRUE ][, int $limit = 100 ]) : self

Parameters

$bCache : bool = TRUE: use cache
$limit : int = 100: default 100 Core_ORM::factory('Book')->Comments->deleteAll();

Return values

self

deleteReservedItems()

Delete reserved items for order


    public
                    deleteReservedItems() : self

Return values

self

factory()

Create and return an object of model


    public
            static        factory( $modelName[,  $primaryKey = NULL ]) : mixed

Parameters

$modelName :: Model name
$primaryKey : = NULL: Primary key

find()

Find object in database and load one. Use clear() before find() with conditions!


    public
                    find([mixed $primaryKey = NULL ][, bool $bCache = TRUE ]) : self

Parameters

$primaryKey : mixed = NULL: default NULL
$bCache : bool = TRUE: use cache // Find an object and load (without lazy load) // If an object is not found, primary key sets NULL $oBook = Core_ORM::factory('Book')->find(1);

Return values

self

findAll()

Find all objects


    public
                    findAll([bool $bCache = TRUE ]) : array<string|int, mixed>

Parameters

$bCache : bool = TRUE: use cache, default TRUE // Find objects $aBooks = Core_ORM::factory('Book')->findAll(); foreach ($aBooks as $oBook) { var_dump($oBook->id); }

Return values

array<string|int, mixed>

getAllowedTags()

Get allowed tags list


    public
                    getAllowedTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

getAmount()

Get amount of order


    public
                    getAmount() : float

Return values

float

getByShopId()

Get orders by shop id


    public
                    getByShopId(int $shop_id) : array<string|int, mixed>

Parameters

$shop_id : int: shop id

Return values

array<string|int, mixed>

getChangedData()

Get changed columns with values


    public
                    getChangedData() : array<string|int, mixed>

Return values

array<string|int, mixed>

getClassName()

Get Model CallsName


    public
            static        getClassName( $modelName) : string

Parameters

$modelName :: Model name

Return values

string

getCount()

Get count object


    public
                    getCount([bool $bCache = TRUE ][, string $fieldName = '*' ][, bool $distinct = FALSE ]) : int|false

Parameters

$bCache : bool = TRUE: use cache, default TRUE
$fieldName : string = '*': default '*'
$distinct : bool = FALSE: default FALSE

Return values

int|false —


$iCount = Core_ORM::factory('Book')->getCount();
var_dump($iCount);

getCustomerName()


    public
                    getCustomerName() : mixed

getDatabaseDriver()

Get name of Database Driver


    public
            static        getDatabaseDriver() : string

Return values

string

getDataValues()

Get dataValues


    public
                    getDataValues() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntities()

Get children entities


    public
                    getEntities() : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntityType()

Get Entity Type


    public
                    getEntityType() : int

Return values

int

getFieldIDs()

Get visible field's IDs


    public
                    getFieldIDs() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFields()

Get field's values


    public
                    getFields() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFirst()

Get fist entity, ordered by primary key


    public
                    getFirst([bool $bCache = TRUE ]) : null|Core_ORM

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

null|Core_ORM —


$mObject = Core_ORM::factory('Book')->getFirst();
if (!is_null($mObject))
{
	echo $mObject;
}

getForbiddenTags()

Get forbidden tags list


    public
                    getForbiddenTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

getFullAddress()


    public
                    getFullAddress() : mixed

getLast()

Get last entity, ordered by primary key


    public
                    getLast([bool $bCache = TRUE ]) : null|Core_ORM

Parameters

$bCache : bool = TRUE: use cache, default TRUE

Return values

null|Core_ORM —


$mObject = Core_ORM::factory('Book')->getLast();
if (!is_null($mObject))
{
	echo $mObject;
}

getMarksDeleted()

Get column name for marks deleted


    public
                    getMarksDeleted() : string

Return values

string

getModelName()

Get model name, e.g. 'book' for 'Book_Model'


    public
                    getModelName() : string

Return values

string

getName()

Get entity name


    public
                    getName() : string

Return values

string

getNameColumn()

Get Name Column


    public
                    getNameColumn() : string

Return values

string

getOrderHref()

Get item href


    public
                    getOrderHref() : string

Return values

string

getOrderPath()

Get item path include CMS_FOLDER


    public
                    getOrderPath() : string

Return values

string

getPrimaryKey()

Get primary key value


    public
                    getPrimaryKey() : mixed

getPrimaryKeyName()

Get primary key name


    public
                    getPrimaryKeyName() : string

Return values

string

getPrintlayoutReplaces()

Get printlayout replaces


    public
                    getPrintlayoutReplaces() : array<string|int, mixed>

Return values

array<string|int, mixed>

getPropertyValues()

Values of all properties of item Значения всех свойств товара


    public
                    getPropertyValues([bool $bCache = TRUE ][, array<string|int, mixed> $aPropertiesId = array() ][, bool $bSorting = FALSE ]) : array<string|int, mixed>

Parameters

$bCache : bool = TRUE: cache mode status
$aPropertiesId : array<string|int, mixed> = array(): array of properties' IDs
$bSorting : bool = FALSE: sort results, default FALSE

Return values

array<string|int, mixed> —

Property_Value

getQuantity()

Get quantity of items in an order


    public
                    getQuantity() : float

Return values

float

getRelatedSite()

Get Related Site


    public
                    getRelatedSite() : Site_Model|null

Return values

Site_Model|null

getRelations()

Get $this->_relations


    public
                    getRelations() : array<string|int, mixed>

Return values

array<string|int, mixed>

getResponsibleUsers()

Get responsible users


    public
                    getResponsibleUsers() : array<string|int, mixed>

Return values

array<string|int, mixed>

getStdObject()

Get stdObject for entity and children entities


    public
                    getStdObject([mixed $attributePrefix = '_' ]) : stdObject

Parameters

$attributePrefix : mixed = '_'

Return values

stdObject

getSum()

Get sum of order


    public
                    getSum() : float

Return values

float

getTableColumns()

Get tableColumns


    public
                    getTableColumns() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTableColums()

Get table columns. Fix wrong method name


    public
                    getTableColums() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTableName()

Get table name


    public
                    getTableName() : string

Return values

string

getTextPropertyValue()

Get text values of property


    public
                    getTextPropertyValue(int $property_id[, string $separator = ', ' ]) : string

Parameters

$property_id : int: property ID
$separator : string = ', '

Return values

string

getTrashDescription()

Get entity description


    public
                    getTrashDescription() : string

Return values

string

getWeight()

Get order weight


    public
                    getWeight() : float

Return values

float

getXml()

Get XML for entity and children entities


    public
                    getXml() : string

Return values

string

getXmlTagName()

Get tag name


    public
                    getXmlTagName() : string

Return values

string

getXmlTags()

Get external XML tags for entity.


    public
                    getXmlTags() : array<string|int, mixed>

Return values

array<string|int, mixed>

historyPushCanceled()

Push canceled history


    public
                    historyPushCanceled() : self

Return values

self

historyPushChangeStatus()

Push change status history


    public
                    historyPushChangeStatus() : self

Return values

self

historyPushChangeUser()

Push change status history


    public
                    historyPushChangeUser() : self

Return values

self

historyPushPaid()

Push paid history


    public
                    historyPushPaid() : self

Return values

self

historyPushPosted()

Push posted history


    public
                    historyPushPosted() : self

Return values

self

isCallable()

Verify that the contents of a variable can be called as a function


    public
                    isCallable(string $methodName) : bool

Parameters

$methodName : string: method name

Return values

bool

isEmptyPrimaryKey()

Check is primary key NULL


    public
                    isEmptyPrimaryKey() : bool

Return values

bool

markDeleted()

Mark entity as deleted


    public
                    markDeleted() : Core_Entity

Return values

Core_Entity

merge()

Merge list item with another one


    public
                    merge(Shop_Order_Model $oShop_Order) : self

Parameters

$oShop_Order : Shop_Order_Model

Return values

self

notifyBotsChangeStatus()

Notify Bots


    public
                    notifyBotsChangeStatus() : self

Return values

self

order_items()


    public
                    order_items(mixed $oAdmin_Form_Field, mixed $oAdmin_Form_Controller) : mixed

Parameters

$oAdmin_Form_Field : mixed
$oAdmin_Form_Controller : mixed

order_itemsBadge()

Backend badge


    public
                    order_itemsBadge(Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller) : string

Parameters

$oAdmin_Form_Field : Admin_Form_Field
$oAdmin_Form_Controller : Admin_Form_Controller

Return values

string

orderPopover()

Get Popover Content


    public
                    orderPopover() : string

Return values

string

ordersCurrentMonth()

Get the number of orders for the current month


    public
                    ordersCurrentMonth() : int

Return values

int

ordersCurrentYear()

Get the number of orders for the current year


    public
                    ordersCurrentYear() : int

Return values

int

ordersToday()

Get the number of orders for today


    public
                    ordersToday() : int

Return values

int

paid()

Pay the order


    public
                    paid() : self

Return values

self

post()

Add entries


    public
                    post() : self

Return values

self

propertyValue()

Get property value for SEO-templates


    public
                    propertyValue(int $property_id[, strint $format = '%2$s' ][, string $separator = ', ' ]) : string

Parameters

$property_id : int: Property ID
$format : strint = '%2$s': string format, e.g. '%s: %s'. %1$s - Property Name, %2$s - List of Values
$separator : string = ', ': separator

Return values

string

queryBuilder()

Get query builder for select


    public
                    queryBuilder() : Core_QueryBuilder_Select

Return values

Core_QueryBuilder_Select

recalcDelivery()

Recalc delivery price by delivery conditions


    public
                    recalcDelivery() : bool

Return values

bool

remove()

Remove related object. If main object does not save, it will save.


    public
                    remove(Core_ORM $model[, string $relation = NULL ]) : self

Parameters

$model : Core_ORM
$relation : string = NULL

Return values

self

removeAllowedTag()

Remove tag from allowed tags list


    public
                    removeAllowedTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

removeForbiddenTag()

Remove tag from forbidden tags list


    public
                    removeForbiddenTag(string $tag) : self

Parameters

$tag : string: tag

Return values

self

reserveItems()

Reserve items for order


    public
                    reserveItems() : self

Return values

self

reviewsBadge()

Backend badge


    public
                    reviewsBadge(Admin_Form_Field $oAdmin_Form_Field, Admin_Form_Controller $oAdmin_Form_Controller) : string

Parameters

$oAdmin_Form_Field : Admin_Form_Field
$oAdmin_Form_Controller : Admin_Form_Controller

Return values

string

rollbackRevision()

Rollback Revision


    public
                    rollbackRevision(int $revision_id) : self

Parameters

$revision_id : int: Revision ID

Return values

self

save()

Save object. Uses self::update() or self::create()


    public
                    save() : self

Return values

self

sendMail()

Send order e-mails


    public
                    sendMail() : self

Return values

self

setCheck()

Set _check flag


    public
                    setCheck(bool $check) : self

Parameters

$check : bool: mode

Return values

self

setComments()

Set array of comments for getXml()


    public
                    setComments(array<string|int, mixed> $aComments) : self

Parameters

$aComments : array<string|int, mixed>

Return values

self

setDatabaseDriver()

Set name of Database Driver


    public
            static        setDatabaseDriver(string $name) : mixed

Parameters

$name : string: driver's name

setMarksDeleted()

Set column name for marks deleted


    public
                    setMarksDeleted([mixed $marksDeleted = 'deleted' ]) : self

Parameters

$marksDeleted : mixed = 'deleted'

Return values

self

setRelations()

Set $this->_relations


    public
                    setRelations(array<string|int, mixed> $relations) : self

Parameters

$relations : array<string|int, mixed>: Array with new relations

Return values

self

setXmlTagName()

Set name of XML node


    public
                    setXmlTagName(string $tagName) : self

Parameters

$tagName : string: new tag name for node

Return values

self

shop_order_status_idBackend()

Backend callback method


    public
                    shop_order_status_idBackend(mixed $oAdmin_Form_Field, mixed $oAdmin_Form_Controller) : string

Parameters

$oAdmin_Form_Field : mixed
$oAdmin_Form_Controller : mixed

Return values

string

showXmlCommentProperties()

Show shop order properties in XML


    public
                    showXmlCommentProperties([bool $showXmlCommentProperties = TRUE ]) : self

Parameters

$showXmlCommentProperties : bool = TRUE: mode

Return values

self

showXmlComments()

Add comments XML to item


    public
                    showXmlComments([bool $showXmlComments = TRUE ]) : self

Parameters

$showXmlComments : bool = TRUE: mode

Return values

self

showXmlCommentsRating()

Add Comments Rating XML to item


    public
                    showXmlCommentsRating([mixed $showXmlCommentsRating = TRUE ]) : self

Parameters

$showXmlCommentsRating : mixed = TRUE

Return values

self

showXmlCountry()

Show country in XML


    public
                    showXmlCountry([bool $showXmlCountry = TRUE ]) : self

Parameters

$showXmlCountry : bool = TRUE

Return values

self

showXmlCurrency()

Show currency in XML


    public
                    showXmlCurrency([bool $showXmlCurrency = TRUE ]) : self

Parameters

$showXmlCurrency : bool = TRUE

Return values

self

showXmlDelivery()

Show delivery in XML


    public
                    showXmlDelivery([bool $showXmlDelivery = TRUE ]) : self

Parameters

$showXmlDelivery : bool = TRUE

Return values

self

showXmlItems()

Show items in XML


    public
                    showXmlItems([mixed $showXmlItems = TRUE ]) : self

Parameters

$showXmlItems : mixed = TRUE: TRUE|FALSE|'not canceled'

Return values

self

showXmlOrderStatus()

Show order's status in XML


    public
                    showXmlOrderStatus([bool $showXmlOrderStatus = TRUE ]) : self

Parameters

$showXmlOrderStatus : bool = TRUE

Return values

self

showXmlPaymentSystem()

Show payment system in XML


    public
                    showXmlPaymentSystem([bool $showXmlPaymentSystem = TRUE ]) : self

Parameters

$showXmlPaymentSystem : bool = TRUE

Return values

self

showXmlProperties()

Show properties in XML


    public
                    showXmlProperties([mixed $showXmlProperties = TRUE ][, mixed $xmlSortPropertiesValues = TRUE ]) : self

Parameters

$showXmlProperties : mixed = TRUE: array of allowed properties ID or boolean
$xmlSortPropertiesValues : mixed = TRUE

Return values

self

showXmlSiteuser()

Show siteuser in XML


    public
                    showXmlSiteuser([bool $showXmlSiteuser = TRUE ]) : self

Parameters

$showXmlSiteuser : bool = TRUE

Return values

self

smallAvatarBackend()


    public
                    smallAvatarBackend() : mixed

sum()

Get order sum with currency name


    public
                    sum() : string

Return values

string

toArray()

Convert Object to Array


    public
                    toArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

uncancel()

Uncancel the order


    public
                    uncancel() : self

Return values

self

undelete()

Turn off deleted status


    public
                    undelete() : self

Return values

self

unpost()

Remove all shop warehouse entries by document


    public
                    unpost() : self

Return values

self

update()

Update object data into database


    public
                    update() : self

Return values

self

weightBackend()

Backend callback method


    public
                    weightBackend() : string

Return values

string

_addComments()

Add comments into object XML


    protected
                    _addComments(int $parent_id, Core_Entity $parentObject) : self

Parameters

$parent_id : int: parent comment id
$parentObject : Core_Entity: object

Return values

self

_createNotification()

Create notification for subscribers


    protected
                    _createNotification() : self

Return values

self

_deleteDigitalItems()

Delete digital items


    protected
                    _deleteDigitalItems() : self

Return values

self

_getCopiedName()

Get the name of a new copied object


    protected
                    _getCopiedName() : mixed

_isTagAvailable()

Is $tagName Available


    protected
                    _isTagAvailable( $tagName) : bool

Parameters

$tagName :: Tag Name

Return values

bool

_paidShopDiscountcard()


    protected
                    _paidShopDiscountcard() : mixed

_paidTransaction()

Списание или возврат товара на склад, начисление и стронирование операций по лицевому счету


    protected
                    _paidTransaction() : self

Return values

self

_prepareData()

Prepare entity and children entities


    protected
                    _prepareData() : self

Return values

self

_preparePropertyValue()

Prepare Property Value


    protected
                    _preparePropertyValue(Property_Value_Model $oProperty_Value) : mixed

Parameters

$oProperty_Value : Property_Value_Model

getDatabase()

Get Database


    protected
                    getDatabase() : Core_DataBase

Return values

Core_DataBase

Shop_Order_Model extends Core_Entity in package HostCMS Shop

Tags

Table of Contents

Constants

Properties

Methods

Constants

TYPE

Properties

$config

$order_items

$reviews

$rollback

$_aComments

$_allowedTags

$_attributes

$_belongsTo

$_changeCopiedName

$_changedColumns

$_commentsActivity

$_dataValues

$_forbiddenTags

$_hasMany

$_hasOne

$_hasRevisions

$_marksDeleted

$_modelColumns

$_modelName

$_nameColumn

$_oShop_Discountcard

$_preloadValues

$_primaryKey

$_propertyValues

$_queryBuilder

$_shortcodeTags

$_showXmlCommentProperties

$_showXmlComments

$_showXmlCommentsRating

$_showXmlCountry

$_showXmlCurrency

$_showXmlDelivery

$_showXmlItems

$_showXmlOrderStatus

$_showXmlPaymentSystem

$_showXmlProperties

$_showXmlSiteuser

$_skipColumns

$_sorting

$_tableColumns

$_tableName

$_typicalForbiddenTags

$_xmlSortPropertiesValues

Methods

__call()

Parameters

__construct()

Parameters

add()

Parameters

Tags

Return values

addAllowedTag()

Parameters

Return values

addAllowedTags()

Parameters

Return values

addAttribute()

Parameters

Return values

addCml()

Parameters

Tags

addEntities()

Parameters

Return values

addEntity()

Parameters

Return values

addForbiddenTag()

Shop_Order_Model extends Core_Entity
in package

HostCMS

Shop