DAO (Data Access Objects)

From Cerberus Helpdesk Wiki

Data Access Objects are part of the Cerberus 4 API The following is a list of classes and their non-private functions, as extracted from api/DAO.class.php in Cerberus 4 build 939. The functions can be called like this: Classname::function(parameters) For example:

       $ticket = DAO_Ticket::getTicket($ticket_id);

Contents 1 DAO_Setting 2 DAO_Bayes 3 DAO_Worker 4 DAO_WorkerRole 5 DAO_WorkerEvent 6 DAO_ContactOrg 7 DAO_Address 8 DAO_AddressToWorker 9 DAO_Message 10 DAO_MessageNote 11 DAO_MessageContent 12 DAO_MessageHeader 13 DAO_Attachment 14 DAO_Ticket 15 DAO_ViewRss 16 DAO_Group 17 DAO_GroupSettings 18 DAO_Bucket 19 DAO_Mail 20 DAO_MailToGroupRule 21 DAO_Community 22 DAO_WorkerWorkspaceList 23 DAO_WorkerPref 24 DAO_Note 25 DAO_PreParseRule 26 DAO_GroupInboxFilter 27 DAO_MailTemplate 28 DAO_TicketComment 29 DAO_CustomField 30 DAO_CustomFieldValue 31 DAO_Task 32 DAO_Overview 33 DAO_WorkflowView

DAO_Setting

       set($key, $value)
       get($key)
       getSettings()

DAO_Bayes

       lookupWordIds($words)
       getStatistics()
       addOneToSpamTotal()
       addOneToNonSpamTotal()
       addOneToSpamWord($word_ids=array())
       addOneToNonSpamWord($word_ids=array())

