Class Whups_Driver

Base class for Whups' storage backend.

See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://www.horde.org/licenses/bsdl.php.

Direct known subclasses

Whups_Driver_Sql

Abstract
Package: Whups
Author: Robert E. Coyle robertecoyle@hotmail.com
Author: Jan Schneider jan@horde.org
Located at Driver.php

Methods summary
`public Whups_Driver_Base`	# `__construct( array $params )` Constructor Constructor Parameters `$params` Parameter array. Returns `Whups_Driver_Base`
`public`	# `setAttributes( array $info, Whups_Ticket & $ticket )` Set ticket attributes Set ticket attributes Parameters `$info` Attributes to set `$ticket` The ticket which attributes to set.
`public array`	# `getHistory( integer $ticket_id, Horde_Form $form = null )` Fetch ticket history Fetch ticket history Parameters `$ticket_id` The ticket to fetch history for. `$form` Returns `array`
`public`	# `getQueue( mixed $queueId )`
`public`	# `getQueues( )`
`public`	# `getVersionInfo( mixed $queue )`
`public`	# `getVersions( mixed $queue, mixed $all = false )` Returns a hash of versions suitable for select lists. Returns a hash of versions suitable for select lists.
`public`	# `getVersion( mixed $version )`
`public`	# `getCategories( )`
`public array`	# `getAttributesForType( mixed $type = null )` Returns the attributes for a ticket type. Returns the attributes for a ticket type. Returns `array` A list of attributes. Params integer $type A ticket type ID.
`public array`	# `getAllTicketAttributesWithNames( mixed $ticket_id )` Returns the attributes for a specific ticket. Returns the attributes for a specific ticket. This method will check if external attributes need to be fetched from hooks or whether to use the standard ones defined within Whups. Returns `array` List of attributes. Params integer $ticket_id The ticket ID.
`public`	# `deleteQueue( integer $queueId )` Deletes a queue. Deletes a queue. Should be called by driver subclasses after successful removal from the backend. Takes only care of cleaning up queue permissions. Parameters `$queueId` The id of the queue being deleted.
`public`	# `deleteReply( integer $reply )` Deletes a form reply. Deletes a form reply. Should be called by driver subclasses after successful removal from the backend. Takes only care of cleaning up reply permissions. Parameters `$reply` The id of the form reply being deleted.
`public`	# `filterTicketsByState( mixed $tickets, mixed $state_category = array() )`
`public`	# `mail( array $opts )` Sends email notifications to a list of recipients. Sends email notifications to a list of recipients. We do some ugly work in here to make sure that no one gets comments mailed to them that they shouldn't see (because of group permissions). Parameters `$opts` <p>Option hash with notification information. Possible values: - ticket: (Whups_Ticket) A ticket. If not set, this is assumed to be a reminder message. - recipients: (array\|string) The list of recipients, with user names as keys and user roles as values. - subject: (string) The email subject. - view: (Horde_View) The view object for the message text. - template: (string) The template file for the message text. - from: (string) The email sender. - new: (boolean, optional) Whether the passed ticket was just created.</p>
`public string`	# `formatComments( array $comments, integer $ticket )` Converts a changeset array to a plain text comment snippet. Converts a changeset array to a plain text comment snippet. Parameters `$comments` A changeset list. `$ticket` A ticket ID. Returns `string` The formatted comment text, if any.

Packages

Classes

Class Whups_Driver

Direct known subclasses

Parameters

Returns

Parameters

Parameters

Returns

Returns

Params

Returns

Params

Parameters

Parameters

Parameters

Parameters

Returns