Exponent v2.4.3
Back to top  

administrationController

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

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

change_profile

change_profile()

checkPermissions

checkPermissions( $permission,  $location)
inherited static

Arguments

$permission

$location

clear_all_caches

clear_all_caches()
static

clear_css_cache

clear_css_cache()

clear_image_cache

clear_image_cache()

clear_rss_cache

clear_rss_cache()

clear_smarty_cache

clear_smarty_cache()

return all comments used by module's items

comments()
inherited

Configure the module

configure()
inherited

configure_site

configure_site()

configure_theme

configure_theme()

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

remove all module items from search index

delete_search()
inherited

delete_unused_columns

delete_unused_columns()

delete_unused_tables

delete_unused_tables()

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

edit item in module, also used to copy items

edit()
inherited

export_theme

export_theme()

fix_database

fix_database()

fix_optimize_database

fix_optimize_database()

fix_tables

fix_tables()

formatOffset

formatOffset( $offset)
static

Arguments

$offset

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

install_ecommerce_tables

install_ecommerce_tables()

Routine to force launching exponent installer

install_exponent()
static

install_extension

install_extension()

install_extension_confirm

install_extension_confirm()

install_extension_finish

install_extension_finish()

install_tables

install_tables()

feature to run upgrade scripts outside of installation

install_upgrades()

run selected upgrade scripts outside of installation

install_upgrades_run()

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

isSearchable() : boolean
inherited static

Response

boolean

display module management view

manage()
inherited

manage_lang

manage_lang()

manage_lang_await

manage_lang_await()

rerank module items, called from ddrerank

manage_ranks()
inherited

manage_themes

manage_themes()

manage_unused_tables

manage_unused_tables()

manage_version

manage_version()

mass_mail

mass_mail()

mass_mail_out

mass_mail_out()

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

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

requiresConfiguration

requiresConfiguration()
inherited static

rerank items in model

rerank()
inherited

method to display an rss feed from this module

rss()
inherited

save_newlangfile

save_newlangfile()

save_profile

save_profile()

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

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

test_smtp

test_smtp()

theme_preview

theme_preview()

theme_switch

theme_switch()

toggle_dev

toggle_dev()

toggle_log

toggle_log()

toggle_maintenance

toggle_maintenance()

toggle_minify

toggle_minify()

toggle_preview

toggle_preview()

toggle_workflow

toggle_workflow()

togglemobile

togglemobile()

toolbar

toolbar()

update (save) item in module

update()
inherited

update_language

update_language()

update_SetSlingbarPosition

update_SetSlingbarPosition()

update_siteconfig

update_siteconfig()

update_theme

update_theme()

Properties

basemodel_name

basemodel_name :
inherited

Type(s)

manage_permissions

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

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)