DAO_Worker

       create($email, $password, $first_name, $last_name, $title)
       clearCache()
       getAllActive()
       getAllWithDisabled()
       getAllOnline()
       getAll($nocache=false, $with_disabled=true)
       getList($ids=array())
       getAgent($id)
       lookupAgentEmail($email)
       updateAgent($ids, $fields, $flush_cache=true)
       maint()
       deleteAgent($id)
       login($email, $password)
       setAgentTeams($agent_id, $team_ids)
       getWorkerGroups($worker_id)
       logActivity($worker_id, Model_Activity $activity)
       search($columns, $params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_WorkerRole

       create($fields)
       update($ids, $fields)
       getACL($nocache=false)
       getWhere($where=null)
       get($id)
       delete($ids)
       getRolePrivileges($role_id)
       setRolePrivileges($role_id, $privileges)
       getRoleWorkers($role_id)
       setRoleWorkers($role_id, $worker_ids)
       clearCache()

DAO_WorkerEvent

       create($fields)
       update($ids, $fields)
       updateWhere($fields, $where)
       getWhere($where=null)
       get($id)
       getUnreadCountByWorker($worker_id)
       delete($ids)
       clearCountCache($worker_id)
       search($params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_ContactOrg

       getFields()
       create($fields)
       update($ids, $fields)
       delete($ids)
       getWhere($where=null)
       get($id)
       lookup($name, $create_if_null=false)
       search($columns, $params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_Address

       getFields()
       create($fields)
       update($ids, $fields)
       updateWhere($fields, $where)
       maint()
       delete($ids)
       getWhere($where=null)
       getByEmail($email)
       getCountByOrgId($org_id)
       get($id)
       lookupAddress($email,$create_if_null=false)
       addOneToSpamTotal($address_id)
       addOneToNonSpamTotal($address_id)
       search($columns, $params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_AddressToWorker

       assign($address, $worker_id)
       unassign($address)
       unassignAll($worker_id)
       update($addresses, $fields)
       getByWorker($worker_id)
       getByAddress($address)
       getWhere($where=null)

DAO_Message

       create($fields)
       update($id, $fields)
       maint()
       search($params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_MessageNote

       create($fields)
       getByMessageId($message_id)
       getByTicketId($ticket_id)
       getList($ids)
       get($id)
       update($ids, $fields)
       delete($ids)

DAO_MessageContent

       create($message_id, $content)
       update($message_id, $content)
       get($message_id)

DAO_MessageHeader

       create($message_id, $header, $value)
       getAll($message_id)
       getUnique()

DAO_Attachment

       create($fields)
       update($id, $fields)
       get($id)
       getList($ids=array())
       getByMessageId($id)
       maint()
       delete($ids)
       search($params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_Ticket

       getFields()
       getTicketIdByMask($mask)
       getTicketByMask($mask)
       getTicketByMessageId($message_id)
       createTicket($fields)
       maint()
       merge($ids=array())
       getTicket($id)
       getTickets($ids=array())
       updateWhere($fields, $where)
       updateTicket($ids,$fields)
       getMessagesByTicket($ticket_id)
       getMessage($id)
       getRequestersByTicket($ticket_id)
       isTicketRequester($email, $ticket_id)
       createRequester($address_id,$ticket_id)
       deleteRequester($id, $address_id)
       analyze($params, $limit=15, $mode="senders", $mode_param=null) { // or "subjects"
       search($columns, $params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_ViewRss

       create($fields)
       getList($ids)
       getByHash($hash)
       getByWorker($worker_id)
       getId($id)
       update($ids, $fields)
       delete($id)

DAO_Group

       getTeam($id)
       getTeams($ids=array())
       getAll($nocache=false)
       getDefaultGroup()
       setDefaultGroup($group_id)
       getTeamCounts($ids=array(),$with_tickets=true) { // ,$with_tasks=true,$with_unassigned=false
       createTeam($fields)
       updateTeam($id, $fields)
       deleteTeam($id)
       maint()
       setTeamMember($team_id, $worker_id, $is_manager=false)
       unsetTeamMember($team_id, $worker_id)
       getRosters()
       getTeamMembers($team_id)

DAO_GroupSettings

       set($group_id, $key, $value)
       get($group_id, $key, $default=null)
       getSettings($group_id=0)

DAO_Bucket

       getTeams()
       getCategoryNameHash()
       getAll($nocache=false)
       getNextPos($group_id)
       getList($ids=array())
       getByTeam($team_ids)
       getAssignableBuckets($group_ids=null)
       create($name, $team_id)
       update($id,$fields)
       delete($ids)

DAO_Mail

       createPop3Account($fields)
       getPop3Accounts($ids=array())
       getPop3Account($id)
       updatePop3Account($id, $fields)
       deletePop3Account($id)

DAO_MailToGroupRule

       create($fields)
       update($ids, $fields)
       getWhere($where=null)
       get($id)
       delete($ids)
       increment($id)

DAO_Community

       create($fields)
       update($id, $fields)
       get($id)
       getWhere($where=null)
       getList($ids=array())
       delete($ids)
       search($params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_WorkerWorkspaceList

       create($fields)
       get($id)
       getWhere($where)
       getWorkspaces($worker_id = 0)
       update($ids, $fields)
       updateWhere($fields, $where)
       delete($ids)

DAO_WorkerPref

       set($worker_id, $key, $value)
       get($worker_id, $key, $default=null)
       getByWorker($worker_id)

DAO_Note

       create($fields)
       update($ids, $fields)
       getWhere($where=null)
       get($id)
       search($params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       deleteBySourceIds($source_extension, $source_ids)
       delete($ids)
       getFields()

DAO_PreParseRule

       create($fields)
       update($ids, $fields)
       getAll($nocache=false)
       getWhere($where=null)
       get($id)
       increment($id)
       delete($ids)
       clearCache()

DAO_GroupInboxFilter

       create($fields)
       increment($id)
       update($id, $fields)
       get($id)
       getByGroupId($group_id)
       getList($ids=array())
       delete($ids)
       search($params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_MailTemplate

       create($fields)
       getFolders($type=null)
       update($ids, $fields)
       delete($ids)
       get($id)
       _createObjectsFromResultSet(ADORecordSet $rs)

DAO_TicketComment

       create($fields)
       update($ids, $fields)
       getWhere($where=null)
       getByTicketId($id)
       getCountByTicketId($id)
       get($id)
       delete($ids)

DAO_CustomField

       create($fields)
       update($ids, $fields)
       get($id)
       getBySourceAndGroupId($source_ext_id, $group_id)
       getBySource($source_ext_id)
       getAll($nocache=false)
       delete($ids)
       clearCache()

DAO_CustomFieldValue

       getValueTableName($field_id)
       formatAndSetFieldValues($source_ext_id, $source_id, $values, $is_blank_unset=true)
       setFieldValue($source_ext_id, $source_id, $field_id, $value, $delta=false)
       unsetFieldValue($source_ext_id, $source_id, $field_id, $value=null)
       handleBulkPost($do)
       handleFormPost($source_ext_id, $source_id, $field_ids)
       getValuesBySourceIds($source_ext_id, $source_ids)
       deleteBySourceIds($source_extension, $source_ids)
       deleteByFieldId($field_id)

DAO_Task

       create($fields)
       update($ids, $fields)
       updateWhere($fields, $where)
       getWhere($where=null)
       get($id)
       getUnassignedSourceTotals()
       getAssignedSourceTotals()
       delete($ids)
       deleteBySourceIds($source_extension, $ids)
       getCountBySourceObjectId($source_extension, $source_id, $include_completed=false)
       search($columns, $params, $limit=10, $page=0, $sortBy=null, $sortAsc=null, $withCounts=true)
       getFields()

DAO_Overview

       getGroupTotals()
       getWaitingTotals()
       getWorkerTotals()

DAO_WorkflowView

       getGroupTotals()