Docs For Class coll_category_list

Class Overview

ComponentWidget Class

A ComponentWidget is a displayable entity that can be placed into a Container on a web page.

Located in /blogs/inc/widgets/widgets/_coll_category_list.widget.php [line 39]

DataObject
   |
   --ComponentWidget
      |
      --coll_category_list_Widget

Author(s):

Information Tags:

Version:

beta

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From ComponentWidget ComponentWidget::$code ComponentWidget::$coll_ID ComponentWidget::$disp_params ComponentWidget::$enabled ComponentWidget::$order ComponentWidget::$params ComponentWidget::$param_array ComponentWidget::$Plugin ComponentWidget::$sco_name ComponentWidget::$type Inherited From DataObject DataObject::$allow_ID_insert DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From ComponentWidget ComponentWidget::ComponentWidget() Constructor ComponentWidget::dbinsert() Insert object into DB based on previously recorded changes. ComponentWidget::dbupdate() Update the DB based on previously recorded changes ComponentWidget::display() Display the widget! ComponentWidget::display_with_cache() Wraps display in a cacheable block. ComponentWidget::disp_coll_list() List of collections/blogs ComponentWidget::disp_title() Note: a container can prevent display of titles with 'block_display_title' This is useful for the lists in the headers fp> I'm not sur if this param should be overridable by widgets themselves (priority problem) Maybe an "auto" setting. ComponentWidget::get_cache_keys() Maybe be overriden by some widgets, depending on what THEY depend on.. ComponentWidget::get_desc() Get desc of widget ComponentWidget::get_desc_for_list() Get a clean description to display in the widget list ComponentWidget::get_name() Get name of widget ComponentWidget::get_param() param value ComponentWidget::get_param_definitions() Get definitions for editable params ComponentWidget::get_Plugin() Get ref to Plugin handling this Widget ComponentWidget::get_short_desc() Get a very short desc. Used in the widget list. ComponentWidget::init_display() Prepare display params ComponentWidget::load_from_Request() Load params ComponentWidget::load_param_array() Load param array ComponentWidget::set() Set param value Inherited From DataObject DataObject::DataObject() Constructor DataObject::action_icon() Generate requested action icon depending on perm DataObject::action_link() Generate requested action link depending on perm DataObject::check_delete() Check relations for restrictions before deleting DataObject::check_relations() Check relations for restrictions or cascades. DataObject::confirm_delete() Displays form to confirm deletion of this object DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() Delete object from DB. DataObject::dbexists() Check existence of specified value in unique field. DataObject::dbinsert() Insert object into DB based on previously recorded changes. DataObject::dbsave() Inserts or Updates depending on object state. DataObject::dbupdate() Update the DB based on previously recorded changes DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::get_action_title() Generate help title text for action DataObject::history_info_icon() Create icon with dataobject history DataObject::ID() Template function: Displays object ID. DataObject::set() Set param value DataObject::set_from_Request() Set a parameter from a Request form value. DataObject::set_param() Set param value. DataObject::set_string_from_param() Set a string parameter from a Request form value.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ComponentWidget

ComponentWidget::$code

ComponentWidget::$coll_ID

ComponentWidget::$disp_params

ComponentWidget::$enabled

ComponentWidget::$order

ComponentWidget::$params

ComponentWidget::$param_array

ComponentWidget::$Plugin

ComponentWidget::$sco_name

ComponentWidget::$type

Inherited From DataObject

DataObject::$allow_ID_insert

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From ComponentWidget

ComponentWidget::ComponentWidget()

Constructor

ComponentWidget::dbinsert()

Insert object into DB based on previously recorded changes.

ComponentWidget::dbupdate()

Update the DB based on previously recorded changes

ComponentWidget::display()

Display the widget!

ComponentWidget::display_with_cache()

Wraps display in a cacheable block.

ComponentWidget::disp_coll_list()

List of collections/blogs

ComponentWidget::disp_title()

Note: a container can prevent display of titles with 'block_display_title' This is useful for the lists in the headers fp> I'm not sur if this param should be overridable by widgets themselves (priority problem) Maybe an "auto" setting.

ComponentWidget::get_cache_keys()

Maybe be overriden by some widgets, depending on what THEY depend on..

ComponentWidget::get_desc()

Get desc of widget

ComponentWidget::get_desc_for_list()

Get a clean description to display in the widget list

ComponentWidget::get_name()

Get name of widget

ComponentWidget::get_param()

param value

ComponentWidget::get_param_definitions()

Get definitions for editable params

ComponentWidget::get_Plugin()

Get ref to Plugin handling this Widget

ComponentWidget::get_short_desc()

