Class client_issues

client_entity
  |
  +--client_issues

public class client_issues
extends client_entity

Client part support for Article System.
Functions to handle issues on the client side.


Constructor Summary
client_issues(var $art, var $iss, var $ima)
           
 
Method Summary
 unknown get_archive(var $bonus)
          Returns data on archived issues.
 unknown get_articles(var $id)
          Returns basic data of articles in given issue.
 unknown get_menu(var $id, var $menu_group)
          Returns menu of given issue as linkset class.
 unknown get_next(var $id, var $flags)
          Returns next archived issue id from given $id.
 unknown get_previous(var $id, var $flags)
          Returns previous archived issue id from given $id.
 unknown get(var $id, var $flags, var $what)
          Returns data on a visible issue.
 unknown is_archived(var $id)
          Test if given issue id is of archived issue.
 
Methods inherited from class client_entity
get_by, get_image_assignment, get_image_link, get_image_tag, get_image, select_box
 

Constructor Detail

client_issues

public client_issues(var $art,
                     var $iss,
                     var $ima)
Parameters:
$art - is passed by reference
$iss - is passed by reference
$ima - is passed by reference
Method Detail

get

public unknown get(var $id,
                   var $flags,
                   var $what)
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 - Id of the desired issue (not used with ISSUE_CURRENT flag)
$flags - One of the folowing { ISSUE_CURRENT, ISSUE_ARCHIVED, ISSUE_VISIBLE } where ISSUE_ARCHIVED | ISSUE_CURRENT == ISSUE_VISIBLE (the default)
$id - Default Value: 0
$flags - Default Value: ISSUE_VISIBLE
$what - Default Value: "id
Returns:
associative array

get_next

public unknown get_next(var $id,
                        var $flags)
Returns next archived issue id from given $id.

get_previous

public unknown get_previous(var $id,
                            var $flags)
Returns previous archived issue id from given $id.

get_archive

public unknown get_archive(var $bonus)
Returns data on archived issues.
Parameters:
$bonus - String, that is appended to the query. Possibly for ORDER BY, ...
$bonus - Default Value: ''
Returns:
associative array

get_articles

public unknown get_articles(var $id)
Returns basic data of articles in given issue. The list is ordered by 'iorder'.
Parameters:
$id - Id of an issue
Returns:
array of associative arrays

get_menu

public unknown get_menu(var $id,
                        var $menu_group)
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 - Id of an issue
$menu_group - Boolean to specify, whether get 'menu_group' data too)
$menu_group - Default Value: true
Returns:
array of associative arrays
See Also:
linkset

is_archived

public unknown is_archived(var $id)
Test if given issue id is of archived issue. Use to prevent displaying of non-public issues.
Parameters:
$id - Id of an issue
Returns:
string