reportController

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

Report on abandoned carts

abandoned_carts() 

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

A Product Report

batch_export() 

buildCategoryString

buildCategoryString( $catID, boolean $reset = false) : boolean|string
static
deprecated 2.3.4

moved to storeCategory

Arguments

$catID

$reset

boolean

Response

boolean|string

can this module export data?

canExportData() : boolean
inherited static

Response

boolean

can this module import data?

canImportData() : boolean
inherited static

Response

boolean

FIXME Function not known/incomplete

cart_summary() 

return all categories used by module's items

categories() 
inherited

checkPermissions

checkPermissions( $permission,  $location) 
inherited static

Arguments

$permission

$location

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

Display report of currently active carts

current_carts() 

Current Stats

dashboard() 

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

description of module

description() : string
inherited static

Response

string

name of module

displayname() : string
inherited static

Response

string

Output report data for download

download( $file,  $name,  $type) 
static

Arguments

$file

$name

$type

download a file attached to item

downloadfile() 
inherited

edit item in module, also used to copy items

edit() 
inherited

An Order Report

export_inventory() 

An Order Report

export_odbc() 

An Order Report

export_order_items() 

An Order Report

export_status_report() 

An Order Report

export_user_input_report() 

Generate an orders report selection view from parameters

generateOrderReport() 

Generate an products report selection view from parameters

generateProductReport() 

get the model(s) associated with this module

getModels() : array
inherited

Response

array

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

name of module for backwards compat with old modules

name() : string
inherited

Response

string

Get parameters for an orders report

order_report() 

outputField

outputField( $val, string $eof = ',', boolean $isHTML = false) : string
deprecated 2.3.3

moved to expString

Arguments

$val

$eof

string

$isHTML

boolean

Response

string

parseAndTrim

parseAndTrim( $str, boolean $isHTML = false) : mixed
static
deprecated 2.3.3

moved to expString

Arguments

$str

$isHTML

boolean

Response

mixed

parseAndTrimExport

parseAndTrimExport( $str, boolean $isHTML = false) : mixed
static
deprecated 2.3.3

moved to expString

Arguments

$str

$isHTML

boolean

Response

mixed

parseAndTrimImport

parseAndTrimImport( $str, boolean $isHTML = false) : mixed
static
deprecated 2.3.3

moved to expString

Arguments

$str

$isHTML

boolean

Response

mixed

FIXME Function not known/incomplete

payment_report() 

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

An Order Report

print_orders() 

Get parameters for an products report

product_report() 

FIXME Function not known/incomplete

productFeed() 

Remove abandoned carts data

pruge_abandoned_carts() 

requiresConfiguration

requiresConfiguration() 
inherited static

rerank items in model

rerank() 
inherited

method to display an rss feed from this module

rss() 
inherited

save module configuration

saveconfig() 
inherited

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

Help parse quick range input

setDateParams( $params) 

Arguments

$params

default view for individual item

show() 
inherited

An Order Report to show breakdown of taxes and payment types

show_payment_summary() 

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

sortPrintOrders

sortPrintOrders( $a,  $b) 
static

Arguments

$a

$b

Stats for selected period

stats() 

A Product Report

status_export() 

stripLineEndings

stripLineEndings( $val) : null|string|array<mixed,string>
deprecated 2.3.3

moved to expString

Arguments

$val

Response

null|string|array<mixed,string>

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

Properties

manage_permissions

manage_permissions : 
inherited

Type(s)

o

o : 

Type(s)

oneday

oneday : 

Type(s)

tstart

tstart : 

Type(s)

tend

tend : 

Type(s)

prev_month

prev_month : 

Type(s)

prev_hour

prev_hour : 

Type(s)

prev_min

prev_min : 

Type(s)

prev_ampm

prev_ampm : 

Type(s)

now_date

now_date : 

Type(s)

now_hour

now_hour : 

Type(s)

now_min

now_min : 

Type(s)

now_ampm

now_ampm : 

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)