Exponent v2.4.3
Back to top  

orderController

Extends \expController

This is the class expController

subpackage

Controllers
package

Modules

Methods

__construct

__construct(null $src = null, array $params = array())
inherited
Throws
\ReflectionException

Arguments

$src

null

$params

array

add_order_item

add_order_item()

add module item or all items to search index

addContentToSearch() : integer
inherited
Throws
\ReflectionException

Response

integer

number of items added to search index

The aggregateWhereClause function creates a sql where clause which also includes aggregated module content

aggregateWhereClause(string $type = '') : string
inherited

Arguments

$type

string

Response

string

approve module item

approve()
inherited

author of module

author() : string
inherited static

Response

string

can this module export data?

canExportData() : boolean
inherited static

Response

boolean

can this module import data?

canImportData() : boolean
inherited static

Response

boolean

captureAuthorization

captureAuthorization()

return all categories used by module's items

categories()
inherited

checkPermissions

checkPermissions( $permission,  $location)
inherited static

Arguments

$permission

$location

clearCart

clearCart()

clearCartCookie

clearCartCookie()
static

return all comments used by module's items

comments()
inherited

Configure the module

configure()
inherited

create an item in this module

create()
inherited
deprecated

in favor of edit w/o id param

create_new_order

create_new_order()

createReferenceOrder

createReferenceOrder()

creditTransaction

creditTransaction()

delete item in module

delete()
inherited

delete module and all its items for backwards compat with old modules

delete_In( $loc)
inherited

Arguments

$loc

delete module, config, and all its items

delete_instance(boolean $loc = false)
inherited
Throws
\ReflectionException

Arguments

$loc

boolean

delete_label

delete_label()

delete_order_item

delete_order_item()

delete_pickup

delete_pickup()

remove all module items from search index

delete_search()
inherited

description of module

description() : string
inherited static

Response

string

name of module

displayname() : string
inherited static

Response

string

download_label

download_label()

download a file attached to item

downloadfile()
inherited

edit item in module, also used to copy items

edit()
inherited

edit_address

edit_address()

edit_invoice_id

edit_invoice_id()

edit_label

edit_label()

edit_order_item

edit_order_item()

edit_parcel

edit_parcel()

edit_payment_info

edit_payment_info()

edit_pickup

edit_pickup()

edit_pickup2

edit_pickup2()

edit_shipping_method

edit_shipping_method()

edit_totals

edit_totals()

email

email()

emailCustomer

emailCustomer()

get the model(s) associated with this module

getModels() : array
inherited

Response

array

For server-side population of DataTables

getOrdersByJSON()

getPDF

getPDF( $orders = null)

Arguments

$orders

get the module's items in an rss feed format

getRSSContent(integer $limit) : array
inherited

this function is very general and will most of the time need to be overwritten and customized

Arguments

$limit

integer

Response

array

hasContent

hasContent()
inherited static

does module have sources available? or does it treat content globally

hasSources() : boolean
inherited static

Response

boolean

hasViews

hasViews()
inherited static

is module content searchable? should it be added to search index?

isSearchable() : boolean
inherited static

Response

boolean

display module management view

manage()
inherited

rerank module items, called from ddrerank

manage_ranks()
inherited

merge/move aggregated item into this module

merge()
inherited

Returns Facebook og: meta data

meta_fb( $request,  $object,  $canonical) : array
inherited

Arguments

$request

$object

$canonical

Response

array

Returns rich snippet PageMap meta data

meta_rich( $request,  $object) : null
inherited

Arguments

$request

$object

Response

null

Returns Twitter twitter: meta data

meta_tw( $request,  $object,  $canonical) : array
inherited

Arguments

$request

$object

$canonical

Response

array

get the metainfo for this module

metainfo() : array
inherited

Response

array

glue to make the view template aware of the module

moduleSelfAwareness()
inherited
deprecated

myOrder

myOrder()

name of module for backwards compat with old modules

name() : string
inherited

Response

string

ordersbyuser

ordersbyuser()

permission functions to aggregate a module's visible permissions based on add/remove permissions

permissions() : array
inherited

Response

array

permission functions to aggregate a module's permissions based on add/remove and manage permissions

permissions_all() : array
inherited

Response

array

quickfinder

quickfinder()

requiresConfiguration

requiresConfiguration()
inherited static

rerank items in model

rerank()
inherited

returnFile

returnFile( $file,  $name,  $mime_type = '')

Arguments

$file

$name

$mime_type

method to display an rss feed from this module

rss()
inherited

save_address

save_address()

save_invoice_id

save_invoice_id()

save_label

save_label()

save_new_order

save_new_order()

save_new_order_item

save_new_order_item()

save_order_item

save_order_item()

save_parcel

save_parcel()

save_payment_info

save_payment_info()

save_pickup

save_pickup()

save_reference_order

save_reference_order()

save_shipping_method

save_shipping_method()

save_totals

save_totals()

save module configuration

saveconfig()
inherited

AJAX search for internal (addressController) addresses

search()

Ajax search for external addresses

search_external()

category of items searched in the module

searchCategory() : string
inherited

Response

string

additional check for display of search hit

searchHit( $record) : boolean
inherited static

Arguments

$record

Response

boolean

type of items searched in the module

searchName() : string
inherited

Response

string

set_order_type

set_order_type()

Change order status and email notification if necessary

setStatus()

default view for individual item

show()
inherited

default module view method for all items

showall()
inherited

action specific metainfo

showall_by_date_meta( $request) : array
inherited

Arguments

$request

Response

array

default module view method for all items with a specific tag

showall_by_tags()
inherited

action specific metainfo

showall_by_tags_meta( $request) : array
inherited

Arguments

$request

Response

array

view items referenced by tags

showByTags()
inherited
deprecated

view the item by referring to its title

showByTitle()
inherited
deprecated

view a random item

showRandom()
inherited

does module support workflow?

supportsWorkflow() : boolean
inherited static

Response

boolean

return all tags used by module's items

tags()
inherited

update (save) item in module

update()
inherited

update_sales_reps

update_sales_reps()

update_shipping

update_shipping()

verifyAndRestoreCart

verifyAndRestoreCart()

verifyReturnShopper

verifyReturnShopper()

voidAuthorization

voidAuthorization()

Properties

manage_permissions

manage_permissions :
inherited

Type(s)

classname

classname :
inherited

Type(s)

baseclassname

baseclassname :
inherited

Type(s)

classinfo

classinfo :
inherited

Type(s)

basemodel_name

basemodel_name :
inherited

Type(s)

model_table

model_table :
inherited

Type(s)

useractions

useractions :
inherited

Type(s)

remove_configs

remove_configs :
inherited

Type(s)

permissions

permissions :
inherited

Type(s)

m_permissions

m_permissions :
inherited

Type(s)

remove_permissions

remove_permissions :
inherited

Type(s)

add_permissions

add_permissions :
inherited

Type(s)

filepath

filepath :
inherited

Type(s)

viewpath

viewpath :
inherited

Type(s)

relative_viewpath

relative_viewpath :
inherited

Type(s)

asset_path

asset_path :
inherited

Type(s)

config

config :
inherited

Type(s)

params

params :
inherited

Type(s)

loc

loc :
inherited

Type(s)

codequality

codequality :
inherited

Type(s)

rss_is_podcast

rss_is_podcast :
inherited

Type(s)