Get a very short desc. Used in the widget list.

ComponentWidget::init_display()

Prepare display params

ComponentWidget::load_from_Request()

Load params

ComponentWidget::load_param_array()

Load param array

ComponentWidget::set()

Set param value

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::action_icon()

Generate requested action icon depending on perm

DataObject::action_link()

Generate requested action link depending on perm

DataObject::check_delete()

Check relations for restrictions before deleting

DataObject::check_relations()

Check relations for restrictions or cascades.

DataObject::confirm_delete()

Displays form to confirm deletion of this object

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

Delete object from DB.

DataObject::dbexists()

Check existence of specified value in unique field.

DataObject::dbinsert()

Insert object into DB based on previously recorded changes.

DataObject::dbsave()

Inserts or Updates depending on object state.

DataObject::dbupdate()

Update the DB based on previously recorded changes

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::get_action_title()

Generate help title text for action

DataObject::history_info_icon()

Create icon with dataobject history

DataObject::ID()

Template function: Displays object ID.

DataObject::set()

Set param value

DataObject::set_from_Request()

Set a parameter from a Request form value.

DataObject::set_param()

Set param value.

DataObject::set_string_from_param()

Set a string parameter from a Request form value.

[ Top ]

Method Summary

coll_category_list_Widget	coll_category_list_Widget()	Constructor
string	cat_after_level()	Callback: Generate code when exiting from a level
string	cat_before_level()	Callback: Generate code when entering a new level
string	cat_line()	Callback: Generate category line when it has children
string	cat_no_children()	Callback: Generate category line when it has no children
void	display()	Display the widget!
void	get_desc()	Get short description
void	get_name()	Get name of widget
void	get_param_definitions()	Get definitions for editable params
void	get_short_desc()	Get a very short desc. Used in the widget list.

[ Top ]

Properties

Methods

Constructor coll_category_list_Widget [line 44]

coll_category_list_Widget coll_category_list_Widget(
[
$db_row = NULL] 
)

Constructor

Parameters:

$db_row:

[ Top ]

cat_after_level [line 384]

string cat_after_level(
int
$level 
)

Callback: Generate code when exiting from a level

Parameters:

int

$level:

level of the category in the recursive tree

API Tags:

Return:

HTML

[ Top ]

cat_before_level [line 367]

string cat_before_level(
int
$level 
)

Callback: Generate code when entering a new level

Parameters:

int

$level:

level of the category in the recursive tree

API Tags:

Return:

HTML

[ Top ]

cat_line [line 294]

string cat_line(
Chapter
$Chapter, int
$level 
)

Callback: Generate category line when it has children

Parameters:

Chapter	$Chapter:	generic category we want to display
int	$level:	level of the category in the recursive tree

API Tags:

Return:

HTML

[ Top ]

cat_no_children [line 354]

string cat_no_children(
Chapter
$Chapter, int
$level 
)

Callback: Generate category line when it has no children

Parameters:

Chapter	$Chapter:	generic category we want to display
int	$level:	level of the category in the recursive tree

API Tags:

Return:

HTML

[ Top ]

display [line 135]

void display(
array
$params 
)

Display the widget!

Parameters:

array

$params:

MUST contain at least the basic display params

Redefinition of:

ComponentWidget::display(): Display the widget!

[ Top ]

get_desc [line 72]

void get_desc(
)

Get short description

Redefinition of:

ComponentWidget::get_desc(): Get desc of widget

[ Top ]

get_name [line 54]

void get_name(
)

Get name of widget

Redefinition of:

ComponentWidget::get_name(): Get name of widget

[ Top ]

get_param_definitions [line 89]

void get_param_definitions(
array
$params 
)

Get definitions for editable params

Parameters:

array

$params:

local params

'title': block title (string, default "Categories")
'option_all': "All categories" link title, empty to disable (string, default "All")
'use_form': Add a form with checkboxes to allow selection of multiple categories (boolean)
'disp_names_for_coll_list': Display blog names, if this is an aggregated blog? (boolean)
'display_checkboxes': Add checkboxes (but not a complete form) to allow selection of multiple categories (boolean)

API Tags:

See:

Plugin::GetDefaultSettings()

Redefinition of:

ComponentWidget::get_param_definitions(): Get definitions for editable params

[ Top ]

get_short_desc [line 63]

void get_short_desc(
)

Get a very short desc. Used in the widget list.

Redefinition of:

ComponentWidget::get_short_desc(): Get a very short desc. Used in the widget list.

[ Top ]

Multilingual multiuser multiblog engine

Class: coll_category_list_Widget

Class coll_category_list_Widget

Packages

Classes

Files