Exponent v2.7.2

formsController extends expController
in package

This is the class expController

Tags
subpackage

Controllers

Table of Contents

$asset_path  : mixed
$baseclassname  : mixed
$basemodel_name  : mixed
$classinfo  : mixed
$codequality  : mixed
$config  : mixed
$filepath  : mixed
$loc  : mixed
$model_table  : mixed
$params  : mixed
$relative_viewpath  : mixed
$remove_configs  : mixed
$requires_login  : mixed
$rss_is_podcast  : mixed
$useractions  : mixed
$viewpath  : mixed
$add_permissions  : mixed
$classname  : mixed
$m_permissions  : mixed
$manage_permissions  : mixed
$permissions  : mixed
$remove_permissions  : mixed
__construct()  : mixed
__get()  : null
Generic magic method
__isset()  : bool
Generic magic method
__set()  : mixed
Generic magic method We MUST create/set non-existing properties for Exponent code to work
__unset()  : mixed
Generic magic method
activate()  : mixed
Assign selected form to current module
add_search_record()  : int
Create a Search record from a Form record
addContentToSearch()  : int
add saved form item or all saved form items to search index
aggregateWhereClause()  : string
The aggregateWhereClause function creates a sql where clause which also includes aggregated module content
approve()  : mixed
approve module item
author()  : string
author of module
build_control()  : mixed
Output a single control to an ajax request
canExportData()  : bool
can this module export data?
canHandleEAAS()  : bool
can this module export EAAS data?
canImportData()  : bool
can this module import data?
categories()  : mixed
return all categories used by module's items
checkPermissions()  : mixed
comments()  : mixed
return all comments used by module's items
configure()  : mixed
Configure the module
confirm_data()  : mixed
Form data is parsed and displayed for confirmation before entering into database and/pr sending email used for only initial entry
create()  : mixed
create an item in this module
delete()  : mixed
delete item in saved data
delete_control()  : mixed
delete_form()  : mixed
delete_In()  : mixed
delete module and all its items for backwards compat with old modules
delete_instance()  : mixed
delete module, config, and all its items
delete_records()  : mixed
delete all items in saved data
delete_search()  : mixed
remove all module items from search index
description()  : string
description of module
design_form()  : mixed
displayname()  : string
name of module
downloadfile()  : mixed
download a file attached to item
eaasConfig()  : array<string|int, mixed>|bool
returns info about Config template standard location is a folder named 'eaas' in the module's view folder with a model_name template
eaasData()  : array<string|int, mixed>
returns module's EAAS data as an array of records
edit()  : mixed
edit item in module, also used to copy items
edit_control()  : mixed
edit_form()  : mixed
enter_data()  : void
Old entry point
enterdata()  : void
Display Form
export_csv()  : mixed
export_eql()  : mixed
Export form, controls and optionally the data table
export_eql_process()  : mixed
Export form, controls and optionally the data table
getModels()  : array<string|int, mixed>
get the model(s) associated with this module
getRSSContent()  : array<string|int, mixed>
get the module's items in an rss feed format
hasContent()  : bool
does module have content (stored items) available?
hasSources()  : bool
does module have sources available? or does it treat content globally
hasViews()  : bool
does module have views available?
import_csv()  : mixed
import_csv_data_add()  : mixed
import_csv_data_display()  : mixed
import_csv_data_mapper()  : mixed
import_csv_form_add()  : mixed
import_csv_form_prep()  : mixed
import_csv_mapper()  : mixed
import_eql()  : mixed
Import form, controls and optionally the data table
import_eql_process()  : mixed
Import form, controls and optionally the data table
isSearchable()  : bool
is module content searchable? should it be added to search index?
manage()  : mixed
Manage site forms
manage_ranks()  : mixed
rerank module items, called from ddrerank
merge()  : mixed
merge/move aggregated item into this module
meta_fb()  : array<string|int, mixed>
Returns Facebook og: meta data
meta_rich()  : null
Returns rich snippet PageMap meta data
meta_tw()  : array<string|int, mixed>
Returns Twitter twitter: meta data
metainfo()  : array<string|int, mixed>|bool
get the metainfo for this module
name()  : string
name of module for backwards compat with old modules
permissions()  : array<string|int, mixed>
permission functions to aggregate a module's visible permissions based on add/remove permissions
permissions_all()  : array<string|int, mixed>
permission functions to aggregate a module's permissions based on add/remove and manage permissions
requiresConfiguration()  : bool
does this module require configuration?
rerank()  : mixed
rerank items in model
rerank_control()  : mixed
rss()  : mixed
method to display an rss feed from this module
save_control()  : mixed
saveconfig()  : mixed
save module configuration
searchCategory()  : string
category of items searched in the module
searchHit()  : bool
additional check for display of search hit
searchName()  : string
type of items searched in the module
show()  : void
Display Record
showall()  : void
Display Report
showall_by_date_meta()  : array<string|int, mixed>
action specific metainfo
showall_by_tags()  : mixed
default module view method for all items with a specific tag
showall_by_tags_meta()  : array<string|int, mixed>
action specific metainfo
showByTags()  : mixed
view items referenced by tags
showByTitle()  : mixed
view the item by referring to its title
showRandom()  : mixed
view a random item
sortOrder()  : mixed
sql2csv()  : string
This converts the sql statement into a nice CSV.
submit_data()  : mixed
Form data is parsed and entered into database and/or email is sent used for both initial entry and editing records
supportsWorkflow()  : bool
does module support workflow?
tags()  : mixed
return all tags used by module's items
update()  : mixed
update (save) item in module
update_form()  : mixed
Updates the form
get_defaults()  : mixed
create a new default config array using the form defaults

