Overview Package | PHPDoctor |
FRAMES NO FRAMES | |
SUMMARY: FIELD METHOD | DETAIL: FIELD METHOD |
client.client_entity
|
+--client.client_issues
class client_issues
extends client_entity
Client part support for Article System.
Functions to handle issues on the client side.
Field Summary |
---|
public var | $a_articles |
public var | $a_issues |
public var | $a_images |
public var | $article |
public var | $issue |
public var | $error |
Fields inherited from client.client_entity | |
---|---|
$a_entity $a_images $recent |
Method Summary |
---|
public void | client_issues |
public associative | get Returns data on a visible issue. |
public void | get_next Returns next archived issue id from given $id. |
public void | get_previous Returns previous archived issue id from given $id. |
public associative | get_archive Returns data on archived issues. |
public array | get_articles Returns basic data of articles in given issue. |
public array | get_menu Returns menu of given issue as linkset class. |
public string | is_archived Test if given issue id is of archived issue. |
Methods inherited from client.client_entity | |
---|---|
client_entity, get_by, get_image, get_image_assignment, get_image_tag, get_image_link, select_box |
Field Detail |
---|
public var $a_articles
public var $a_issues
public var $a_images
public var $article
public var $issue
public var $error
Method Detail |
---|
public void client_issues(var $art, var $iss, var $ima)
$art
$iss
$ima
public associative get(var $id = 0, var $flags = ISSUE_VISIBLE, var $what = "id, name, menu_title, subtitle")
Returns data on a visible issue.
Depending on the flags, it can be ISSUE_CURRENT only, ISSUE_ARCHIVED issues, or both .. ISSUE_VISIBLE.
$id
$flags
$what
public void get_next(var $id, var $flags)
Returns next archived issue id from given $id.
$id
$flags
public void get_previous(var $id, var $flags)
Returns previous archived issue id from given $id.
$id
$flags
public associative get_archive(var $bonus = '')
Returns data on archived issues.
$bonus
public array get_articles(var $id)
Returns basic data of articles in given issue.
The list is ordered by 'iorder'.
$id
public array get_menu(var $id, var $menu_group = true)
Returns menu of given issue as linkset class.
The data contained are in form (menu_group, menu_title, menu_group, menu_title, ..) or just plain array of menu_titles (menu_title, menu_title, ...).
The list is ordered by 'iorder'.
Use linkset
methods get_plain
for menu_group items and get_link
for menu_title items.
$id
$menu_group
public string is_archived(var $id)
Test if given issue id is of archived issue.
Use to prevent displaying of non-public issues.
$id
Overview Package | PHPDoctor |
FRAMES NO FRAMES | |
SUMMARY: FIELD METHOD | DETAIL: FIELD METHOD |