Docs For Class Chapter

Class Overview

Chapter Class

Located in /blogs/inc/chapters/model/_chapter.class.php [line 37]

DataObject
   |
   --GenericElement
      |
      --GenericCategory
         |
         --Chapter

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From GenericCategory GenericCategory::$children GenericCategory::$parent_ID GenericCategory::$parent_name Inherited From GenericElement GenericElement::$name Inherited From DataObject DataObject::$allow_ID_insert DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From GenericCategory GenericCategory::GenericCategory() Constructor GenericCategory::add_children() Add a child GenericCategory::load_from_request() Load data from Request form fields. GenericCategory::set() Set param value Inherited From GenericElement GenericElement::GenericElement() Constructor GenericElement::disp_form() TODO GenericElement::get_name() Template function: return name of item GenericElement::load_from_Request() Load data from Request form fields. 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 GenericCategory

GenericCategory::$children

GenericCategory::$parent_ID

GenericCategory::$parent_name

Inherited From GenericElement

GenericElement::$name

Inherited From DataObject

DataObject::$allow_ID_insert

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From GenericCategory

GenericCategory::GenericCategory()

Constructor

GenericCategory::add_children()

Add a child

GenericCategory::load_from_request()

Load data from Request form fields.

GenericCategory::set()

Set param value

Inherited From GenericElement

GenericElement::GenericElement()

Constructor

GenericElement::disp_form()

TODO

GenericElement::get_name()

Template function: return name of item

GenericElement::load_from_Request()

Load data from Request form fields.

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 ]

Property Summary

Blog	$Blog	The Blog of the Item (lazy filled, use get_Blog() to access it.
integer	$blog_ID
mixed	$description
mixed	$order
Chapter	$parent_Chapter	Lazy filled
mixed	$urlname

[ Top ]

Method Summary

Chapter	Chapter()	Constructor
boolean	dbinsert()	Insert object into DB based on previously recorded changes.
boolean	dbupdate()	Update the DB based on previously recorded changes
Blog	&get_Blog()	Get the Blog object for the Chapter.
void	&get_parent_Chapter()
void	get_permanent_url()	Generate the URL to access the category.
void	get_url_path()	Get URL path (made of URL names) back to the root
void	load_Blog()	Load the Blog object for the Chapter, without returning it.
boolean	load_from_request()	Load data from Request form fields.

[ Top ]

Properties

Blog $Blog [line 48]

The Blog of the Item (lazy filled, use get_Blog() to access it.

API Tags:

Access:

protected

[ Top ]

integer $blog_ID [line 42]

[ Top ]

mixed $description [line 51]

[ Top ]

mixed $order [line 52]

[ Top ]

Chapter $parent_Chapter [line 58]

Lazy filled

[ Top ]

mixed $urlname [line 50]

[ Top ]

Methods

Constructor Chapter [line 66]

Chapter Chapter(
[table
$db_row = NULL], [integer|NULL
$subset_ID = NULL] 
)

Constructor

Parameters:

table	$db_row:	Database row
integer\|NULL	$subset_ID:	subset to use for new object

[ Top ]

dbinsert [line 264]

boolean dbinsert(
)

Insert object into DB based on previously recorded changes.

API Tags:

Return:

true on success

Redefinition of:

DataObject::dbinsert(): Insert object into DB based on previously recorded changes.

[ Top ]

dbupdate [line 289]

boolean dbupdate(
)

Update the DB based on previously recorded changes

API Tags:

Return:

true on success

Redefinition of:

DataObject::dbupdate(): Update the DB based on previously recorded changes

[ Top ]

get_Blog [line 235]

Blog &get_Blog(
)

Get the Blog object for the Chapter.

[ Top ]

get_parent_Chapter [line 117]

void &get_parent_Chapter(
)

[ Top ]

get_permanent_url [line 162]

void get_permanent_url(
[string|NULL
$link_type = NULL], [string|NULL
$blogurl = NULL], [integer
$paged = 1], [integer|NULL
$chapter_posts_per_page = NULL], [string
$glue = '&amp;'] 
)

Generate the URL to access the category.

Parameters:

string\|NULL	$link_type:	'param_num', 'subchap', 'chapters'
string\|NULL	$blogurl:	url to use
integer	$paged:	category page to link to, default:1
integer\|NULL	$chapter_posts_per_page:	number of posts per page (used for param_num only)
string	$glue:	glue between url params

[ Top ]

get_url_path [line 139]

void get_url_path(
)

Get URL path (made of URL names) back to the root

[ Top ]

load_Blog [line 249]

void load_Blog(
)

Load the Blog object for the Chapter, without returning it.

[ Top ]

load_from_request [line 90]

boolean load_from_request(
)

Load data from Request form fields.

API Tags:

Return:

true if loaded data seems valid.

Redefinition of:

GenericCategory::load_from_request(): Load data from Request form fields.

[ Top ]

Multilingual multiuser multiblog engine

Class: Chapter

Class Chapter

Packages

Classes

Files