Exponent v2.4.3
Back to top  

order

Extends \expRecord

This is the class expRecord

subpackage

Models
package

Modules

Methods

__construct

__construct(null $params = null, boolean $get_assoc = true, boolean $get_attached = true)
inherited
Throws
\ReflectionException

Arguments

$params

null

$get_assoc

boolean

$get_attached

boolean

after creating item

afterCreate()
inherited

is run after deleting item, should delete associated items here if needed

afterDelete()
inherited

after saving item

afterSave()
inherited

after updating item

afterUpdate()
inherited

after validating item

afterValidation()
inherited

after validating item during creation

afterValidationOnCreate()
inherited

after validating item during update

afterValidationOnUpdate()
inherited

get objects this item belongs to ??

associateWith( $datatype,  $id)
inherited

Type of associations has_and_belongs_to_many

Arguments

$datatype

$id

attach to item

attachItem( $item, string $subtype = '', boolean $replace = true) : boolean
inherited

Arguments

$item

$subtype

string

$replace

boolean

Response

boolean

before creating item

beforeCreate()
inherited

is run before deleting item

beforeDelete()
inherited

before saving item

beforeSave()
inherited

before updating item

beforeUpdate()
inherited

before validating item

beforeValidation()
inherited

before validating item during creation

beforeValidationOnCreate()
inherited

before validating item during update

beforeValidationOnUpdate()
inherited

Adds table fields as class properties to current "record" class.

build(mixed $params = array())
inherited

Loads Table schema data and creates new class properties based upon the fields in given table.

Additionally, if a record ID is given, that record is pulled and field values are also populated into class properties.

category

db_record
uses

Builds a data definition from existing table.
requires

$db
access

protected
final
PHPUnit

Not Defined
global

object $db

Arguments

$params

mixed

array or Object for table selection

calculateGrandTotal

calculateGrandTotal()

check for what objects may be attached

checkForAttachableItems( $params) : boolean
inherited

Arguments

$params

Response

boolean

cleanOrderitems

cleanOrderitems()

countOrderitemsByShippingmethod

countOrderitemsByShippingmethod( $shippingmethod_id)

Arguments

$shippingmethod_id

delete item

delete(string $where = '') : boolean
inherited

Arguments

$where

string

Response

boolean

find an item or items

find(string $range = 'all', null $where = null, null $order = null, null $limit = null, integer $limitstart, boolean $get_assoc = true, boolean $get_attached = true, array $except = array(), boolean $cascade_except = false) : array|integer
inherited

Arguments

$range

string

$where

null

$order

null

$limit

null

$limitstart

integer

$get_assoc

boolean

$get_attached

boolean

$except

array

$cascade_except

boolean

Response

array|integer

find an item by column

findBy( $column,  $value, boolean $get_assoc = true, boolean $get_attached = true, array $except = array(), boolean $cascade_except = false) : array
inherited

Arguments

$column

$value

$get_assoc

boolean

$get_attached

boolean

$except

array

$cascade_except

boolean

Response

array

find a value(s) by column

findValue(string $range = 'all', string $column, string $where = null, string $order = null, boolean $distinct = false) : array|boolean
inherited

Arguments

$range

string

$column

string

$where

string

$order

string

$distinct

boolean

Response

array|boolean

this function finds models that have this attachable item attached

findWhereAttachedTo( $content_type) : array
inherited

Arguments

$content_type

Response

array

Determine if the order has any item with forced shipping

forcedShipping() : boolean

Response

boolean

get item's associated objects

getAssociatedObjects(null $obj = null) : null
inherited

Type of associations has_one has_many has_and_belongs_to_many

Arguments

$obj

null

Response

null

gets associated objects for this model

getAssociatedObjectsForThisModel(array $except = array(), boolean $cascade_except = false)
inherited

Type of associations has_extended_fields has_one has_many has_many_self has_and_belongs_to_many has_and_belongs_to_self

Arguments

$except

array

$cascade_except

boolean

get attached objects for this item

getAttachableItems()
inherited

used for import/export

getAttachableItemTables() : array
inherited

Response

array

getBillingMethods

getBillingMethods()

getCartTotal

getCartTotal()

getCurrentBillingMethod

getCurrentBillingMethod()

getCurrentShippingMethod

getCurrentShippingMethod()

getDefaultOrderStatus

getDefaultOrderStatus()
static

getDefaultOrderType

getDefaultOrderType()
static

Update order object with forced shipping details

getForcedShippingMethod() : \shippingmethod

Response

\shippingmethod

Return next invoice number and advance counter

getInvoiceNumber(boolean $increment = true) : mixed|null

Arguments

$increment

