phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: Chapter

Source Location: /qp_inc/chapters/model/_chapter.class.php

Class Chapter

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::$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::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 ]
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 47]

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

API Tags:
Access:  protected


[ Top ]
integer   $blog_ID [line 41]

[ Top ]
mixed   $description [line 50]

[ Top ]
mixed   $order [line 51]

[ Top ]
Chapter   $parent_Chapter [line 57]

Lazy filled


[ Top ]
mixed   $urlname [line 49]

[ Top ]
Methods
Constructor Chapter  [line 65]

  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( [boolean $urlname_verbose_change = true]  )

Insert object into DB based on previously recorded changes.

Parameters:
boolean   $urlname_verbose_change:  Whether to notify the user when the url title has been changed.

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 234]

  Blog &get_Blog( )

Get the Blog object for the Chapter.



[ Top ]
get_parent_Chapter  [line 116]

  void &get_parent_Chapter( )



[ Top ]
get_permanent_url  [line 161]

  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 = '&']  )

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 138]

  void get_url_path( )

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



[ Top ]
load_Blog  [line 248]

  void load_Blog( )

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



[ Top ]
load_from_request  [line 89]

  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 ]