Exponent v2.4.3
Back to top  

formsController

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

Assign selected form to current module

activate()

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

Output a single control to an ajax request

build_control()

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

checkPermissions

checkPermissions( $permission,  $location)
inherited static

Arguments

$permission

$location

return all comments used by module's items

comments()
inherited

Configure the module

configure()
inherited

Form data is parsed and displayed for confirmation before entering into database and/pr sending email used for only initial entry

confirm_data()

create an item in this module

create()
inherited
deprecated

in favor of edit w/o id param

delete item in module

delete()
inherited

delete_control

delete_control()

delete_form

delete_form()

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 all items in saved data

delete_records()

remove all module items from search index

delete_search()
inherited

description of module

description() : string
inherited static

Response

string

design_form

design_form()

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

edit_control

edit_control()

edit_form

edit_form()

enter_data

enter_data()

enterdata

enterdata()

export_csv

export_csv()

Export form, controls and optionally the data table

export_eql()

Export form, controls and optionally the data table

export_eql_process()

create a new default config array using the form defaults

get_defaults( $form)

Arguments

$form

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

import_csv

import_csv()

import_csv_data_add

import_csv_data_add()

import_csv_data_display

import_csv_data_display()

import_csv_data_mapper

import_csv_data_mapper()

import_csv_form_add

import_csv_form_add()

import_csv_form_prep

import_csv_form_prep()

import_csv_mapper

import_csv_mapper()

Import form, controls and optionally the data table

import_eql()

Import form, controls and optionally the data table

import_eql_process()

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

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

rerank_control

rerank_control()

method to display an rss feed from this module

rss()
inherited

save_control

save_control()

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

This converts the sql statement into a nice CSV.

sql2csv( $items, array|null $rptcols = null) : string
static

We grab the items array which is stored funkily in the DB in an associative array when we pull it. So basically our aray looks like this:

ITEMS {[id]=>myID, [Name]=>name, [Address]=>myaddr} {[id]=>myID1, [Name]=>name1, [Address]=>myaddr1} {[id]=>myID2, [Name]=>name2, [Address]=>myaddr2} {[id]=>myID3, [Name]=>name3, [Address]=>myaddr3} {[id]=>myID4, [Name]=>name4, [Address]=>myaddr4} {[id]=>myID5, [Name]=>name5, [Address]=>myaddr5}

So by nature of the array, the keys are repeated in each line (id, name, etc) So if we want to make a header row, we just run through once at the beginning and use the array_keys function to strip out a functional header

Arguments

$items

$rptcols

array|null

Response

string

Form data is parsed and entered into database and/or email is sent used for both initial entry and editing records

submit_data()

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

Updates the form

update_form()

Properties

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)

basemodel_name

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