Exponent v2.4.3
Back to top  

expController

This is the class expController

package

Core
subpackage

Controllers

Methods

__construct

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

Arguments

$src

null

$params

array

add module item or all items to search index

addContentToSearch() : integer
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

Arguments

$type

string

Response

string

approve module item

approve()

author of module

author() : string
static

Response

string

can this module export data?

canExportData() : boolean
static

Response

boolean

can this module import data?

canImportData() : boolean
static

Response

boolean

return all categories used by module's items

categories()

checkPermissions

checkPermissions( $permission,  $location)
static

Arguments

$permission

$location

return all comments used by module's items

comments()

Configure the module

configure()

create an item in this module

create()
deprecated

in favor of edit w/o id param

delete item in module

delete()

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

delete_In( $loc)

Arguments

$loc

delete module, config, and all its items

delete_instance(boolean $loc = false)
Throws
\ReflectionException

Arguments

$loc

boolean

remove all module items from search index

delete_search()

description of module

description() : string
static

Response

string

name of module

displayname() : string
static

Response

string

download a file attached to item

downloadfile()

edit item in module, also used to copy items

edit()

get the model(s) associated with this module

getModels() : array

Response

array

get the module's items in an rss feed format

getRSSContent(integer $limit) : array

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

Arguments

$limit

integer

Response

array

hasContent

hasContent()
static

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

hasSources() : boolean
static

Response

boolean

hasViews

hasViews()
static

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

isSearchable() : boolean
static

Response

boolean

display module management view

manage()

rerank module items, called from ddrerank

manage_ranks()

merge/move aggregated item into this module

merge()

Returns Facebook og: meta data

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

Arguments

$request

$object

$canonical

Response

array

Returns rich snippet PageMap meta data

meta_rich( $request,  $object) : null

Arguments

$request

$object

Response

null

Returns Twitter twitter: meta data

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

Arguments

$request

$object

$canonical

Response

array

get the metainfo for this module

metainfo() : array

Response

array

glue to make the view template aware of the module

moduleSelfAwareness()
deprecated

name of module for backwards compat with old modules

name() : string

Response

string

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

permissions() : array

Response

array

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

permissions_all() : array

Response

array

requiresConfiguration

requiresConfiguration()
static

rerank items in model

rerank()

method to display an rss feed from this module

rss()

save module configuration

saveconfig()

category of items searched in the module

searchCategory() : string

Response

string

additional check for display of search hit

searchHit( $record) : boolean
static

Arguments

$record

Response

boolean

type of items searched in the module

searchName() : string

Response

string

default view for individual item

show()

default module view method for all items

showall()

action specific metainfo

showall_by_date_meta( $request) : array

Arguments

$request

Response

array

default module view method for all items with a specific tag

showall_by_tags()

action specific metainfo

showall_by_tags_meta( $request) : array

Arguments

$request

Response

array

view items referenced by tags

showByTags()
deprecated

view the item by referring to its title

showByTitle()
deprecated

view a random item

showRandom()

does module support workflow?

supportsWorkflow() : boolean
static

Response

boolean

return all tags used by module's items

tags()

update (save) item in module

update()

Properties

classname

classname :

Type(s)

baseclassname

baseclassname :

Type(s)

classinfo

classinfo :

Type(s)

basemodel_name

basemodel_name :

Type(s)

model_table

model_table :

Type(s)

useractions

useractions :

Type(s)

remove_configs

remove_configs :

Type(s)

permissions

permissions :

Type(s)

m_permissions

m_permissions :

Type(s)

remove_permissions

remove_permissions :

Type(s)

add_permissions

add_permissions :

Type(s)

manage_permissions

manage_permissions :

Type(s)

filepath

filepath :

Type(s)

viewpath

viewpath :

Type(s)

relative_viewpath

relative_viewpath :

Type(s)

asset_path

asset_path :

Type(s)

config

config :

Type(s)

params

params :

Type(s)

loc

loc :

Type(s)

codequality

codequality :

Type(s)

rss_is_podcast

rss_is_podcast :

Type(s)