Class Hermes_Api
Hermes external API interface.
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.
-
Horde_Registry_Api
-
Hermes_Api
Methods summary
public static
<type>
|
|
public static
string
|
#
getTableData( <type> $name, <type> $params )
Parameters
Returns
string
|
public static
<type>
|
#
renderSubtotals( <type> & $table_data, <type> $hours, <type> $billable_hours, <type> $value )
Parameters
- $table_data
-
- $hours
-
- $billable_hours
-
- $value
-
Returns
<type>
|
public
array
|
#
listCostObjects( array $criteria )
listCostObjects API
Parameters
- $criteria
- The search criteria
Returns
array
A listCostObjects result array.
|
public
array
|
#
listJobTypes( array $criteria = array() )
Retrieve list of job types.
Retrieve list of job types.
Parameters
- $criteria
- Hash of filter criteria:
<pre><code> 'enabled' => If present, only retrieve enabled
or disabled job types.
</code></pre>
Returns
array
Associative array of job types
|
public
|
|
public
<type>
|
#
recordTime( array $data )
Record a time slice
Parameters
- $data
- Slice attributes
<pre><span class="php-keyword2">date</span> - The slice <span class="php-keyword2">date</span> (required).
client - The client id (required).
type - The jobType id (required).
costobject - The costObject id [none]
hours - Number of hours (required).
billable - <span class="php-keyword2">Time</span> billable? [<span class="php-keyword1">true</span>]
description - Description (required)
note - Note [blank]</pre>
Returns
<type>
|
public
array
|
#
getCostObjectInfo( string $costobject )
Retrieve information about a costobject's hours. Includes number of hours
worked on for each employee, total billed time etc...
Retrieve information about a costobject's hours. Includes number of hours
worked on for each employee, total billed time etc...
Parameters
- $costobject
- The costobject id (e.g., "whups:15").
Returns
arrayAn 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.
|