Overview  Package PHPDoctor

client

Class client_groups

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 voidclient_groups
public arrayget_all

Return list of exported article groups.

public asoc.arrayget_by

Return group data of group specified by given column name and it's value.

public asoc.arrayget

Return data of group specified by id.

public asoc.arrayget_root

Return data of top level (root) group.

public arrayget_articles

Returns basic data of articles of given group.

public arrayget_groups

Returns data of groups with parent group of given id.

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

a_articles

public var $a_articles

a_agroups

public var $a_agroups

a_images

public var $a_images

columns

public var $columns

Default columns to get with a db query


error

public var $error
Method Detail

client_groups()

public void client_groups(var $art,
                          var $gro,
                          var $ima)
Parameters:
$art
$gro
$ima

get_all()

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.

Parameters:
$how
Returns:
of asoc.arrays

get_by()

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.

Parameters:
$col
$val

get()

public asoc.array get(var $id)

Return data of group specified by id.

Returned data is specified in $this->columns.

Parameters:
$id

get_root()

public asoc.array get_root()

Return data of top level (root) group.

The data contains 'id, name, menu_text, description'.


get_articles()

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.

Parameters:
$id
$what
$order
Returns:
of associative arrays

get_groups()

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.

Parameters:
$id
$order
Returns:
of associative arrays

get_children()

public void get_children(var $id,
                         var $order = "ORDER BY gorder")

Alias for get_groups.

Parameters:
$id
$order
See Also:
"get_groups"

Overview  Package PHPDoctor