usersController
extends expController
in package
This is the class expController
Tags
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
- addContentToSearch() : int
- add module item or all 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
- boot_user() : mixed
- 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
- change_password() : mixed
- change_password_token() : mixed
- checkPermissions() : mixed
- comments() : mixed
- return all comments used by module's items
- configure() : mixed
- Configure the module
- confirm_password_reset() : mixed
- create() : mixed
- create an item in this module
- delete() : mixed
- delete item in module
- delete_group() : 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_search() : mixed
- remove all module items from search index
- description() : string
- description of module
- 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_group() : mixed
- edit_userpassword() : mixed
- edituser() : mixed
- 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
- getUsersByJSON() : mixed
- getUsersByJSON2() : mixed
- For server-side population of DataTables user list
- getUsersByJSON3() : mixed
- For server-side population of DataTables group membership list
- groupperms() : mixed
- groupperms_save() : mixed
- 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() : mixed
- import_users_add() : mixed
- import_users_display() : mixed
- import_users_mapper() : mixed
- import_users_process() : mixed
- isSearchable() : bool
- is module content searchable? should it be added to search index?
- kill_session() : mixed
- manage() : mixed
- display module management view
- manage_extensions() : mixed
- * This function scans two directories and searches for php files to add to the extensions database.
- manage_group_memberships() : mixed
- manage_groups() : mixed
- manage_ranks() : mixed
- rerank module items, called from ddrerank
- manage_sessions() : mixed
- 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
- reset_password() : mixed
- rss() : mixed
- method to display an rss feed from this module
- save_change_password() : 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
- send_new_password() : mixed
- show() : mixed
- default view for individual item
- showall() : mixed
- default module view method for all items
- 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
- supportsWorkflow() : bool
- does module support workflow?
- sync_LDAPUsers() : mixed
- tags() : mixed
- return all tags used by module's items
- toggle_extension() : mixed
- update() : mixed
- update (save) item in module
- update_group() : mixed
- update_memberships() : mixed
- update_userpassword() : mixed
- userperms() : mixed
- userperms_save() : mixed
- viewuser() : mixed
Properties
$asset_path
public
mixed
$asset_path
= ''
$baseclassname
public
mixed
$baseclassname
= ''
$basemodel_name
public
mixed
$basemodel_name
= 'user'
$classinfo
public
mixed
$classinfo
= \null
$codequality
public
mixed
$codequality
= 'stable'
$config
public
mixed
$config
= array()
$filepath
public
mixed
$filepath
= ''
$loc
public
mixed
$loc
= \null
$model_table
public
mixed
$model_table
= ''
$params
public
mixed
$params
= array()
$relative_viewpath
public
mixed
$relative_viewpath
= ''
$remove_configs
public
mixed
$remove_configs
= array()
$requires_login
public
mixed
$requires_login
= array('change_password' => 'You may not change a password without being logged in.')
$rss_is_podcast
public
mixed
$rss_is_podcast
= \false
$useractions
public
mixed
$useractions
= array()
$viewpath
public
mixed
$viewpath
= ''
$add_permissions
protected
mixed
$add_permissions
= array()
$classname
protected
mixed
$classname
= ''
$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(
'edit' => 'Edit Users',
'toggle_extension' => 'Activate Extensions',
'kill_session' => 'End Sessions',
'boot_user' => 'Boot Users',
'userperms' => 'User Permissions',
'groupperms' => 'Group Permissions',
'import' => 'Import Users',
'export' => 'Export Users',
// 'update' => 'Update Users',
'show' => 'Show User',
'showall' => 'Show Users',
'getUsersByJSON' => 'Get Users',
'getUsersByJSON2' => 'Get Users',
'getUsersByJSON3' => 'Get Users',
)
$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('create')
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
Return values
mixed —__get()
Generic magic method
public
__get( $property) : null
Parameters
Return values
null —__isset()
Generic magic method
public
__isset( $property) : bool
Parameters
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
Return values
mixed —__unset()
Generic magic method
public
__unset( $property) : mixed
Parameters
Return values
mixed —addContentToSearch()
add module item or all items to search index
public
addContentToSearch() : int
Tags
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 —boot_user()
public
boot_user() : 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 —change_password()
public
change_password() : mixed
Return values
mixed —change_password_token()
public
change_password_token() : 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_password_reset()
public
confirm_password_reset() : mixed
Return values
mixed —create()
create an item in this module
public
create() : mixed
Return values
mixed —delete()
delete item in module
public
delete() : mixed
Return values
mixed —delete_group()
public
delete_group() : mixed
Return values
mixed —delete_In()
delete module and all its items for backwards compat with old modules
public
delete_In( $loc) : mixed
Parameters
Return values
mixed —delete_instance()
delete module, config, and all its items
public
delete_instance([bool $loc = false ]) : mixed
Parameters
- $loc : bool = false
Tags
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 —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_group()
public
edit_group() : mixed
Return values
mixed —edit_userpassword()
public
edit_userpassword() : mixed
Return values
mixed —edituser()
public
edituser() : 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> —getUsersByJSON()
public
getUsersByJSON() : mixed
Return values
mixed —getUsersByJSON2()
For server-side population of DataTables user list
public
getUsersByJSON2() : mixed
Return values
mixed —getUsersByJSON3()
For server-side population of DataTables group membership list
public
getUsersByJSON3() : mixed
Return values
mixed —groupperms()
public
groupperms() : mixed
Return values
mixed —groupperms_save()
public
groupperms_save() : mixed
Return values
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()
public
import() : mixed
Return values
mixed —import_users_add()
public
import_users_add() : mixed
Return values
mixed —import_users_display()
public
import_users_display() : mixed
Return values
mixed —import_users_mapper()
public
import_users_mapper() : mixed
Return values
mixed —import_users_process()
public
import_users_process() : mixed
Return values
mixed —isSearchable()
is module content searchable? should it be added to search index?
public
static isSearchable() : bool
Return values
bool —kill_session()
public
kill_session() : mixed
Return values
mixed —manage()
display module management view
public
manage() : mixed
Return values
mixed —manage_extensions()
* This function scans two directories and searches for php files to add to the extensions database.
public
manage_extensions() : mixed
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.
Return values
mixed —manage_group_memberships()
public
manage_group_memberships() : mixed
Return values
mixed —manage_groups()
public
manage_groups() : mixed
Return values
mixed —manage_ranks()
rerank module items, called from ddrerank
public
manage_ranks() : mixed
Return values
mixed —manage_sessions()
public
manage_sessions() : 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
Return values
array<string|int, mixed> —meta_rich()
Returns rich snippet PageMap meta data
public
meta_rich( $request, $object) : null
Parameters
Return values
null —meta_tw()
Returns Twitter twitter: meta data
public
meta_tw( $request, $object, $canonical) : array<string|int, mixed>
Parameters
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 —reset_password()
public
reset_password() : mixed
Return values
mixed —rss()
method to display an rss feed from this module
public
rss() : mixed
Return values
mixed —save_change_password()
public
save_change_password() : 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
Return values
bool —searchName()
type of items searched in the module
public
searchName() : string
Return values
string —send_new_password()
public
send_new_password() : mixed
Return values
mixed —show()
default view for individual item
public
show() : mixed
Return values
mixed —showall()
default module view method for all items
public
showall() : mixed
Return values
mixed —showall_by_date_meta()
action specific metainfo
public
showall_by_date_meta( $request) : array<string|int, mixed>
Parameters
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
Return values
array<string|int, mixed> —showByTags()
view items referenced by tags
public
showByTags() : mixed
Tags
Return values
mixed —showByTitle()
view the item by referring to its title
public
showByTitle() : mixed
Tags
Return values
mixed —showRandom()
view a random item
public
showRandom() : mixed
Return values
mixed —supportsWorkflow()
does module support workflow?
public
static supportsWorkflow() : bool
Return values
bool —sync_LDAPUsers()
public
sync_LDAPUsers() : mixed
Return values
mixed —tags()
return all tags used by module's items
public
tags() : mixed
Return values
mixed —toggle_extension()
public
toggle_extension() : mixed
Return values
mixed —update()
update (save) item in module
public
update() : mixed
Return values
mixed —update_group()
public
update_group() : mixed
Return values
mixed —update_memberships()
public
update_memberships() : mixed
Return values
mixed —update_userpassword()
public
update_userpassword() : mixed
Return values
mixed —userperms()
public
userperms() : mixed
Return values
mixed —userperms_save()
public
userperms_save() : mixed
Return values
mixed —viewuser()
public
viewuser() : mixed