Class client_entity

client_entity
Direct Known Subclasses:
client_articles, client_groups, client_issues, client_users, client_volumes

public class client_entity

Client part support for Article System.
Abstract class for client entity.


Constructor Summary
client_entity(var $a_ent, var $a_ima)
           
 
Method Summary
 unknown get_by(var $col, var $val, var $what, var $where)
          Return entity data of entity specified by given column name and it's value.
 unknown get_image_assignment(var $id, var $ident)
          Return entity-assigned image id (assignment data).
 unknown get_image_link(var $id, var $ident, var $bonus, var $abonus)
          Return entity specific image tag as a link, if available.
 unknown get_image_tag(var $id, var $ident, var $bonus)
          Return entity specific image tag.
 unknown get_image(var $id, var $ident)
          Return entity-assigned image data.
 unknown select_box(var $name, var $cval, var $ctext, var $selected_value, var $begin_options, var $end_options, var $attributes)
          Duplicite with admin site (db_entity)! A HTML form select box renderer.
Creates a select box based on the results of previous DB query.
 

Constructor Detail

client_entity

public client_entity(var $a_ent,
                     var $a_ima)
Parameters:
$a_ent - is passed by reference
$a_ima - is passed by reference
Method Detail

get_by

public unknown get_by(var $col,
                      var $val,
                      var $what,
                      var $where)
Return entity data of entity specified by given column name and it's value. Returned data is * by default.
Parameters:
$col - Name of the column which $val is data from.
$val - Value to specify the wanted group.
$what - Columns to return.
$where - Query restrictions.
$what - Default Value: "*"
$where - Default Value: ""
Returns:
asoc.array

get_image

public unknown get_image(var $id,
                         var $ident)
Return entity-assigned image data.
Parameters:
$id - Entity id.

get_image_assignment

public unknown get_image_assignment(var $id,
                                    var $ident)
Return entity-assigned image id (assignment data). Note: Results of this query are cached.
Parameters:
$id - Entity id.

get_image_tag

public unknown get_image_tag(var $id,
                             var $ident,
                             var $bonus)
Return entity specific image tag.
Parameters:
$id - Entity id.
$ident - Textual identificator.
$bonus - Additional image properties.
$bonus - Default Value: ''

get_image_link

public unknown get_image_link(var $id,
                              var $ident,
                              var $bonus,
                              var $abonus)
Return entity specific image tag as a link, if available.
Parameters:
$id - Entity id.
$ident - Textual identificator.
$bonus - Additional image properties.
$abonus - Additional anchor tag properties.
$bonus - Default Value: ''
$abonus - Default Value: ''

select_box

public unknown select_box(var $name,
                          var $cval,
                          var $ctext,
                          var $selected_value,
                          var $begin_options,
                          var $end_options,
                          var $attributes)
Duplicite with admin site (db_entity)! A HTML form select box renderer.
Creates a select box based on the results of previous DB query.
Parameters:
$name - Name of the select form item.
$cval - Name of column or index to the query result, to be used as option's value="".
$ctext - Name of column or index to the query result, to be used as option's label (text to display).
$selected_value - TODO: ..
$begin_options - Default Value: ""
$end_options - Default Value: ""
$attributes - Default Value: ""