Documentation: overlays/issue.php

class Issue extends Overlay - Describe one issue

This overlay is aiming to track status of various kinds of issue, as per following workflow:

on-going:suspect (create_date)
  V
  + qualification --> cancelled:suspect (qualification_date)
  V
on-going:problem (qualification_date)
  V
  + analysis --> cancelled:problem (analysis_date)
  V
on-going:issue (analysis_date)
  V
  + resolution --> cancelled:issue (resolution_date)
  V
on-going:solution (resolution_date)
  V
  + integration --> cancelled:solution (close_date)
  V
completed:solution (close_date)

In the overlay itself, saved along the article, only the last status and the related date are saved. More descriptive data and dates are saved into the table yacs_issues.

This script is a reference file of this system.

Licence: GNU Lesser General Public License

Auteurs:

Bernard Paques bernard.paques@bigfoot.com

get_fields() - Build the list of fields for one overlay

function get_fields($host, $capability='?')

$host - the hosting attributes
$capability='?' - string surfer capability ('?', 'M', or 'A')
returns a list of ($label, $input, $hint)

The current status, and the related status date are proposed

Voir aussi:

overlays/overlay.php

get_history() - Build the history for this issue

function get_history($id)

$id - int the id of the issue
returns string an unnumbered list of dates

get_label() - Get an overlaid label

function get_label($name, $action='view')

$name - string the target label
$action='view' - string the on-going action
returns the title to use

Accepted action codes:

'edit' the title for the modification of an existing object
'delete' the title for the deleting form
'new' the title for the creation of a new object
'view' the title for a displayed object

Voir aussi:

overlays/overlay.php

get_live_title() - Display a live title

function &get_live_title($host=NULL, $capability='?')

$host=NULL - array the hosting record
$capability='?' - string surfer capability ('?', 'M', or 'A')
returns some HTML to be inserted into the resulting page

Voir aussi:

overlays/overlay.php

get_options() - Get status as options of a <SELECT> field

function get_options($status)

$status - string the current status, if any
returns the HTML to insert in the page

get_status_label() - Get a label for a given status code

function get_status_label($status)

$status - string the status code
returns string the label to display

get_view_text() - Display the content of one issue

function &get_view_text($host=NULL, $capability='?')

$host=NULL - array the hosting record
$capability='?' - string surfer capability ('?', 'M', or 'A')
returns some HTML to be inserted into the resulting page

Voir aussi:

overlays/overlay.php

parse_fields() - Retrieve the content of one modified overlay

function parse_fields($fields)

$fields - the fields as filled by the end user
returns the updated fields

These are data saved into the piggy-backed overlay field of the hosting record.

If change is the status affects a previous step of the process, then this is either a simple date update or some steps have to be cancelled.

Current and previous step are computed using following table:

'on-going:suspect': step 1 - creation
'cancelled:suspect': step 2 - qualification
'on-going:problem': step 2 - qualification
'cancelled:problem': step 3 - analysis
'on-going:issue': step 3 - analysis
'cancelled:issue': step 4 - resolution
'on-going:solution': step 4 - resolution
'cancelled:solution': step 5 - close
'completed:solution': step 5 - close

Voir aussi:

overlays/overlay.php

remember() - Remember an action once it's done

function remember($variant, $host, $capability='?')

$variant - string the action 'insert', 'update' or 'delete'
$host - array the hosting record
$capability='?' - string surfer capability ('?', 'M', or 'A')
returns FALSE on error, TRUE otherwise

This function saves data into the table yacs_issues.

Voir aussi:

overlays/overlay.php

setup() - Create tables for issues

function setup()

Voir aussi:

control/setup.php