PHP Class Sesha_Api, horde

Copyright 2003-2016 Horde LLC (http://www.horde.org/) This file defines Sesha's external API interface. Other applications can interact with Sesha through this API.
Author: Bo Daley ([email protected])
Inheritance: extends Horde_Registry_Api
显示文件 Open project: horde/horde

Public Methods

Method Description
getQueueDetails ( integer $queue_id ) : array Get a queueDetails hash for a queue (category)
getVersionDetails ( integer $version_id ) : array return a version details hash by version id
listQueues ( ) : array List categories as ticket queues
listVersions ( integer $queue_id ) : array List Stock items as versions for a queue (category)

Method Details

getQueueDetails() public method

Get a queueDetails hash for a queue (category)
public getQueueDetails ( integer $queue_id ) : array
$queue_id integer The Queue for which to build the details hash
return array A hash of category id as id, category label as name, category description as description, a link, a list of subjects as configured

getVersionDetails() public method

return a version details hash by version id
public getVersionDetails ( integer $version_id ) : array
$version_id integer The ID of the stock item to display as a version
return array The version hash containing stock name as name, stock note as description and a link

listQueues() public method

List categories as ticket queues
public listQueues ( ) : array
return array a list of ticket queues with category id as key and category caption as value

listVersions() public method

List Stock items as versions for a queue (category)
public listVersions ( integer $queue_id ) : array
$queue_id integer The category id (queue) for which we want to fetch versions
return array A hash containing stock id as id, stock name as name, stock note as description