| [ Index ] |
PHP Cross Reference of vtigercrm-6.1.0 |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 1489 lines (49 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Vtiger_Module_Model:: (89 methods):
getId()
getName()
isEntityModule()
isQuickCreateSupported()
isSummaryViewSupported()
getSingularLabelKey()
get()
set()
isActive()
isTrackingEnabled()
isCommentEnabled()
saveRecord()
deleteRecord()
getModuleMeta()
getColumnFieldMapping()
getListViewName()
getDetailViewName()
getEditViewName()
getDuplicateViewName()
getDeleteActionName()
getDefaultViewName()
getDefaultUrl()
getListViewUrl()
getCreateRecordUrl()
getQuickCreateUrl()
getImportUrl()
getExportUrl()
getFindDuplicatesUrl()
getDashBoardUrl()
getDetailViewUrl()
getRecordFromArray()
getBlocks()
getFields()
getFieldsByType()
getFieldsByLabel()
getFieldsById()
getRelations()
getQuickCreateFields()
getField()
getFieldByColumn()
getNameFields()
getRecentRecords()
getDeletedRecordCondition()
getPopupFields()
getRelatedListFields()
getConfigureRelatedListFields()
isWorkflowSupported()
hasSequenceNumberField()
getInstance()
getInstanceFromModuleObject()
getInstanceFromArray()
getAll()
getEntityModules()
getQuickCreateModules()
getSearchableModules()
preModuleInitialize2()
getPicklistSupportedModules()
getCleanInstance()
getSideBarLinks()
getExportQuery()
getDefaultCustomFilter()
getComments()
getHistory()
getCalendarActivities()
getRequiredFields()
isPermitted()
getSpecificRelationQuery()
getOwnerWhereConditionForDashBoards()
getSettingLinks()
isCustomizable()
isModuleUpgradable()
isExportable()
getSummaryViewFieldsList()
getSearchRecordsQuery()
searchRecord()
getRelationQuery()
getNonAdminAccessControlQueryForRelation()
getAlphabetSearchField()
getCumplosoryMandatoryFieldList()
vtJsonDependentModules()
getMandatoryFieldModels()
getRelatedModuleRecordIds()
transferRecordsOwnership()
getOrderBySql()
getDefaultSearchField()
getPopupViewFieldsList()
isQuickSearchEnabled()
isUtilityActionEnabled()
isListViewNameFieldNavigationEnabled()
Class: Vtiger_Module_Model - X-Ref
Vtiger Module Model Class| getId() X-Ref |
| Function to get the Module/Tab id return: <Number> |
| getName() X-Ref |
| No description |
| isEntityModule() X-Ref |
| Function to check whether the module is an entity type module or not return: <Boolean> true/false |
| isQuickCreateSupported() X-Ref |
| Function to check whether the module is enabled for quick create return: <Boolean> - true/false |
| isSummaryViewSupported() X-Ref |
| Function to check whether the module is summary view supported return: <Boolean> - true/false |
| getSingularLabelKey() X-Ref |
| Function to get singluar label key return: <String> - Singular module label key |
| get($propertyName) X-Ref |
| Function to get the value of a given property param: <String> $propertyName return: <Object> |
| set($propertyName, $propertyValue) X-Ref |
| Function to set the value of a given property param: <String> $propertyName param: <Object> $propertyValue return: Vtiger_Module_Model instance |
| isActive() X-Ref |
| Function checks if the module is Active return: <Boolean> |
| isTrackingEnabled() X-Ref |
| Function checks if the module is enabled for tracking changes return: <Boolean> |
| isCommentEnabled() X-Ref |
| Function checks if comment is enabled return: boolean |
| saveRecord($recordModel) X-Ref |
| Function to save a given record model of the current module param: Vtiger_Record_Model $recordModel |
| deleteRecord($recordModel) X-Ref |
| Function to delete a given record model of the current module param: Vtiger_Record_Model $recordModel |
| getModuleMeta($userModel = false) X-Ref |
| Function to get the module meta information param: <type> $userModel - user model |
| getColumnFieldMapping() X-Ref |
| Function to get the module field mapping return: <array> |
| getListViewName() X-Ref |
| Function to get the ListView Component Name return: string |
| getDetailViewName() X-Ref |
| Function to get the DetailView Component Name return: string |
| getEditViewName() X-Ref |
| Function to get the EditView Component Name return: string |
| getDuplicateViewName() X-Ref |
| Function to get the DuplicateView Component Name return: string |
| getDeleteActionName() X-Ref |
| Function to get the Delete Action Component Name return: string |
| getDefaultViewName() X-Ref |
| Function to get the Default View Component Name return: string |
| getDefaultUrl() X-Ref |
| Function to get the url for default view of the module return: <string> - url |
| getListViewUrl() X-Ref |
| Function to get the url for list view of the module return: <string> - url |
| getCreateRecordUrl() X-Ref |
| Function to get the url for the Create Record view of the module return: <String> - url |
| getQuickCreateUrl() X-Ref |
| Function to get the url for the Create Record view of the module return: <String> - url |
| getImportUrl() X-Ref |
| Function to get the url for the Import action of the module return: <String> - url |
| getExportUrl() X-Ref |
| Function to get the url for the Export action of the module return: <String> - url |
| getFindDuplicatesUrl() X-Ref |
| Function to get the url for the Find Duplicates action of the module return: <String> - url |
| getDashBoardUrl() X-Ref |
| Function to get the url to view Dashboard for the module return: <String> - url |
| getDetailViewUrl($id) X-Ref |
| Function to get the url to view Details for the module return: <String> - url |
| getRecordFromArray($valueArray, $rawData=false) X-Ref |
| Function to get a Vtiger Record Model instance from an array of key-value mapping param: <Array> $valueArray return: Vtiger_Record_Model or Module Specific Record Model instance |
| getBlocks() X-Ref |
| Function returns all the blocks for the module return: <Array of Vtiger_Block_Model> - list of block models |
| getFields($blockInstance=false) X-Ref |
| Function that returns all the fields for the module return: <Array of Vtiger_Field_Model> - list of field models |
| getFieldsByType($type) X-Ref |
| Function gives fields based on the type param: <String> $type - field type return: <Array of Vtiger_Field_Model> - list of field models |
| getFieldsByLabel() X-Ref |
| Function gives fields based on the type return: <Vtiger_Field_Model> with field label as key |
| getFieldsById() X-Ref |
| Function gives fields based on the fieldid return: <Vtiger_Field_Model> with field id as key |
| getRelations() X-Ref |
| Function returns all the relation models return: <Array of Vtiger_Relation_Model> |
| getQuickCreateFields() X-Ref |
| Function that returns all the quickcreate fields for the module return: <Array of Vtiger_Field_Model> - list of field models |
| getField($fieldName) X-Ref |
| Function to get the field mode param: <String> $fieldName - field name return: <Vtiger_Field_Model> |
| getFieldByColumn($columnName) X-Ref |
| Function to get the field by column name. param: <String> $columnName - column name return: <Vtiger_Field_Model> |
| getNameFields() X-Ref |
| Function to retrieve name fields of a module return: <array> - array which contains fields which together construct name fields |
| getRecentRecords($limit=10) X-Ref |
| Function to get the list of recently visisted records param: <Number> $limit return: <Array> - List of Vtiger_Record_Model or Module Specific Record Model instances |
| getDeletedRecordCondition() X-Ref |
| Function that returns deleted records condition return: <String> |
| getPopupFields() X-Ref |
| Funtion that returns fields that will be showed in the record selection popup return: <Array of fields> |
| getRelatedListFields() X-Ref |
| Function that returns related list header fields that will be showed in the Related List View return: <Array> returns related fields list. |
| getConfigureRelatedListFields() X-Ref |
| No description |
| isWorkflowSupported() X-Ref |
| No description |
| hasSequenceNumberField() X-Ref |
| Function checks if a module has module sequence numbering return: boolean |
| getInstance($value) X-Ref |
| Static Function to get the instance of Vtiger Module Model for the given id or name param: mixed id or name of the module |
| getInstanceFromModuleObject(Vtiger_Module $moduleObj) X-Ref |
| Function to get the instance of Vtiger Module Model from a given Vtiger_Module object param: Vtiger_Module $moduleObj return: Vtiger_Module_Model instance |
| getInstanceFromArray($valueArray) X-Ref |
| Function to get the instance of Vtiger Module Model from a given list of key-value mapping param: <Array> $valueArray return: Vtiger_Module_Model instance |
| getAll($presence = array() X-Ref |
| Function to get all modules from CRM param: <array> $presence param: <array> $restrictedModulesList return: <array> List of module models <Vtiger_Module_Model> |
| getEntityModules() X-Ref |
| No description |
| getQuickCreateModules() X-Ref |
| Function to get the list of all accessible modules for Quick Create return: <Array> - List of Vtiger_Record_Model or Module Specific Record Model instances |
| getSearchableModules() X-Ref |
| Function to get the list of all searchable modules return: <Array> - List of Vtiger_Module_Model instances |
| preModuleInitialize2() X-Ref |
| No description |
| getPicklistSupportedModules() X-Ref |
| No description |
| getCleanInstance($moduleName) X-Ref |
| No description |
| getSideBarLinks($linkParams) X-Ref |
| Function to get the Quick Links for the module param: <Array> $linkParams return: <Array> List of Vtiger_Link_Model instances |
| getExportQuery($focus, $where) X-Ref |
| Function returns export query - deprecated param: <String> $where return: <String> export query |
| getDefaultCustomFilter() X-Ref |
| Function returns the default custom filter for the module return: <Int> custom filter id |
| getComments($pagingModel) X-Ref |
| Function returns latest comments for the module param: <Vtiger_Paging_Model> $pagingModel return: <Array> |
| getHistory($pagingModel, $type=false) X-Ref |
| Function returns comments and recent activities across module param: <Vtiger_Paging_Model> $pagingModel param: <String> $type - comments, updates or all return: <Array> |
| getCalendarActivities($mode, $pagingModel, $user, $recordId = false) X-Ref |
| Function returns the Calendar Events for the module param: <String> $mode - upcoming/overdue mode param: <Vtiger_Paging_Model> $pagingModel - $pagingModel param: <String> $user - all/userid param: <String> $recordId - record id return: <Array> |
| getRequiredFields($module = '') X-Ref |
| Function to get list of fields which are required while importing records param: <String> $module return: <Array> list of fields |
| isPermitted($actionName) X-Ref |
| Function to get the module is permitted to specific action param: <String> $actionName return: <boolean> |
| getSpecificRelationQuery($relatedModule) X-Ref |
| Function to get Specific Relation Query for this Module param: <type> $relatedModule return: <type> |
| getOwnerWhereConditionForDashBoards($owner) X-Ref |
| Function to get where condition query for dashboards param: <Integer> $owner return: <String> query |
| getSettingLinks() X-Ref |
| Function to get Settings links return: <Array> |
| isCustomizable() X-Ref |
| No description |
| isModuleUpgradable() X-Ref |
| No description |
| isExportable() X-Ref |
| No description |
| getSummaryViewFieldsList() X-Ref |
| Function to get list of field for summary view return: <Array> list of field models <Vtiger_Field_Model> |
| getSearchRecordsQuery($searchValue, $parentId=false, $parentModule=false) X-Ref |
| Function returns query for module record's search param: <String> $searchValue - part of record name (label column of crmentity table) param: <Integer> $parentId - parent record id param: <String> $parentModule - parent module name return: <String> - query |
| searchRecord($searchValue, $parentId=false, $parentModule=false, $relatedModule=false) X-Ref |
| Function searches the records in the module, if parentId & parentModule is given then searches only those records related to them. param: <String> $searchValue - Search value param: <Integer> $parentId - parent recordId param: <String> $parentModule - parent module name return: <Array of Vtiger_Record_Model> |
| getRelationQuery($recordId, $functionName, $relatedModule) X-Ref |
| Function to get relation query for particular module with function name param: <record> $recordId param: <String> $functionName param: Vtiger_Module_Model $relatedModule return: <String> |
| getNonAdminAccessControlQueryForRelation($relatedModuleName) X-Ref |
| Function to get Non admin access control query param: <String> $relatedModuleName return: <String> |
| getAlphabetSearchField() X-Ref |
| Function returns the default column for Alphabetic search return: <String> columnname |
| getCumplosoryMandatoryFieldList() X-Ref |
| Function which will give complusory mandatory fields return: type |
| vtJsonDependentModules() X-Ref |
| Function returns all the related modules for workflows create entity task return: <JSON> |
| getMandatoryFieldModels() X-Ref |
| Function returns mandatory field Models return: <Array of Vtiger_Field_Model> |
| getRelatedModuleRecordIds(Vtiger_Request $request, $recordIds = array() X-Ref |
| No description |
| transferRecordsOwnership($transferOwnerId, $relatedModuleRecordIds) X-Ref |
| No description |
| getOrderBySql($orderBy) X-Ref |
| Function to get orderby sql from orderby field |
| getDefaultSearchField() X-Ref |
| No description |
| getPopupViewFieldsList() X-Ref |
| Function to get popup view fields |
| isQuickSearchEnabled() X-Ref |
| Funxtion to identify if the module supports quick search or not |
| isUtilityActionEnabled() X-Ref |
| function to check if the extension module is permitted for utility action return: <boolean> false |
| isListViewNameFieldNavigationEnabled() X-Ref |
| No description |
| Generated: Fri Nov 28 20:08:37 2014 | Cross-referenced by PHPXref 0.7.1 |