====== Doc from code ======

This is available on [[http://cvs.drupal.org/viewcvs/drupal/contributions/modules/helpdesk/doc/|Drupal CVS]]

The [[http://cvs.drupal.org/viewcvs/drupal/contributions/modules/helpdesk/|helpdesk source code]] itself is now available on [[http://drupal.org/node/30947|drupal]] in the CVS Contrib repository.

Preliminary design info is available on [[http://blog.riff.org/2005_09_12_helpdesk_customer_support_module_for_drupal|FGM's blog]]

====== General behaviours ======

===== Content-oriented classes ======

Content-oriented classes share similar methods:
  * init() initializes an already created instance of the class with values passed as parameters, or derives from them. It is to be used when the constructor doesn't have all information available at the time of creation and the properties must be initialized later on
  * form() implements the portion of hook_form the class is responsible for
  * view() implements the portion of hook_view the class is responsible for

These are:
  helpdeskObject
    helpdeskContract
    helpdeskEvent
      helpdeskTicket
        helpdeskFollowup
    helpdeskTimeInfo



====== Class reference ======

See the [[http://wiki.riff.org/helpdesk/doc|PHPDocumentor doc]].

In short:

  * helpdeskObject is an abstract ancestor for content-related classes
    * helpdeskContract implements the HD [[CONTRACT]]
    * helpdeskEvent is an abstract ancestor for HD [[TICKET]] and [[FOLLOWUP]]
      * helpdeskTicket implements the HD [[TICKET]]
        * helpdeskFollowup implements the HD [[FOLLOWUP]]
    * helpdeskTimeInfo implements a view (à la MVC) of a set of timestamps within Drupal. It is a descendent of the helpdeskObject, which is counterintuitive, because it is typically embedded in, and dependent upon, a HD node descendent.
  * helpdeskTimeValue implements a view (à la MVC) of a timestamp within Drupal. It is the workhorse for helpdeskTimeInfo
  * helpdeskUser implements the HD [[USER]]
    * helpdeskCustomer implements the HD [[CUSTOMER]]

The HD [[TECH]] and [[ATTENDANT]] have no direct implementation.