Properties

$remove_configs

public mixed $remove_configs = array( 'aggregation', 'categories', 'comments', 'ealerts', 'facebook', 'files', // 'pagination', 'rss', 'tags', 'twitter', )

$useractions

public mixed $useractions = array('enterdata' => 'Input Records', 'showall' => 'Show All Records', 'show' => 'Show a Single Record')

$add_permissions

protected mixed $add_permissions = array('viewdata' => "View Data", 'enter_data' => "Enter Data")

$m_permissions

protected mixed $m_permissions = array( // standard set of actions requiring manage permission for all modules 'activate' => 'Activate', 'approve' => 'Approve', 'merge' => 'Merge', 'rerank' => 'ReRank', 'import' => 'Import Items', 'export' => 'Export Items', )

$manage_permissions

protected mixed $manage_permissions = array('design' => 'Design Form')

$permissions

protected mixed $permissions = array( // standard set of permissions for all modules unless add'ed or remove'd 'manage' => 'Manage', 'configure' => 'Configure', 'create' => 'Create', 'edit' => 'Edit', 'delete' => 'Delete', )

$remove_permissions

protected mixed $remove_permissions = array()

Methods

__construct()

public __construct([null $src = null ][, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$src : null = null
$params : array<string|int, mixed> = array()
Tags
throws
ReflectionException
Return values
mixed —

__get()

Generic magic method

public __get( $property) : null
Parameters
$property :
Return values
null —

__isset()

Generic magic method

public __isset( $property) : bool
Parameters
$property :
Return values
bool —

__set()

Generic magic method We MUST create/set non-existing properties for Exponent code to work

public __set( $property,  $value) : mixed
Parameters
$property :
$value :
Return values
mixed —

__unset()

Generic magic method

public __unset( $property) : mixed
Parameters
$property :
Return values
mixed —

activate()

Assign selected form to current module

public activate() : mixed
Return values
mixed —

add_search_record()

Create a Search record from a Form record

public add_search_record( $content,  $form) : int
Parameters
$content :
$form :
Tags
throws
ReflectionException
Return values
int —

addContentToSearch()

add saved form item or all saved form items to search index

public addContentToSearch() : int
Tags
throws
ReflectionException
Return values
int —

number of items added to search index

aggregateWhereClause()

The aggregateWhereClause function creates a sql where clause which also includes aggregated module content

public aggregateWhereClause([string $type = '' ]) : string
Parameters
$type : string = ''
Return values
string —

approve()

approve module item

public approve() : mixed
Return values
mixed —

author()

author of module

public static author() : string
Return values
string —

build_control()

Output a single control to an ajax request

public build_control() : mixed
Return values
mixed —

canExportData()

can this module export data?

public static canExportData() : bool
Return values
bool —

canHandleEAAS()

can this module export EAAS data?

public static canHandleEAAS() : bool
Return values
bool —

canImportData()

can this module import data?

public static canImportData() : bool
Return values
bool —

categories()

return all categories used by module's items

public categories() : mixed
Return values
mixed —

checkPermissions()

public static checkPermissions(mixed $permission, mixed $location) : mixed
Parameters
$permission : mixed
$location : mixed
Return values
mixed —

comments()

return all comments used by module's items

public comments() : mixed
Return values
mixed —

configure()

Configure the module

public configure() : mixed
Return values
mixed —

confirm_data()

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

public confirm_data() : mixed
Return values
mixed —

create()

create an item in this module

public create() : mixed
Tags
deprecated

in favor of edit w/o id param

Return values
mixed —

delete()

delete item in saved data

public delete() : mixed
Return values
mixed —

delete_control()

public delete_control() : mixed
Return values
mixed —

delete_form()

public delete_form() : mixed
Return values
mixed —

delete_In()

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

public delete_In( $loc) : mixed
Parameters
$loc :
Return values
mixed —

delete_instance()

delete module, config, and all its items

public delete_instance([bool $loc = false ]) : mixed
Parameters
$loc : bool = false
Tags
throws
ReflectionException
Return values
mixed —

delete_records()

delete all items in saved data

public delete_records() : mixed
Return values
mixed —

delete_search()

remove all module items from search index

public delete_search() : mixed
Return values
mixed —

description()

description of module

public static description() : string
Return values
string —

design_form()

public design_form() : mixed
Return values
mixed —

displayname()

name of module

public static displayname() : string
Return values
string —

downloadfile()

download a file attached to item

public downloadfile() : mixed
Return values
mixed —

eaasConfig()

returns info about Config template standard location is a folder named 'eaas' in the module's view folder with a model_name template

public eaasConfig() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —

eaasData()

returns module's EAAS data as an array of records

public eaasData([mixed $params = array() ][, mixed $where = null ]) : array<string|int, mixed>
Parameters
$params : mixed = array()
$where : mixed = null
Return values
array<string|int, mixed> —

edit()

edit item in module, also used to copy items

public edit() : mixed
Return values
mixed —

edit_control()

public edit_control() : mixed
Return values
mixed —

enter_data()

Old entry point

public enter_data() : void
Tags
deprecated
Return values
void —

enterdata()

Display Form

public enterdata() : void
Return values
void —

export_eql()

Export form, controls and optionally the data table

public export_eql() : mixed
Return values
mixed —

export_eql_process()

Export form, controls and optionally the data table

public export_eql_process() : mixed
Return values
mixed —

getModels()

get the model(s) associated with this module

public getModels() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getRSSContent()

get the module's items in an rss feed format

public getRSSContent(int $limit) : array<string|int, mixed>

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

Parameters
$limit : int
Return values
array<string|int, mixed> —

hasContent()

does module have content (stored items) available?

public static hasContent() : bool
Return values
bool —

hasSources()

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

public static hasSources() : bool
Return values
bool —

hasViews()

does module have views available?

public static hasViews() : bool
Return values
bool —

import_csv_data_add()

public import_csv_data_add() : mixed
Return values
mixed —

import_csv_data_display()

public import_csv_data_display() : mixed
Return values
mixed —

import_csv_data_mapper()

public import_csv_data_mapper() : mixed
Return values
mixed —

import_csv_form_add()

public import_csv_form_add() : mixed
Return values
mixed —

import_csv_form_prep()

public import_csv_form_prep() : mixed
Return values
mixed —

import_csv_mapper()

public import_csv_mapper() : mixed
Return values
mixed —

import_eql()

Import form, controls and optionally the data table

public import_eql() : mixed
Return values
mixed —

import_eql_process()

Import form, controls and optionally the data table

public import_eql_process() : mixed
Return values
mixed —

isSearchable()

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

public static isSearchable() : bool
Return values
bool —

manage()

Manage site forms

public manage() : mixed
Return values
mixed —

manage_ranks()

rerank module items, called from ddrerank

public manage_ranks() : mixed
Return values
mixed —

merge()

merge/move aggregated item into this module

public merge() : mixed
Return values
mixed —

meta_fb()

Returns Facebook og: meta data

public meta_fb( $request,  $object,  $canonical) : array<string|int, mixed>
Parameters
$request :
$object :
$canonical :
Return values
array<string|int, mixed> —

meta_rich()

Returns rich snippet PageMap meta data

public meta_rich( $request,  $object) : null
Parameters
$request :
$object :
Return values
null —

meta_tw()

Returns Twitter twitter: meta data

public meta_tw( $request,  $object,  $canonical) : array<string|int, mixed>
Parameters
$request :
$object :
$canonical :
Return values
array<string|int, mixed> —

metainfo()

get the metainfo for this module

public metainfo() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —

name()

name of module for backwards compat with old modules

public name() : string
Return values
string —

permissions()

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

public permissions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

permissions_all()

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

public permissions_all() : array<string|int, mixed>
Return values
array<string|int, mixed> —

requiresConfiguration()

does this module require configuration?

public static requiresConfiguration() : bool
Return values
bool —

rerank()

rerank items in model

public rerank() : mixed
Return values
mixed —

rerank_control()

public rerank_control() : mixed
Return values
mixed —

rss()

method to display an rss feed from this module

public rss() : mixed
Return values
mixed —

save_control()

public save_control() : mixed
Return values
mixed —

saveconfig()

save module configuration

public saveconfig() : mixed
Return values
mixed —

searchCategory()

category of items searched in the module

public searchCategory() : string
Return values
string —

searchHit()

additional check for display of search hit

public static searchHit( $record) : bool
Parameters
$record :
Return values
bool —

searchName()

type of items searched in the module

public searchName() : string
Return values
string —

showall()

Display Report

public showall() : void
Return values
void —

showall_by_date_meta()

action specific metainfo

public showall_by_date_meta( $request) : array<string|int, mixed>
Parameters
$request :
Return values
array<string|int, mixed> —

showall_by_tags()

default module view method for all items with a specific tag

public showall_by_tags() : mixed
Return values
mixed —

showall_by_tags_meta()

action specific metainfo

public showall_by_tags_meta( $request) : array<string|int, mixed>
Parameters
$request :
Return values
array<string|int, mixed> —

showByTags()

view items referenced by tags

public showByTags() : mixed
Tags
deprecated
Return values
mixed —

showByTitle()

view the item by referring to its title

public showByTitle() : mixed
Tags
deprecated
Return values
mixed —

showRandom()

view a random item

public showRandom() : mixed
Return values
mixed —

sortOrder()

public sortOrder(mixed $a, mixed $b) : mixed
Parameters
$a : mixed
$b : mixed
Return values
mixed —

sql2csv()

This converts the sql statement into a nice CSV.

public static sql2csv( $items[, array<string|int, mixed>|null $rptcols = null ]) : string

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

Parameters
$items :
$rptcols : array<string|int, mixed>|null = null
Return values
string —

submit_data()

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

public submit_data() : mixed
Return values
mixed —

supportsWorkflow()

does module support workflow?

public static supportsWorkflow() : bool
Return values
bool —

tags()

return all tags used by module's items

public tags() : mixed
Return values
mixed —

update()

update (save) item in module

public update() : mixed
Return values
mixed —

update_form()

Updates the form

public update_form() : mixed
Return values
mixed —

get_defaults()

create a new default config array using the form defaults

private get_defaults( $form) : mixed
Parameters
$form :
Return values
mixed —

Search results