Exponent v2.4.3
Back to top  

navigationController

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

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

breadcrumb

breadcrumb()

can this module export data?

canExportData() : boolean
inherited static

Response

boolean

can this module import data?

canImportData() : boolean
inherited static

Response

boolean

canManageStandalones

canManageStandalones()
static

Check for cascading page view permission, esp. if not public

canView( $section) : boolean
static
deprecated 2.3.4

moved to section model

Arguments

$section

Response

boolean

return all categories used by module's items

categories()
inherited

Reassign permissions based on a check/change in menu/page hierarchy

checkForSectionalAdmins( $id)
static
static

Arguments

$id

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

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_redirection

delete_redirection()

delete_redirection_log

delete_redirection_log()

remove all module items from search index

delete_search()
inherited

delete_standalones

delete_standalones()

Delete page and send its contents to the recycle bin

deleteLevel( $parent)
static
deprecated 2.3.4

moved to section model

Arguments

$parent

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

Ajax function to reorder page hierarchy from yui tree control

DragnDropReRank()
static

Ajax function to reorder page hierarchy from jstree control

DragnDropReRank2()
static

edit item in module, also used to copy items

edit()
inherited

edit_contentpage

edit_contentpage()

edit_externalalias

edit_externalalias()

edit_freeform

edit_freeform()

edit_internalalias

edit_internalalias()

edit_redirection

edit_redirection()

edit_section

edit_section()

get_glyphs

get_glyphs()
static

getChildren

getChildren( &$i, boolean $notyui = false) : array
static
deprecated 2.3.4

moved to section model

Arguments

$i

$notyui

boolean

Response

array

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

recursively lists the template hierarchy

getTemplateHierarchyFlat(integer $parent, integer $depth = 1) : array
static
static
deprecated 2.0.0

this only for deprecated templates

Arguments

$parent

integer

top level parent id

$depth

integer

variable to hold level of recursion

Response

array

hasChildren

hasChildren( $i) : boolean
static
deprecated 2.3.4

moved to section model

Arguments

$i

Response

boolean

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

exdoc Creates a location object, based off of the three arguments passed, and returns it.

initializeNavigation() : array
static
deprecated 2.3.4

moved to section model

Response

array

Check to see if page is public with cascading

isPublic( $s) : boolean|integer
static
deprecated 2.3.4

moved to section model

Arguments

$s

Response

boolean|integer

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

isSearchable() : boolean
inherited static

Response

boolean

Returns a flat representation of the full site hierarchy.

levelDropdownControlArray(integer $parent, integer $depth, array $ignore_ids = array(), boolean $full = false, string $perm = 'view', boolean $addstandalones = false, boolean $addinternalalias = true) : array
static
deprecated 2.3.4

moved to section model, HOWEVER still used in theme config

Arguments

$parent

integer

top level parent id

$depth

integer

variable to hold level of recursion

$ignore_ids

array

array of pages to ignore

$full

boolean

include a 'top' level entry

$perm

string

permission level to build list

$addstandalones

boolean

should we add the stand-alone pages also

$addinternalalias

boolean

Response

array

Retrieve either the entire hierarchy, or a subset of the hierarchy, as an array suitable for use in a dropdowncontrol. This is used primarily by the section datatype for moving and adding sections to specific parts of the site hierarchy.

levelShowDropdown(integer $parent, integer $depth, integer $default, array $ignore_ids = array()) : string

Arguments

$parent

integer

The id of the subtree parent. If passed as 0 (the default), the entire subtree is parsed.

$depth

integer

$default

integer

$ignore_ids

array

a value-array of IDs to be ignored when generating the list. This is used when moving a section, since a section cannot be made a subsection of itself or any of its subsections.

Response

string

returns all the section's children

levelTemplate(integer $parent, integer $depth, array $parents = array()) : array
static
static
deprecated 2.3.4

moved to section model

Arguments

$parent

integer

top level parent id

$depth

integer

variable to hold level of recursion

$parents

array

Response

array

display module management view

manage()
inherited

rerank module items, called from ddrerank

manage_ranks()
inherited

manage_redirection_log

manage_redirection_log()

manage_sitemap

manage_sitemap()

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

move_standalone

move_standalone()

name of module for backwards compat with old modules

name() : string
inherited

Response

string

navhierarchy

navhierarchy(boolean $notyui = false) : array
static
deprecated 2.3.4

moved to section model

Arguments

$notyui

boolean

Response

array

navtojson

navtojson()
static
deprecated 2.3.4

moved to section model

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

process_section

process_section( $section,  $template)
static
deprecated 2.0.0

this only for deprecated templates

Arguments

$section

$template

process_subsections

process_subsections( $parent_section,  $subtpl)
deprecated 2.0.0

this only for deprecated templates

Arguments

$parent_section

$subtpl

Rebuild the sectionref table as a list of modules on a page

rebuild_sectionrefs()
static
deprecated 2.3.4

moved to sectionref model

Move content page to standalones

remove()

Move content page and its children to stand-alones

removeLevel( $parent)
static
deprecated 2.3.4

moved to section model

Arguments

$parent

Move standalone back to hierarchy

reparent_standalone()

requiresConfiguration

requiresConfiguration()
inherited static

rerank items in model

rerank()
inherited

Ajax request for specific pages as json date to yui tree

returnChildrenAsJSON()
static

Ajax request for all pages as json date to jstree

returnChildrenAsJSON2()
static

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

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

update (save) item in module

update()
inherited

update_redirection

update_redirection()

Properties

basemodel_name

basemodel_name :
inherited

Type(s)

useractions

useractions :
inherited

Type(s)

add_permissions

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

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)