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


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:

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 (  ) 
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]
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:

Definition at line 118 of file Module.php.

static getSingularCamelCasedName (  )  [static]
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'.

Reimplemented in ApiModule, CalendarsModule, OpportunitiesModule, ProductsModule, ProductTemplatesModule, and ProjectsModule.

Definition at line 131 of file Module.php.

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

Definition at line 142 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.

Reimplemented in InstallModule, UsersModule, GroupsModule, RolesModule, and ZurmoModule.

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.

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.

Reimplemented in AccountsModule, ActivitiesModule, ApiModule, AutorespondersModule, CalendarsModule, CampaignsModule, CommentsModule, ContactsModule, ContactWebFormsModule, ConversationsModule, EmailMessagesModule, EmailTemplatesModule, ExportModule, GameRewardsModule, GamificationModule, HomeModule, ImportModule, InstallModule, JobsManagerModule, LeadsModule, MapsModule, MarketingListsModule, MeetingsModule, MissionsModule, NotesModule, NotificationsModule, OpportunitiesModule, ProductsModule, ProductTemplatesModule, ProjectsModule, ReportsModule, SendGridModule, SocialItemsModule, TasksModule, UsersModule, WorkflowsModule, GroupsModule, ImagesModule, RolesModule, and ZurmoModule.

Definition at line 340 of file Module.php.

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

Reimplemented in UsersModule, and SecurableModule.

Definition at line 357 of file Module.php.

getConfigurationView (  ) 


Definition at line 365 of file Module.php.

static getTabMenuItems ( user = null  )  [static]


Definition at line 373 of file Module.php.

static getAdminTabMenuItems ( user = null  )  [static]


Reimplemented in DesignerModule.

Definition at line 387 of file Module.php.

static getConfigureMenuItems (  )  [static]


Definition at line 401 of file Module.php.

static getGlobalSearchFormClassName (  )  [static]
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 in AccountContactAffiliationsModule, AutorespondersModule, CalendarsModule, CampaignsModule, ContactWebFormsModule, EmailTemplatesModule, ExportModule, GameRewardsModule, MarketingListsModule, MeetingsModule, NotesModule, ProductsModule, ProductTemplatesModule, ReportsModule, SocialItemsModule, TasksModule, UsersModule, WorkflowsModule, and ImagesModule.

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


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.

Reimplemented in ContactsModule, and LeadsModule.

Definition at line 491 of file Module.php.

static getMetadata ( User user = null  )  [static]

Returns metadata for the module.

See also:
$user The current user.
An array of metadata.

Definition at line 502 of file Module.php.

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

Sets new metadata.

$metadata An array of metadata.
$user The current user.

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

Reimplemented in AccountContactAffiliationsModule, AccountsModule, ContactsModule, EmailMessagesModule, EmailTemplatesModule, MeetingsModule, OpportunitiesModule, ProductsModule, ProjectsModule, WorkflowsModule, GroupsModule, and ZurmoModule.

Definition at line 588 of file Module.php.

static isReportable (  )  [static]
static canHaveWorkflow (  )  [static]

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

Reimplemented in AccountsModule, CalendarsModule, ContactsModule, MeetingsModule, NotesModule, OpportunitiesModule, ProductsModule, ProjectsModule, and TasksModule.

Definition at line 610 of file Module.php.

static canHaveContentTemplates (  )  [static]

Override in modules that can be used in content templates

Reimplemented in AccountsModule, CalendarsModule, ContactsModule, MeetingsModule, NotesModule, OpportunitiesModule, ProductsModule, ProjectsModule, and TasksModule.

Definition at line 618 of file Module.php.

static canShowOnCalendar (  )  [static]

Override in modules that can be used in calendar module

Reimplemented in MeetingsModule, ProductsModule, and TasksModule.

Definition at line 626 of file Module.php.

The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Aug 18 07:10:58 2019