boolean

Response

mixed|null

getOrderDiscounts

getOrderDiscounts()

getOrderitemsByShippingmethod

getOrderitemsByShippingmethod( $shippingmethod_id)

Arguments

$shippingmethod_id

Return number of orders in requested state

getOrdersCount(string $state = 'new') : integer
static

Arguments

$state

string

Response

integer

getOrderStatuses

getOrderStatuses()
static

getOrderType

getOrderType()

getOrderTypes

getOrderTypes()
static

return the item poster

getPoster(null $display = null) : null|string
inherited

Arguments

$display

null

Response

null|string

getSalesReps

getSalesReps()
static

getShippingMethods

getShippingMethods()

getStatus

getStatus()

return the item timestamp

getTimestamp(integer $type) : mixed
inherited

Arguments

$type

integer

Response

mixed

getUserCart

getUserCart()
static

isItemInCart

isItemInCart( $id,  $type,  $orderitem_id = null)

Arguments

$id

$type

$orderitem_id

is model content searchable?

isSearchable() : boolean
inherited static

Response

boolean

create a many to many table relationship

makeManyToManyTablename( $assoc_table) : string
inherited

Arguments

$assoc_table

Response

string

make an sef_url for item

makeSefUrl()
inherited

mergeReturnCount

mergeReturnCount( $merge_array = array())

Arguments

$merge_array

name of module for backwards compat with old modules

name() : string
inherited

Response

string

re-construct the item from the database

refresh() : boolean
inherited
Throws
\ReflectionException

Response

boolean

rerank items

rerank( $direction, string $where = '')
inherited

Arguments

$direction

$where

string

save item

save(boolean $validate = false, boolean $force_no_revisions = false)
inherited

Arguments

$validate

boolean

$force_no_revisions

boolean

save associated objects

saveAssociatedObjects()
inherited

Type of associations has_one

setCartCookie

setCartCookie( $cart)
static

Arguments

$cart

setOrderStatus

setOrderStatus( $params)

Arguments

$params

setOrderType

setOrderType( $params)

Arguments

$params

setReferencingIds

setReferencingIds()

setReturnCount

setReturnCount( $orig_referrer,  $merge_array = array())

Arguments

$orig_referrer

$merge_array

sortStatuses

sortStatuses( $a,  $b)
static

Arguments

$a

$b

update item

update(array|object $params = array())
inherited

Arguments

$params

array|object

validate item sef_url

validate() : boolean
inherited

Response

boolean

validateDiscounts

validateDiscounts( $redirectOnFailureTo = array('controller' => 'cart', 'action' => 'show'))

Arguments

$redirectOnFailureTo

Properties

table

table :

Type(s)

has_many

has_many :
inherited

Type(s)

has_one

has_one :
inherited

Type(s)

get_assoc_for

get_assoc_for :
inherited

Type(s)

total

total :

Type(s)

shippingmethods

shippingmethods :

Type(s)

orderitem

orderitem :

Type(s)

shipping_required

shipping_required :

Type(s)

billing_required

billing_required :

Type(s)

product_discounts

product_discounts :

Type(s)

cart_discounts

cart_discounts :

Type(s)

applied_discounts

applied_discounts :

Type(s)

promos

promos :

Type(s)

taxzones

taxzones :

Type(s)

forced_shipping

forced_shipping :

Type(s)

product_forcing_shipping

product_forcing_shipping :

Type(s)

shipping_taxed

shipping_taxed :

Type(s)

classinfo

classinfo :
inherited

Type(s)

classname

classname :
inherited

Type(s)

tablename

tablename :
inherited

Type(s)

identifier

identifier :
inherited

Type(s)

rank_by_field

rank_by_field :
inherited

Type(s)

grouping_sql

grouping_sql :
inherited

Type(s)

has_extended_fields

has_extended_fields :
inherited

Type(s)

has_many_self

has_many_self :
inherited

Type(s)

has_and_belongs_to_many

has_and_belongs_to_many :
inherited

Type(s)

has_and_belongs_to_self

has_and_belongs_to_self :
inherited

Type(s)

default_sort_field

default_sort_field :
inherited

Type(s)

default_sort_direction

default_sort_direction :
inherited

Type(s)

attachable_item_types

attachable_item_types :
inherited

Type(s)

attachable_items_to_save

attachable_items_to_save :
inherited

Type(s)

get_attachable_for

get_attachable_for :
inherited

Type(s)

validate

validate :
inherited

Type(s)

do_not_validate

do_not_validate :
inherited

Type(s)

supports_revisions

supports_revisions :
inherited

Type(s)

needs_approval

needs_approval :
inherited

Type(s)