|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
client
Client part support for Article System.
A set of database querying methods for getting client part data
from the Article System database.
Constructor Summary | |
client(var $a,
var $g,
var $i,
var $ai)
Contructor of client class. |
Method Summary | |
unknown |
connect()
Connect to the database. |
unknown |
display_article(var $article)
An example of article rendering function. |
unknown |
format_signature(var $text)
Return formatted signature from an unformatted one. |
unknown |
get_adata(var $what)
Return specified part of last loaded (with get_article) article. |
unknown |
get_archived_article(var $id)
Fill in local var and return detailed article data of given article. |
unknown |
get_archived_issue(var $id)
Returns data on issue given by id, which is currently archived. |
unknown |
get_article_special(var $id,
var $restrict,
var $what)
Fill in local var and return detailed article data of given article. |
unknown |
get_article(var $id)
Fill in local var and return detailed article data of given article. |
unknown |
get_current_article(var $id)
Fill in local var and return detailed article data of given article. |
unknown |
get_current_issue()
Returns data on currently active issue. |
unknown |
get_formatted(var $what)
Return specified part of last loaded (with get_article) article with custom formatting. |
unknown |
get_group_articles(var $id)
Returns basic data of articles of given group. |
unknown |
get_group_by(var $col,
var $val)
Return group data of group specified by given column name and it's value. |
unknown |
get_group(var $id)
Return data of group specified by id. |
unknown |
get_groups(var $how)
Return list of exported article groups. |
unknown |
get_issue_archive()
Returns data on archived issues. |
unknown |
get_issue_articles(var $id)
Returns basic data of articles in given issue. |
unknown |
get_issue_menu(var $id,
var $menu_group)
Returns menu of given issue as linkset class. |
unknown |
get_next_archived_issue(var $id)
Returns next archived issue id from given $id. |
unknown |
get_previous_archived_issue(var $id)
Returns previous archived issue id from given $id. |
unknown |
is_archived(var $id)
Test if given issue id is of archived issue. |
unknown |
is_current(var $id)
Test if given article id is from current issue. |
unknown |
test_fake_issue(var $user,
var $fake_active_issue,
var $fake)
Get an issue to display with respect to fake issue input. |
Constructor Detail |
public client(var $a, var $g, var $i, var $ai)
$a
- is passed by reference$g
- is passed by reference$i
- is passed by reference$ai
- Default Value: ''Method Detail |
public unknown connect()
public unknown get_current_issue()
public unknown get_archived_issue(var $id)
public unknown get_next_archived_issue(var $id)
public unknown get_previous_archived_issue(var $id)
public unknown get_issue_archive()
public unknown get_issue_articles(var $id)
$id
- Id of an issuepublic unknown get_issue_menu(var $id, var $menu_group)
linkset
methods get_plain
for menu_group items and
get_link
for menu_title items.$id
- Id of an issue$menu_group
- Boolean to specify, whether get 'menu_group' data too)$menu_group
- Default Value: truelinkset
public unknown is_archived(var $id)
$id
- Id of an issuepublic unknown get_article(var $id)
$id
- Id of an articlepublic unknown get_adata(var $what)
$what
- Column name from Articles.public unknown is_current(var $id)
$id
- Id of an articlepublic unknown get_article_special(var $id, var $restrict, var $what)
$id
- Id of an article$restrict
- Restrictions to apply.$what
- Columns to return: select from { Articles A, Users U, Issues I }. Comma separated.$what
- Default Value: 'A.idpublic unknown get_current_article(var $id)
$id
- Id of an articlepublic unknown get_archived_article(var $id)
$id
- Id of an articlepublic unknown get_formatted(var $what)
$what
- Column name from Articles.public unknown format_signature(var $text)
$text
- The text of unformatted signature.public unknown get_groups(var $how)
$how
- Optional WHERE/ORDER clause that overrides the default ordering.$how
- Default Value: "WHERE exported='1' ORDER BY menu_text ASC"public unknown get_group_by(var $col, var $val)
$col
- Name of the column which $val is data from.$val
- Value to specify the wanted group.public unknown get_group(var $id)
$id
- Id of a group.public unknown get_group_articles(var $id)
get_group
.
The list is ordered by A.issue ascending.$id
- Id of an issuepublic unknown test_fake_issue(var $user, var $fake_active_issue, var $fake)
$user
- is passed by referencepublic unknown display_article(var $article)
$article
- Id of an article to display.
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |