b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Class: linkblog_Widget

Source Location: /blogs/inc/widgets/widgets/_linkblog.widget.php

Class linkblog_Widget

Class Overview

linkblog_widget class

This widget displays another blog as a linkblog.

Located in /blogs/inc/widgets/widgets/_linkblog.widget.php [line 37]

DataObject
   |
   --ComponentWidget
      |
      --coll_item_list_Widget
         |
         --linkblog_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 coll_item_list_Widget

coll_item_list_Widget::coll_item_list_Widget()
Constructor
coll_item_list_Widget::display()
Display the widget!
coll_item_list_Widget::disp_contents()
Support function for above
coll_item_list_Widget::get_cache_keys()
Maybe be overriden by some widgets, depending on what THEY depend on..
coll_item_list_Widget::get_desc()
Get short description
coll_item_list_Widget::get_name()
Get name of widget
coll_item_list_Widget::get_param_definitions()
Get definitions for editable params
coll_item_list_Widget::get_short_desc()
Get a very short desc. Used in the widget list.

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
linkblog_Widget   linkblog_Widget()   Constructor
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.
void   init_display()   Prepare display params

[ Top ]
Methods
Constructor linkblog_Widget  [line 42]

  linkblog_Widget linkblog_Widget( [ $db_row = NULL]  )

Constructor

Parameters:
   $db_row: 


[ Top ]
get_desc  [line 97]

  void get_desc( )

Get short description



Redefinition of:
coll_item_list_Widget::get_desc()
Get short description

[ Top ]
get_name  [line 79]

  void get_name( )

Get name of widget



Redefinition of:
coll_item_list_Widget::get_name()
Get name of widget

[ Top ]
get_param_definitions  [line 55]

  void get_param_definitions( local $params  )

Get definitions for editable params

Parameters:
local   $params:  params like 'for_editing' => true

API Tags:
See:  Plugin::GetDefaultSettings()


Redefinition of:
coll_item_list_Widget::get_param_definitions()
Get definitions for editable params

[ Top ]
get_short_desc  [line 88]

  void get_short_desc( )

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



Redefinition of:
coll_item_list_Widget::get_short_desc()
Get a very short desc. Used in the widget list.

[ Top ]
init_display  [line 108]

  void init_display( array $params  )

Prepare display params

Parameters:
array   $params:  MUST contain at least the basic display params


Redefinition of:
ComponentWidget::init_display()
Prepare display params

[ Top ]

Documentation generated on Sat, 06 Mar 2010 04:18:27 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).