Exponent v2.7.2

orderController extends expController
in package

This is the class expController

Tags
subpackage

Controllers

Table of Contents

$asset_path  : mixed
$baseclassname  : mixed
$basemodel_name  : mixed
$classinfo  : mixed
$codequality  : mixed
$config  : mixed
$filepath  : mixed
$loc  : mixed
$model_table  : mixed
$params  : mixed
$relative_viewpath  : mixed
$remove_configs  : mixed
$requires_login  : mixed
$rss_is_podcast  : mixed
$useractions  : mixed
$viewpath  : mixed
$add_permissions  : mixed
$classname  : mixed
$m_permissions  : mixed
$manage_permissions  : mixed
$permissions  : mixed
$remove_permissions  : mixed
__construct()  : mixed
__get()  : null
Generic magic method
__isset()  : bool
Generic magic method
__set()  : mixed
Generic magic method We MUST create/set non-existing properties for Exponent code to work
__unset()  : mixed
Generic magic method
add_order_item()  : mixed
addContentToSearch()  : int
add module item or all items to search index
aggregateWhereClause()  : string
The aggregateWhereClause function creates a sql where clause which also includes aggregated module content
approve()  : mixed
approve module item
author()  : string
author of module
canExportData()  : bool
can this module export data?
canHandleEAAS()  : bool
can this module export EAAS data?
canImportData()  : bool
can this module import data?
captureAuthorization()  : mixed
categories()  : mixed
return all categories used by module's items
checkPermissions()  : mixed
clearCart()  : mixed
clearCartCookie()  : mixed
comments()  : mixed
return all comments used by module's items
configure()  : mixed
Configure the module
create()  : mixed
create an item in this module
create_new_order()  : mixed
createReferenceOrder()  : mixed
creditTransaction()  : mixed
delete()  : mixed
delete item in module
delete_In()  : mixed
delete module and all its items for backwards compat with old modules
delete_instance()  : mixed
delete module, config, and all its items
delete_label()  : mixed
delete_order_item()  : mixed
delete_pickup()  : mixed
delete_search()  : mixed
remove all module items from search index
description()  : string
description of module
displayname()  : string
name of module
download_label()  : mixed
downloadfile()  : mixed
download a file attached to item
eaasConfig()  : array<string|int, mixed>|bool
returns info about Config template standard location is a folder named 'eaas' in the module's view folder with a model_name template
eaasData()  : array<string|int, mixed>
returns module's EAAS data as an array of records
edit()  : mixed
edit item in module, also used to copy items
edit_address()  : mixed
edit_invoice_id()  : mixed
edit_label()  : mixed
edit_order_item()  : mixed
edit_parcel()  : mixed
edit_payment_info()  : mixed
edit_pickup()  : mixed
edit_pickup2()  : mixed
edit_shipping_method()  : mixed
edit_totals()  : mixed
email()  : mixed
emailCustomer()  : mixed
getInvoiceNumByJSON()  : mixed
For server-side re-population of DataTables
getModels()  : array<string|int, mixed>
get the model(s) associated with this module
getOrdersByJSON()  : mixed
For server-side population of DataTables
getPDF()  : mixed
getRSSContent()  : array<string|int, mixed>
get the module's items in an rss feed format
hasContent()  : bool
does module have content (stored items) available?
hasSources()  : bool
does module have sources available? or does it treat content globally
hasViews()  : bool
does module have views available?
isSearchable()  : bool
is module content searchable? should it be added to search index?
manage()  : mixed
display module management view
manage_ranks()  : mixed
rerank module items, called from ddrerank
merge()  : mixed
merge/move aggregated item into this module
meta_fb()  : array<string|int, mixed>
Returns Facebook og: meta data
meta_rich()  : null
Returns rich snippet PageMap meta data
meta_tw()  : array<string|int, mixed>
Returns Twitter twitter: meta data
metainfo()  : array<string|int, mixed>|bool
get the metainfo for this module
myOrder()  : mixed
name()  : string
name of module for backwards compat with old modules
ordersbyuser()  : mixed
permissions()  : array<string|int, mixed>
permission functions to aggregate a module's visible permissions based on add/remove permissions
permissions_all()  : array<string|int, mixed>
permission functions to aggregate a module's permissions based on add/remove and manage permissions
quickfinder()  : mixed
requiresConfiguration()  : bool
does this module require configuration?
rerank()  : mixed
rerank items in model
rss()  : mixed
method to display an rss feed from this module
save_address()  : mixed
save_invoice_id()  : mixed
save_label()  : mixed
save_new_order()  : mixed
save_new_order_item()  : mixed
save_order_item()  : mixed
save_parcel()  : mixed
save_payment_info()  : mixed
save_pickup()  : mixed
save_reference_order()  : mixed
save_shipping_method()  : mixed
save_totals()  : mixed
saveconfig()  : mixed
save module configuration
search()  : mixed
AJAX search for internal (addressController) addresses
search_external()  : mixed
Ajax search for external addresses
searchCategory()  : string
category of items searched in the module
searchHit()  : bool
additional check for display of search hit
searchName()  : string
type of items searched in the module
set_order_type()  : mixed
setStatus()  : mixed
Change order status and email notification if necessary
show()  : mixed
default view for individual item
showall()  : mixed
default module view method for all items
showall_by_date_meta()  : array<string|int, mixed>
action specific metainfo
showall_by_tags()  : mixed
default module view method for all items with a specific tag
showall_by_tags_meta()  : array<string|int, mixed>
action specific metainfo
showByTags()  : mixed
view items referenced by tags
showByTitle()  : mixed
view the item by referring to its title
showRandom()  : mixed
view a random item
supportsWorkflow()  : bool
does module support workflow?
tags()  : mixed
return all tags used by module's items
update()  : mixed
update (save) item in module
update_sales_reps()  : mixed
update_shipping()  : mixed
verifyAndRestoreCart()  : mixed
verifyReturnShopper()  : mixed
voidAuthorization()  : mixed
returnFile()  : mixed

