Overview  Package PHPDoctor

client

Class client_issues

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 voidclient_issues
public associativeget

Returns data on a visible issue.

public voidget_next

Returns next archived issue id from given $id.

public voidget_previous

Returns previous archived issue id from given $id.

public associativeget_archive

Returns data on archived issues.

public arrayget_articles

Returns basic data of articles in given issue.

public arrayget_menu

Returns menu of given issue as linkset class.

public stringis_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

a_articles

public var $a_articles

a_issues

public var $a_issues

a_images

public var $a_images

article

public var $article

issue

public var $issue

error

public var $error
Method Detail

client_issues()

public void client_issues(var $art,
                          var $iss,
                          var $ima)
Parameters:
$art
$iss
$ima

get()

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.

Parameters:
$id
$flags
$what
Returns:
array

get_next()

public void get_next(var $id,
                     var $flags)

Returns next archived issue id from given $id.

Parameters:
$id
$flags

get_previous()

public void get_previous(var $id,
                         var $flags)

Returns previous archived issue id from given $id.

Parameters:
$id
$flags

get_archive()

public associative get_archive(var $bonus = '')

Returns data on archived issues.

Parameters:
$bonus
Returns:
array

get_articles()

public array get_articles(var $id)

Returns basic data of articles in given issue.

The list is ordered by 'iorder'.

Parameters:
$id
Returns:
of associative arrays

get_menu()

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.

Parameters:
$id
$menu_group
Returns:
of associative arrays
See Also:
"linkset"

is_archived()

public string is_archived(var $id)

Test if given issue id is of archived issue.

Use to prevent displaying of non-public issues.

Parameters:
$id

Overview  Package PHPDoctor