PHP 클래스 Hermes_Api, horde

This file defines Hermes's external API interface. Other applications can interact with Hermes through this API. See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://www.horde.org/licenses/bsdl.php.

상속: extends Horde_Registry_Api

파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

공개 메소드들

메소드	설명
getCostObjectInfo ( string $costobject ) : array	Retrieve information about a costobject's hours. Includes number of hours worked on for each employee, total billed time etc.
getTableData ( $name, $params ) : string
getTableMetaData ( $name, $params ) :
listClients ( )
listCostObjects ( array $criteria ) : array	listCostObjects API
listJobTypes ( array $criteria = [] ) : array	Retrieve list of job types.
listTimeObjectCategories ( ) : array	Retrieves a list of available time objects categories.
listTimeObjects ( array $time_categories, mixed $start, mixed $end ) : array	Lists timeslices as timeobjects.
recordTime ( array $data ) :	Record a time slice
renderSubtotals ( &$table_data, $hours, $billable_hours, $value ) :

메소드 상세

getCostObjectInfo() 공개 메소드

public getCostObjectInfo ( string $costobject ) : array
$costobject	string	The costobject id (e.g., "whups:15").
리턴	array	An array of data with the following structure: employees - an array of employee ids as keys, number of hours as values. total - total number of hours billable - total number of billable hours.

getTableData() 공개 정적인 메소드

public static getTableData ( $name, $params ) : string
$name
$params
리턴	string

getTableMetaData() 공개 정적인 메소드

public static getTableMetaData ( $name, $params ) :
$name
$params
리턴

listClients() 공개 메소드

또한 보기: Hermes::listClients

public listClients ( )

listCostObjects() 공개 메소드

listCostObjects API

public listCostObjects ( array $criteria ) : array
$criteria	array	The search criteria
리턴	array	A listCostObjects result array.

listJobTypes() 공개 메소드

Retrieve list of job types.

public listJobTypes ( array $criteria = [] ) : array
$criteria	array	Hash of filter criteria: 'enabled' => If present, only retrieve enabled or disabled job types.
리턴	array	Associative array of job types

listTimeObjectCategories() 공개 메소드

Retrieves a list of available time objects categories.

public listTimeObjectCategories ( ) : array
리턴	array	An array of all configured time object categories.

listTimeObjects() 공개 메소드

Lists timeslices as timeobjects.

public listTimeObjects ( array $time_categories, mixed $start, mixed $end ) : array
$time_categories	array	The time categories (from listTimeObjectCategories) to list.
$start	mixed	The start date of the period.
$end	mixed	The end date of the period.
리턴	array	An array of timeObject results.

recordTime() 공개 메소드

Record a time slice

public recordTime ( array $data ) :

$data

array

Slice attributes

 date          - The slice date (required).
 client        - The client id (required).
 type          - The jobType id (required).
 costobject    - The costObject id [none]
 hours         - Number of hours (required).
 billable      - Time billable? [true]
 description   - Description (required)
 note          - Note [blank]

리턴

renderSubtotals() 공개 정적인 메소드

public static renderSubtotals ( &$table_data, $hours, $billable_hours, $value ) :
$table_data
$hours
$billable_hours
$value
리턴