Overview Package | PHPDoctor |
FRAMES NO FRAMES | |
SUMMARY: FIELD METHOD | DETAIL: FIELD METHOD |
client.client_entity
|
+--client.client_groups
class client_groups
extends client_entity
Client part support for Article System.
Functions to handle groups on the client side.
Field Summary |
---|
public var | $a_articles |
public var | $a_agroups |
public var | $a_images |
public var | $columns Default columns to get with a db query |
public var | $error |
Fields inherited from client.client_entity | |
---|---|
$a_entity $a_images $recent |
Method Summary |
---|
public void | client_groups |
public array | get_all Return list of exported article groups. |
public asoc.array | get_by Return group data of group specified by given column name and it's value. |
public asoc.array | get Return data of group specified by id. |
public asoc.array | get_root Return data of top level (root) group. |
public array | get_articles Returns basic data of articles of given group. |
public array | get_groups Returns data of groups with parent group of given id. |
public void | get_children Alias for get_groups. |
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_agroups
public var $a_images
public var $columns
Default columns to get with a db query
public var $error
Method Detail |
---|
public void client_groups(var $art, var $gro, var $ima)
$art
$gro
$ima
public array get_all(var $how = "WHERE exported='1' ORDER BY menu_text ASC")
Return list of exported article groups.
For each of them returns $this->columns
data set.
Default ordering by 'menu_text' ascending.
$how
public asoc.array get_by(var $col, var $val)
Return group data of group specified by given column name and it's value.
Returned data is specified in $this->columns
.
$col
$val
public asoc.array get(var $id)
Return data of group specified by id.
Returned data is specified in $this->columns
.
$id
public asoc.array get_root()
Return data of top level (root) group.
The data contains 'id, name, menu_text, description'.
public array get_articles(var $id, var $what = 'A.id, A.title, A.menu_title, A.issue, U.name, A.preview, A.published_on, I.aorder', var $order = '')
Returns basic data of articles of given group.
Namely 'A.id, A.title, A.menu_title, A.issue, U.name, A.preview', as this is the default for get_group
. The list is ordered by A.issue ascending.
$id
$what
$order
public array get_groups(var $id, var $order = "ORDER BY gorder")
Returns data of groups with parent group of given id.
Namely $this->columns
. The list is ordered by Agroups.gorder
value.
$id
$order
public void get_children(var $id, var $order = "ORDER BY gorder")
Alias for get_groups.
$id
$order
Overview Package | PHPDoctor |
FRAMES NO FRAMES | |
SUMMARY: FIELD METHOD | DETAIL: FIELD METHOD |