Exponent v2.4.3
Back to top  

usersController

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

boot_user

boot_user()

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_password

change_password()

checkPermissions

checkPermissions( $permission,  $location)
inherited static

Arguments

$permission

$location

return all comments used by module's items

comments()
inherited

Configure the module

configure()
inherited

confirm_password_reset

confirm_password_reset()

create an item in this module

create()
inherited
deprecated

in favor of edit w/o id param

delete item in module

delete()
inherited

delete_group

delete_group()

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

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

edit_group

edit_group()

edit_userpassword

edit_userpassword()

edituser

edituser()

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

getUsersByJSON

getUsersByJSON()

For server-side population of DataTables

getUsersByJSON2()

groupperms

groupperms()

groupperms_save

groupperms_save()

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

import()

import_users_add

import_users_add()

import_users_display

import_users_display()

import_users_mapper

import_users_mapper()

import_users_process

import_users_process()

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

isSearchable() : boolean
inherited static

Response

boolean

kill_session

kill_session()

display module management view

manage()
inherited

 * This function scans two directories and searches for php files to add to the extensions database.

manage_extensions()

If you have added new extensions since the last time you have visited the page, it will add them to the database in effect enabling your new extension to be tacked onto users profiles. You then have to enable it in the menu, but at least now it is in the system and when the user goes to edit his profile, it will check for extensions and this one will be in!

 * @global string This function uses the global $db save information through the Exponenet database connection.

manage_group_memberships

manage_group_memberships()

manage_groups

manage_groups()

rerank module items, called from ddrerank

manage_ranks()
inherited

manage_sessions

manage_sessions()

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

reset_password

reset_password()

method to display an rss feed from this module

rss()
inherited

save_change_password

save_change_password()

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

send_new_password

send_new_password()

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

sync_LDAPUsers

sync_LDAPUsers()

return all tags used by module's items

tags()
inherited

toggle_extension

toggle_extension()

update (save) item in module

update()
inherited

update_group

update_group()

update_memberships

update_memberships()

update_userpassword

update_userpassword()

userperms

userperms()

userperms_save

userperms_save()

viewuser

viewuser()

Properties

basemodel_name

basemodel_name :
inherited

Type(s)

remove_permissions

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

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)