[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/modules/Settings/Roles/models/ -> Record.php (summary)

(no description)

File Size: 506 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Settings_Roles_Record_Model:: (27 methods):
  getId()
  getName()
  getDepth()
  getParentRoleString()
  setParent()
  getParent()
  getChildren()
  getSameLevelRoles()
  getAllChildren()
  getProfileIdList()
  getDirectlyRelatedProfileId()
  getEditViewUrl()
  getCreateChildUrl()
  getDeleteActionUrl()
  getPopupWindowUrl()
  getProfiles()
  addChildRole()
  moveTo()
  save()
  delete()
  getRecordLinks()
  getInstanceFromQResult()
  getAll()
  getInstanceById()
  getBaseRole()
  getInstanceByName()
  getUsers()


Class: Settings_Roles_Record_Model  - X-Ref

Roles Record Model Class

getId()   X-Ref
Function to get the Id

return: <Number> Role Id

getName()   X-Ref
Function to get the Role Name

return: <String>

getDepth()   X-Ref
Function to get the depth of the role

return: <Number>

getParentRoleString()   X-Ref
Function to get Parent Role hierarchy as a string

return: <String>

setParent($parentRole)   X-Ref
Function to set the immediate parent role

return: <Settings_Roles_Record_Model> instance

getParent()   X-Ref
Function to get the immediate parent role

return: <Settings_Roles_Record_Model> instance

getChildren()   X-Ref
Function to get the immediate children roles

return: <Array> - List of Settings_Roles_Record_Model instances

getSameLevelRoles()   X-Ref
No description

getAllChildren()   X-Ref
Function to get all the children roles

return: <Array> - List of Settings_Roles_Record_Model instances

getProfileIdList()   X-Ref
Function returns profiles related to the current role

return: <Array> - profile ids

getDirectlyRelatedProfileId()   X-Ref
Function to get the profile id if profile is directly related to role

return: id

getEditViewUrl()   X-Ref
Function to get the Edit View Url for the Role

return: <String>

getCreateChildUrl()   X-Ref
Function to get the Create Child Role Url for the current role

return: <String>

getDeleteActionUrl()   X-Ref
Function to get the Delete Action Url for the current role

return: <String>

getPopupWindowUrl()   X-Ref
Function to get the Popup Window Url for the current role

return: <String>

getProfiles()   X-Ref
Function to get all the profiles associated with the current role

return: <Array> Settings_Profiles_Record_Model instances

addChildRole($role)   X-Ref
Function to add a child role to the current role

param: <Settings_Roles_Record_Model> $role
return: Settings_Roles_Record_Model instance

moveTo($newParentRole)   X-Ref
Function to move the current role and all its children nodes to the new parent role

param: <Settings_Roles_Record_Model> $newParentRole

save()   X-Ref
Function to save the role


delete($transferToRole)   X-Ref
Function to delete the role

param: <Settings_Roles_Record_Model> $transferToRole

getRecordLinks()   X-Ref
Function to get the list view actions for the record

return: <Array> - Associate array of Vtiger_Link_Model instances

getInstanceFromQResult($result, $rowNo)   X-Ref
Function to get the instance of Roles record model from query result

param: <Object> $result
param: <Number> $rowNo
return: Settings_Roles_Record_Model instance

getAll($baseRole = false)   X-Ref
Function to get all the roles

param: <Boolean> $baseRole
return: <Array> list of Role models <Settings_Roles_Record_Model>

getInstanceById($roleId)   X-Ref
Function to get the instance of Role model, given role id

param: <Integer> $roleId
return: Settings_Roles_Record_Model instance, if exists. Null otherwise

getBaseRole()   X-Ref
Function to get the instance of Base Role model

return: Settings_Roles_Record_Model instance, if exists. Null otherwise

getInstanceByName($name, $excludedRecordId = array()   X-Ref
No description

getUsers()   X-Ref
Function to get Users who are from this role

return: <Array> User record models list <Users_Record_Model>



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1