Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Static Protected Member Functions
Module Class Reference
Inheritance diagram for Module:
ActivitiesModule AutorespondersModule CCCModule CommentsModule GamificationModule IIIModule ImagesModule InstallModule MashableInboxForTestsModule MashableInboxModule NotificationsModule ReportsAlternateStateTestModule RssReaderModule SecurableModule TestModule TrackingModule

Public Member Functions

 getName ()
 
 isEnabled ()
 
 canDisable ()
 
 setIsEnabled ($isEnabled)
 
 getDependencies ()
 
 getEnabledDependencies ($temp=null)
 
 getRootModelNamesIncludingDependencies ()
 
 getRootModelNames ()
 
 getConfigurationView ()
 
 getDesignerMenuItems ()
 

Static Public Member Functions

static getModuleObjects ()
 
static getDependenciesForModule (Module $module, $dependencies=array())
 
static getDirectoryName ()
 
static getSingularCamelCasedName ()
 
static getPluralCamelCasedName ()
 
static getModuleLabelByTypeAndLanguage ($type, $language=null)
 
static getStrongerPolicy ($policyName, array $values)
 
static getPolicyRulesTypes ()
 
static getTabMenuItems ($user=null)
 
static getAdminTabMenuItems ($user=null)
 
static getConfigureMenuItems ()
 
static getConfigureSubMenuItems ()
 
static getShortCutsCreateMenuItems ()
 
static getPrimaryModelName ()
 
static getGlobalSearchFormClassName ()
 
static modelsAreNeverGloballySearched ()
 
static hasAtLeastOneGlobalSearchAttributeName ()
 
static getStateMetadataAdapterClassName ()
 
static getMetadata (User $user=null)
 
static setMetadata (array $metadata, User $user=null)
 
static getDefaultMetadata ()
 
static getViewClassNames ()
 
static getModelClassNames ()
 
static getAllClassNamesByPathFolder ($folder)
 
static getDefaultDataMakerClassName ()
 
static getDemoDataMakerClassNames ()
 
static isReportable ()
 
static canHaveWorkflow ()
 
static canHaveContentTemplates ()
 
static canShowOnCalendar ()
 

Static Protected Member Functions

static getSingularModuleLabel ($language)
 
static getPluralModuleLabel ($language)
 
static getCustomModuleLabelByTypeAndLanguage ($type, $language)
 

Detailed Description

TODO

Definition at line 40 of file Module.php.

Member Function Documentation

static getModuleObjects ( )
static

Returns an array of module objects, keyed by module id. Should be called getModules, but the badly named Yii method getModules(), which whould be called something like getModuleConfigurations(), is in the way.

See Also
getModuleNames()

Definition at line 51 of file Module.php.

static getDependenciesForModule ( Module  $module,
  $dependencies = array() 
)
static

Returns an array which is the flattened dependencies for given module.

Definition at line 84 of file Module.php.

getName ( )
Returns
the name of this module, which is the name of the module's directory under protected/modules.

Definition at line 106 of file Module.php.

static getDirectoryName ( )
static
Returns
the name of this module, which is the name of the module's directory under protected/modules. Same method as getName, but getName cannot be static.
See Also
Module::getName

Definition at line 118 of file Module.php.

static getSingularCamelCasedName ( )
static
Returns
the singular name of the module for example 'Account' keeping the uppercase letters. Override if the module's pluralized name cannot be changed to singular by simply removing the end 's'.

Definition at line 131 of file Module.php.

static getPluralCamelCasedName ( )
static
Returns
the plural name of the module for example 'Accounts' keeping the uppercase letters.

Definition at line 142 of file Module.php.

static getSingularModuleLabel (   $language)
staticprotected

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.

Definition at line 155 of file Module.php.

static getPluralModuleLabel (   $language)
staticprotected

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

Definition at line 168 of file Module.php.

isEnabled ( )

Returns whether the module is enabled.

Definition at line 243 of file Module.php.

canDisable ( )

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

Definition at line 252 of file Module.php.

setIsEnabled (   $isEnabled)

If setting isEnabled = true then dependent modules which are not enabled will be recursively enabled. If setting isEnabled = false only this module will be disabled.

Definition at line 262 of file Module.php.

getDependencies ( )
abstract

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.

getEnabledDependencies (   $temp = null)

Returns an array of the dependency modules that are disabled.

Definition at line 294 of file Module.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.

Definition at line 340 of file Module.php.

static getPolicyRulesTypes ( )
static
Returns
array of Policy / PolicyRulesType pairings

Definition at line 357 of file Module.php.

getConfigurationView ( )

TODO

Definition at line 365 of file Module.php.

static getTabMenuItems (   $user = null)
static

TODO

Definition at line 373 of file Module.php.

static getAdminTabMenuItems (   $user = null)
static

TODO

Definition at line 387 of file Module.php.

static getConfigureMenuItems ( )
static

TODO

Definition at line 401 of file Module.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.

Definition at line 448 of file Module.php.

static getGlobalSearchFormClassName ( )
static

Override and return a string if the module supports the global search mechanism.

Returns
null if not supported otherwise return the appropriate string.

Definition at line 457 of file Module.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.

Definition at line 466 of file Module.php.

static hasAtLeastOneGlobalSearchAttributeName ( )
static

Return true if module has any global search attribute names available to search on

Returns
bool

Definition at line 475 of file Module.php.

static getStateMetadataAdapterClassName ( )
static

Override and return a string of the StatemetadataAdataper class if the module's primary model supports states. An example is leads or contacts where the lead is only contacts in a certain state.

Definition at line 491 of file Module.php.

static getMetadata ( User  $user = null)
static

Returns metadata for the module.

See Also
getDefaultMetadata()
Parameters
$userThe current user.
Returns
An array of metadata.

Definition at line 502 of file Module.php.

static setMetadata ( array  $metadata,
User  $user = null 
)
static

Sets new metadata.

Parameters
$metadataAn array of metadata.
$userThe current user.

Definition at line 533 of file Module.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.

Definition at line 552 of file Module.php.

static getModelClassNames ( )
static

For a given module, return an array of models that are in that module.

Definition at line 565 of file Module.php.

static getDefaultDataMakerClassName ( )
static

Override in modules that create default data during an installation.

Definition at line 588 of file Module.php.

static getDemoDataMakerClassNames ( )
static

Override in modules that create demo data during an installation.

Definition at line 595 of file Module.php.

static isReportable ( )
static

Override in modules that are reportable in the reporting module

Definition at line 602 of file Module.php.

static canHaveWorkflow ( )
static

Override in modules that can have workflow rules in the workflow module

Definition at line 610 of file Module.php.

static canHaveContentTemplates ( )
static

Override in modules that can be used in content templates

Definition at line 618 of file Module.php.

static canShowOnCalendar ( )
static

Override in modules that can be used in calendar module

Definition at line 626 of file Module.php.


The documentation for this class was generated from the following file:
Generated on Mon Nov 30 2020 07:11:06
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.