Home « Server software «

Documentation: overlays/day.php

Content

class Day extends Overlay - Remember one specific day

This script is a reference file of this system.

Licence: GNU Lesser General Public License

Auteurs:

Bernard Paques bernard.paques@bigfoot.com

get_fields() - Get form fields to change the day

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

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

Voir aussi:

overlays/overlay.php

get_id() - Identify one instance

function get_id()

This function returns a string that identify uniquely one overlay instance. When this information is saved, it can be used later on to retrieve one page and its content.

@returns a unique string, or NULL

Voir aussi:

articles/edit.php

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 label to use

Accepted action codes:

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

Voir aussi:

overlays/overlay.php

get_text() - Display the content of one instance

function get_text($variant='view', $host=NULL)

$variant='view' - string the on-going action
$host=NULL - array the hosting record
returns some HTML to be inserted into the resulting page

Accepted variant codes:

'view' - embedded into the main viewing 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

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

To be overloaded into derivated class

render_articles_for_anchor() - List dates at some section

function render_articles_for_anchor($anchor, $page, $capability='?')

$anchor - string the anchor to consider (e.g., 'section:123')
$page - int page index
$capability='?' - string actual surfer capability ('?', 'M', or 'A')
returns string to be inserted in resulting web page