UsersModule Class Reference

Inheritance diagram for UsersModule:
SecurableModule Module

Public Member Functions

 canDisable ()
 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getTranslatedPolicyLabels ()
static getStrongerPolicy ($policyName, array $values)
static getPolicyRulesTypes ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static getAccessRight ()
static getCreateRight ()
static stringifyAuditEvent (AuditEvent $auditEvent, $format= 'long')
static getDemoDataMakerClassNames ()
static getGlobalSearchFormClassName ()
static modelsAreNeverGloballySearched ()

Data Fields

const RIGHT_CHANGE_USER_PASSWORDS = 'Change User Passwords'
const RIGHT_LOGIN_VIA_WEB = 'Login Via Web'
const RIGHT_LOGIN_VIA_MOBILE = 'Login Via Mobile'
const RIGHT_LOGIN_VIA_WEB_API = 'Login Via Web API'
const RIGHT_CREATE_USERS = 'Create Users'
const RIGHT_ACCESS_USERS = 'Access Users Tab'
const POLICY_ENFORCE_STRONG_PASSWORDS = 'Enforce Strong Passwords'
const POLICY_MINIMUM_PASSWORD_LENGTH = 'Minimum Password Length'
const POLICY_MINIMUM_USERNAME_LENGTH = 'Minimum Username Length'
const POLICY_PASSWORD_EXPIRES = 'Password Expires'
const POLICY_PASSWORD_EXPIRY_DAYS = 'Password Expiry Days'
const AUDIT_EVENT_USER_LOGGED_IN = 'User Logged In'
const AUDIT_EVENT_USER_LOGGED_OUT = 'User Logged Out'
const AUDIT_EVENT_USER_PASSWORD_CHANGED = 'User Password Changed'

Static Protected Member Functions

static getSingularModuleLabel ($language)
static getPluralModuleLabel ($language)

Static Protected Attributes

static $policyDefaults

Detailed Description

Definition at line 37 of file UsersModule.php.


Member Function Documentation

canDisable (  ) 

Returns whether the module is can be disabled. Modules that must not be disabled must override and return false.

Reimplemented from Module.

Definition at line 64 of file UsersModule.php.

getDependencies (  ) 

Returns an array of the names of the the modules the module depends on. ie: if the module is enabled then those modules must be too, recursively through their dependencies.

Reimplemented from Module.

Definition at line 69 of file UsersModule.php.

getRootModelNames (  ) 

Implement in all modules that have models. The root models are the models that if they are created, then their related models are created, and so on recursively, then all of module's models will have been created, allowing RedBean to create all of the required tables and columns.

Reimplemented from Module.

Definition at line 76 of file UsersModule.php.

static getPolicyRulesTypes (  )  [static]
Returns:
array of Policy / PolicyRulesType pairings

Reimplemented from SecurableModule.

Definition at line 129 of file UsersModule.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from Module.

Definition at line 141 of file UsersModule.php.

static getPrimaryModelName (  )  [static]

Get the primary model name for a module. Make sure to override in modules that have a Primary model otherwise the method is not supported.

Reimplemented from Module.

Definition at line 209 of file UsersModule.php.

static getAccessRight (  )  [static]

Override if the module has a right that determines if a user can access the module tab/subtabs in the user interface.

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 214 of file UsersModule.php.

static getCreateRight (  )  [static]

Override if the module has a right that determines if a user can create the models in this modules

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 219 of file UsersModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 269 of file UsersModule.php.

static getGlobalSearchFormClassName (  )  [static]

Even though users are never globally searched, the search form can still be used by a specific search view for a module. Either this module or a related module. This is why a class is returned.

See also:
modelsAreNeverGloballySearched controls it not being searchable though in the global search.

Reimplemented from Module.

Definition at line 279 of file UsersModule.php.

static modelsAreNeverGloballySearched (  )  [static]

Override when there is a module that can have module scoping or special search fields in the module list/search view but is not globally searchable. Activities are an example of this or users.

Reimplemented from Module.

Definition at line 284 of file UsersModule.php.

static getSingularModuleLabel ( language  )  [static, protected]

Override in all children modules to ensure proper availability of module labels in the translation system. If the override is not available, then it will generate a label as a last resort.

Parameters:
string $language
Returns:
string - singular module label.

Reimplemented from Module.

Definition at line 289 of file UsersModule.php.

static getPluralModuleLabel ( language  )  [static, protected]

Override in all children modules to ensure proper availability of module labels in the translation system If the override is not available, then it will generate a label as a last resort.

Parameters:
string $language
Returns:
string - plural module label

Reimplemented from Module.

Definition at line 294 of file UsersModule.php.


Field Documentation

$policyDefaults [static, protected]
Initial value:
 array(
            self::POLICY_ENFORCE_STRONG_PASSWORDS => null,
            self::POLICY_MINIMUM_PASSWORD_LENGTH  => 5,
            self::POLICY_MINIMUM_USERNAME_LENGTH  => 3,
            self::POLICY_PASSWORD_EXPIRES         => null,
            self::POLICY_PASSWORD_EXPIRY_DAYS     => null,
        )

Reimplemented from SecurableModule.

Definition at line 56 of file UsersModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Jul 24 07:10:31 2017