Properties

$requires_login

public mixed $requires_login = array('ordersbyuser' => 'You must be logged in to view past orders')

$m_permissions

protected mixed $m_permissions = array( // standard set of actions requiring manage permission for all modules 'activate' => 'Activate', 'approve' => 'Approve', 'merge' => 'Merge', 'rerank' => 'ReRank', 'import' => 'Import Items', 'export' => 'Export Items', )

$manage_permissions

protected mixed $manage_permissions = array( 'add_order_item' => 'Add Order Item', 'download' => 'Download Label', // 'create_new_order' => 'Create A New Order', // 'createReferenceOrder'=> 'Create Reference Order', 'edit_address' => 'Edit Address', 'edit_invoice_id' => 'Edit Invoice Id', 'edit_order_item' => 'Edit Order Item', // 'edit_payment_info' => 'Edit Payment Info', 'edit_shipping_method' => 'Edit Shipping Method', 'edit_totals' => 'Edit Totals', // 'email' => 'Send Email', 'getOrdersByJSON' => 'Get Orders', 'quickfinder' => 'Do a quick order lookup', 'save_payment_info' => 'Save Payment Info', 'save_address' => 'Save Address', 'save_order_item' => 'Save Order Item', // 'save_new_order_item'=> 'Save New Order Item', 'save_totals' => 'Save Totals', 'save_invoice_id' => 'Save Invoice Id', 'save_shipping_method' => 'Save Shipping Method', 'save_new_order' => 'Save a new order', 'save_reference_order' => 'Save Reference Order', 'set' => 'Change Status', 'showall' => 'Manage', 'show' => 'View Orders', 'update' => 'update order', )

$permissions

protected mixed $permissions = array( // standard set of permissions for all modules unless add'ed or remove'd 'manage' => 'Manage', 'configure' => 'Configure', 'create' => 'Create', 'edit' => 'Edit', 'delete' => 'Delete', )

$remove_permissions

protected mixed $remove_permissions = array()

Methods

__construct()

public __construct([null $src = null ][, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$src : null = null
$params : array<string|int, mixed> = array()
Tags
throws
ReflectionException
Return values
mixed

__get()

Generic magic method

public __get( $property) : null
Parameters
$property :
Return values
null

__isset()

Generic magic method

public __isset( $property) : bool
Parameters
$property :
Return values
bool

__set()

Generic magic method We MUST create/set non-existing properties for Exponent code to work

public __set( $property,  $value) : mixed
Parameters
$property :
$value :
Return values
mixed

__unset()

Generic magic method

public __unset( $property) : mixed
Parameters
$property :
Return values
mixed

add_order_item()

public add_order_item() : mixed
Return values
mixed

addContentToSearch()

add module item or all items to search index

public addContentToSearch() : int
Tags
throws
ReflectionException
Return values
int

number of items added to search index

aggregateWhereClause()

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

public aggregateWhereClause([string $type = '' ]) : string
Parameters
$type : string = ''
Return values
string

approve()

approve module item

public approve() : mixed
Return values
mixed

author()

author of module

public static author() : string
Return values
string

canExportData()

can this module export data?

public static canExportData() : bool
Return values
bool

canHandleEAAS()

can this module export EAAS data?

public static canHandleEAAS() : bool
Return values
bool

canImportData()

can this module import data?

public static canImportData() : bool
Return values
bool

captureAuthorization()

public captureAuthorization() : mixed
Return values
mixed

categories()

return all categories used by module's items

public categories() : mixed
Return values
mixed

checkPermissions()

public static checkPermissions(mixed $permission, mixed $location) : mixed
Parameters
$permission : mixed
$location : mixed
Return values
mixed

clearCartCookie()

public static clearCartCookie() : mixed
Return values
mixed

comments()

return all comments used by module's items

public comments() : mixed
Return values
mixed

configure()

Configure the module

public configure() : mixed
Return values
mixed

create()

create an item in this module

public create() : mixed
Tags
deprecated

in favor of edit w/o id param

Return values
mixed

create_new_order()

public create_new_order() : mixed
Return values
mixed

createReferenceOrder()

public createReferenceOrder() : mixed
Return values
mixed

creditTransaction()

public creditTransaction() : mixed
Return values
mixed

delete()

delete item in module

public delete() : mixed
Return values
mixed

delete_In()

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

public delete_In( $loc) : mixed
Parameters
$loc :
Return values
mixed

delete_instance()

delete module, config, and all its items

public delete_instance([bool $loc = false ]) : mixed
Parameters
$loc : bool = false
Tags
throws
ReflectionException
Return values
mixed

delete_label()

public delete_label() : mixed
Return values
mixed

delete_order_item()

public delete_order_item() : mixed
Return values
mixed

delete_pickup()

public delete_pickup() : mixed
Return values
mixed

remove all module items from search index

public delete_search() : mixed
Return values
mixed

description()

description of module

public static description() : string
Return values
string

displayname()

name of module

public static displayname() : string
Return values
string

download_label()

public download_label() : mixed
Return values
mixed

downloadfile()

download a file attached to item

public downloadfile() : mixed
Return values
mixed

eaasConfig()

returns info about Config template standard location is a folder named 'eaas' in the module's view folder with a model_name template

public eaasConfig() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

eaasData()

returns module's EAAS data as an array of records

public eaasData([mixed $params = array() ][, mixed $where = null ]) : array<string|int, mixed>
Parameters
$params : mixed = array()
$where : mixed = null
Return values
array<string|int, mixed>

edit()

edit item in module, also used to copy items

public edit() : mixed
Return values
mixed

edit_address()

public edit_address() : mixed
Return values
mixed

edit_invoice_id()

public edit_invoice_id() : mixed
Return values
mixed

edit_order_item()

public edit_order_item() : mixed
Return values
mixed

edit_parcel()

public edit_parcel() : mixed
Return values
mixed

edit_payment_info()

public edit_payment_info() : mixed
Return values
mixed

edit_pickup()

public edit_pickup() : mixed
Return values
mixed

edit_pickup2()

public edit_pickup2() : mixed
Return values
mixed

edit_shipping_method()

public edit_shipping_method() : mixed
Return values
mixed

edit_totals()

public edit_totals() : mixed
Return values
mixed

emailCustomer()

public emailCustomer() : mixed
Return values
mixed

getInvoiceNumByJSON()

For server-side re-population of DataTables

public getInvoiceNumByJSON() : mixed
Return values
mixed

getModels()

get the model(s) associated with this module

public getModels() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOrdersByJSON()

For server-side population of DataTables

public getOrdersByJSON() : mixed
Return values
mixed

getPDF()

public getPDF([mixed $orders = null ]) : mixed
Parameters
$orders : mixed = null
Return values
mixed

getRSSContent()

get the module's items in an rss feed format

public getRSSContent(int $limit) : array<string|int, mixed>

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

Parameters
$limit : int
Return values
array<string|int, mixed>

hasContent()

does module have content (stored items) available?

public static hasContent() : bool
Return values
bool

hasSources()

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

public static hasSources() : bool
Return values
bool

hasViews()

does module have views available?

public static hasViews() : bool
Return values
bool

isSearchable()

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

public static isSearchable() : bool
Return values
bool

manage()

display module management view

public manage() : mixed
Return values
mixed

manage_ranks()

rerank module items, called from ddrerank

public manage_ranks() : mixed
Return values
mixed

merge()

merge/move aggregated item into this module

public merge() : mixed
Return values
mixed

meta_fb()

Returns Facebook og: meta data

public meta_fb( $request,  $object,  $canonical) : array<string|int, mixed>
Parameters
$request :
$object :
$canonical :
Return values
array<string|int, mixed>

meta_rich()

Returns rich snippet PageMap meta data

public meta_rich( $request,  $object) : null
Parameters
$request :
$object :
Return values
null

meta_tw()

Returns Twitter twitter: meta data

public meta_tw( $request,  $object,  $canonical) : array<string|int, mixed>
Parameters
$request :
$object :
$canonical :
Return values
array<string|int, mixed>

metainfo()

get the metainfo for this module

public metainfo() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

name()

name of module for backwards compat with old modules

public name() : string
Return values
string

ordersbyuser()

public ordersbyuser() : mixed
Return values
mixed

permissions()

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

public permissions() : array<string|int, mixed>
Return values
array<string|int, mixed>

permissions_all()

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

public permissions_all() : array<string|int, mixed>
Return values
array<string|int, mixed>

quickfinder()

public quickfinder() : mixed
Return values
mixed

requiresConfiguration()

does this module require configuration?

public static requiresConfiguration() : bool
Return values
bool

rerank()

rerank items in model

public rerank() : mixed
Return values
mixed

rss()

method to display an rss feed from this module

public rss() : mixed
Return values
mixed

save_address()

public save_address() : mixed
Return values
mixed

save_invoice_id()

public save_invoice_id() : mixed
Return values
mixed

save_new_order()

public save_new_order() : mixed
Return values
mixed

save_new_order_item()

public save_new_order_item() : mixed
Return values
mixed

save_order_item()

public save_order_item() : mixed
Return values
mixed

save_parcel()

public save_parcel() : mixed
Return values
mixed

save_payment_info()

public save_payment_info() : mixed
Return values
mixed

save_pickup()

public save_pickup() : mixed
Return values
mixed

save_reference_order()

public save_reference_order() : mixed
Return values
mixed

save_shipping_method()

public save_shipping_method() : mixed
Return values
mixed

save_totals()

public save_totals() : mixed
Return values
mixed

saveconfig()

save module configuration

public saveconfig() : mixed
Return values
mixed

AJAX search for internal (addressController) addresses

public search() : mixed
Return values
mixed

search_external()

Ajax search for external addresses

public search_external() : mixed
Return values
mixed

searchCategory()

category of items searched in the module

public searchCategory() : string
Return values
string

searchHit()

additional check for display of search hit

public static searchHit( $record) : bool
Parameters
$record :
Return values
bool

searchName()

type of items searched in the module

public searchName() : string
Return values
string

set_order_type()

public set_order_type() : mixed
Return values
mixed

setStatus()

Change order status and email notification if necessary

public setStatus() : mixed
Return values
mixed

show()

default view for individual item

public show() : mixed
Return values
mixed

showall()

default module view method for all items

public showall() : mixed
Return values
mixed

showall_by_date_meta()

action specific metainfo

public showall_by_date_meta( $request) : array<string|int, mixed>
Parameters
$request :
Return values
array<string|int, mixed>

showall_by_tags()

default module view method for all items with a specific tag

public showall_by_tags() : mixed
Return values
mixed

showall_by_tags_meta()

action specific metainfo

public showall_by_tags_meta( $request) : array<string|int, mixed>
Parameters
$request :
Return values
array<string|int, mixed>

showByTags()

view items referenced by tags

public showByTags() : mixed
Tags
deprecated
Return values
mixed

showByTitle()

view the item by referring to its title

public showByTitle() : mixed
Tags
deprecated
Return values
mixed

showRandom()

view a random item

public showRandom() : mixed
Return values
mixed

supportsWorkflow()

does module support workflow?

public static supportsWorkflow() : bool
Return values
bool

tags()

return all tags used by module's items

public tags() : mixed
Return values
mixed

update()

update (save) item in module

public update() : mixed
Return values
mixed

update_sales_reps()

public update_sales_reps() : mixed
Return values
mixed

update_shipping()

public update_shipping() : mixed
Return values
mixed

verifyAndRestoreCart()

public verifyAndRestoreCart() : mixed
Return values
mixed

verifyReturnShopper()

public verifyReturnShopper() : mixed
Return values
mixed

voidAuthorization()

public voidAuthorization() : mixed
Return values
mixed

returnFile()

private returnFile(mixed $file, mixed $name[, mixed $mime_type = '' ]) : mixed
Parameters
$file : mixed
$name : mixed
$mime_type : mixed = ''
Return values
mixed

Search results