Exponent v2.4.3
Back to top  

storeController

Extends \expController

This is the class expController

define

"BASE" "../../../.."
package

Modules

Methods

__construct

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

Arguments

$src

null

$params

array

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

batch_process

batch_process()

billing_config

billing_config()

can this module export data?

canExportData() : boolean
inherited static

Response

boolean

can this module import data?

canImportData() : boolean
inherited static

Response

boolean

return all categories used by module's items

categories()
inherited

categoryBreadcrumb

categoryBreadcrumb()

checkPermissions

checkPermissions( $permission,  $location)
inherited static

Arguments

$permission

$location

cleanNonUnicodeProducts

cleanNonUnicodeProducts()

return all comments used by module's items

comments()
inherited

Configure the module

configure()
inherited

copyProduct

copyProduct()

create an item in this module

create()
inherited
deprecated

in favor of edit w/o id param

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_model_alias

delete_model_alias()

remove all module items from search index

delete_search()
inherited

deleteChildren

deleteChildren()

deleteProcessedModelAliases

deleteProcessedModelAliases()

description of module

description() : string
inherited static

Response

string

name of module

displayname() : string
inherited static

Response

string

download a file attached to item

downloadfile()
inherited

ecomSearch

ecomSearch()

edit item in module, also used to copy items

edit()
inherited

edit_model_alias

edit_model_alias()

eventsCalendar

eventsCalendar()
deprecated 2.0.0

moved to eventregistration

export

export()

exportMe

exportMe()

getEventsForDates

getEventsForDates( $edates,  $sort_asc = true)

Arguments

$edates

$sort_asc

get the model(s) associated with this module

getModels() : array
inherited

Response

array

For server-side population of DataTables

getProductsByJSON()

getProductTypes

getProductTypes()
static

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

grabConfig

grabConfig( $category = null)

Arguments

$category

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

import

import()

import_external_addresses

import_external_addresses()

importProduct

importProduct( $file = null)

Arguments

$file

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

manage_sales_reps

manage_sales_reps()

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

nonUnicodeProducts

nonUnicodeProducts()

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

picktype

picktype()

process_external_addresses

process_external_addresses()

process_orders

process_orders()

processModelAliases

processModelAliases( $index,  $error = '')

Arguments

$index

$error

quicklinks

quicklinks()

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

saveModelAliases

saveModelAliases()

AJAX search for products by title, description, or model/sku

search()

AJAX search for products by model/sku

search_by_model()

searchByModel

searchByModel()

searchByModelForm

searchByModelForm()

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

AJAX search for products by title, description, or model/sku

searchNew()

setup_wizard

setup_wizard()

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

showallByManufacturer

showallByManufacturer()
deprecated 2.3.3

moved to company

showallCategoryFeaturedProducts

showallCategoryFeaturedProducts()

showallFeaturedProducts

showallFeaturedProducts()

Display those products assigned to a NON-end level category therefore they can't really be displayed

showallImpropercategorized()

showallManufacturers

showallManufacturers()
deprecated 2.3.3

moved to company

showallSubcategories

showallSubcategories()

showallUncategorized

showallUncategorized()

showByModel

showByModel()

view items referenced by tags

showByTags()
inherited
deprecated

view the item by referring to its title

showByTitle()
inherited
deprecated

showFullTree

showFullTree()

showGiftCards

showGiftCards()

showHistory

showHistory()

view a random item

showRandom()
inherited

showTopLevel

showTopLevel()

showTopLevel_images

showTopLevel_images()

does module support workflow?

supportsWorkflow() : boolean
inherited static

Response

boolean

return all tags used by module's items

tags()
inherited

upcomingEvents

upcomingEvents()
deprecated 2.0.0

moved to eventregistration

update (save) item in module

update()
inherited

update_model_alias

update_model_alias()

uploadModelAliases

uploadModelAliases()

Properties

basemodel_name

basemodel_name :
inherited

Type(s)

useractions

useractions :
inherited

Type(s)

manage_permissions

manage_permissions :
inherited

Type(s)

remove_configs

remove_configs :
inherited

Type(s)

classname

classname :
inherited

Type(s)

baseclassname

baseclassname :
inherited

Type(s)

classinfo

classinfo :
inherited

Type(s)

model_table

model_table :
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)