Home « Server software «

Documentation: categories/category.php

Content

Class Category extends Anchor - The implementation of anchor for categories

This class implements the Anchor interface for categories.

Following behaviour has been defined for member functions:

get_bullet_url() -- reuse the section bullet url, if any
get_icon_url() -- reuse the category icon url, if any
get_path_bar() -- one link to the category page
get_prefix() -- provides the category prefix field
get_reference() -- returns 'category:<id>'
get_suffix() -- provides the category suffix field
get_title() -- provide the category title
get_thumbnail_url() -- reuse the category thumbnail url, if any
get_url() -- link to categories/view.php/id
has_option() -- depending on the content of the editors field
is_editable() -- depending on the content of the editors field
touch() -- remember the last action in the category record

This script is a reference file of this system.

Voir aussi:

shared/anchor.php

Licence: GNU Lesser General Public License

Auteurs:

Bernard Paques bernard.paques@bigfoot.com

get_bullet_url() - Get the url to display bullet images

function get_bullet_url()

returns an anchor to the icon image

Voir aussi:

shared/anchor.php

get_icon_url() - Get the url to display the icon for this anchor

function get_icon_url()

returns an anchor to the icon image

Voir aussi:

shared/anchor.php

get_path_bar() - Get the path bar for this anchor

function get_path_bar()

returns an array of $url => $label

This function is used to build a path bar relative to the anchor. For example, if you are displaying an article related to a category, the path bar has to mention the category. You can use following code to do that:

$anchor = get_anchor($article['anchor']);
$context['path_bar'] = array_merge($context['path_bar'], $anchor->get_path_bar());

Voir aussi:

shared/anchor.php

get_suffix() - Get the suffix text

function get_suffix($variant='')

$variant='' - string a variant string transmitted by the caller
returns a string to be inserted in the final page

Voir aussi:

shared/anchor.php

get_thumbnail_url() - Get the url to display the thumbnail for this anchor

function get_thumbnail_url()

returns an anchor to the thumbnail image

Voir aussi:

shared/anchor.php

get_url() - Get the url to display the main page for this anchor

function get_url($action='view')

$action='view' - string the targeted action ('view', 'print', 'edit', 'delete', ...)
returns an anchor to the viewing script

Voir aussi:

shared/anchor.php

load_by_id() - Load the related item

function load_by_id($id)

$id -

Voir aussi:

shared/anchor.php

touch() - Remember the last action for this category

function touch($action, $origin, $silently = FALSE)

$action - string the description of the last action
$origin - string the id of the item related to this update
$silently = FALSE - boolean TRUE for a silent update
returns a string in case of error

Voir aussi:

shared/anchor.php