Class: related_post_list_Widget

Source Location: /qp_plugins/related_post_list_widget/_related_post_list.widget.php

Class related_post_list_Widget

Class Overview

ComponentWidget Class

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

Located in /qp_plugins/related_post_list_widget/_related_post_list.widget.php [line 37]

DataObject
   |
   --ComponentWidget
      |
      --item_list_Widget
         |
         --related_post_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

ComponentWidget::$widget_name

ComponentWidget::$widget_title

ComponentWidget::$_trans

ComponentWidget::$_trans_loaded_global

Inherited From DataObject

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From item_list_Widget

item_list_Widget::item_list_Widget()

Constructor

item_list_Widget::display()

Display the widget!

item_list_Widget::disp_contents()

Support function for above

item_list_Widget::get_desc()

Get short description

item_list_Widget::get_param_definitions()

Get definitions for editable params

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::display()

Display the widget!

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_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

ComponentWidget::TS_()

Translate and escape single quotes.

ComponentWidget::T_()

Translate a given string, in the Widget's context.

Inherited From DataObject

DataObject::DataObject()

Constructor

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::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::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.

[ Top ]

Method Summary

related_post_list_Widget	related_post_list_Widget()	Constructor
void	display()	Display the widget!
void	get_desc()	Get short description
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 related_post_list_Widget [line 42]

related_post_list_Widget related_post_list_Widget(
[
$db_row = NULL] 
)

Constructor

Parameters:

$db_row:

[ Top ]

display [line 101]

void display(
array
$params 
)

Display the widget!

Parameters:

array

$params:

MUST contain at least the basic display params

Redefinition of:

item_list_Widget::display(): Display the widget!

[ Top ]

get_desc [line 90]

void get_desc(
)

Get short description

Redefinition of:

item_list_Widget::get_desc(): Get short description

[ Top ]

get_param_definitions [line 58]

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:

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

[ Top ]

get_short_desc [line 81]

void get_short_desc(
)

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

Redefinition of:

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

[ Top ]

hic sunt dracones

	widgets

[ class tree: widgets ] [ index: widgets ] [ all elements ]