File Source for _chapter.class.php

<?php
/**
* This file implements the Chapter class.
*
* This file is part of Quam Plures - {@link http://quamplures.net/}
* See also {@link https://launchpad.net/quam-plures}.
*
* @copyright (c) 2009 - 2011 by the Quam Plures developers - {@link http://quamplures.net/}
* @copyright (c)2003-2009 by Francois PLANQUE - {@link http://fplanque.net/}
* Parts of this file are copyright (c)2005-2006 by PROGIDISTRI - {@link http://progidistri.com/}.
*
* {@internal License choice
* - If you have received this file as part of a package, please find the license.txt file in
* the same folder or the closest folder above for complete license terms.
* - If you have received this file individually (e-g: from http://evocms.cvs.sourceforge.net/)
* then you must choose one of the following licenses before using the file:
* - GNU General Public License 2 (GPL) - http://www.opensource.org/licenses/gpl-license.php
* - Mozilla Public License 1.1 (MPL) - http://www.opensource.org/licenses/mozilla1.1.php
* }}}
*
* {@internal Below is a list of authors who have contributed to design/coding of this file: }}
* @author fplanque: Francois PLANQUE.
*
* @package pond
*/
if( !defined('QP_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
load_class('generic/model/_genericcategory.class.php');
/**
* Chapter Class
*
* @package pond
*/
class Chapter extends GenericCategory
{
/**
* @var integer
*/
var $blog_ID;
/**
* The Blog of the Item (lazy filled, use {@link get_Blog()} to access it.
* @access protected
* @var Blog
*/
var $Blog;
var $urlname;
var $description;
var $order;
/**
* Lazy filled
* @var Chapter
*/
var $parent_Chapter;
/**
* Constructor
*
* @param table Database row
* @param integer|NULLsubset to use for new object
*/
function Chapter( $db_row = NULL, $subset_ID = NULL )
{
// Call parent constructor:
parent::GenericCategory( 'T_categories', 'cat_', 'cat_ID', $db_row );
if( is_null($db_row) )
{ // We are creating an object here:
$this->set( 'blog_ID', $subset_ID );
}
else
{ // Wa are loading an object:
$this->blog_ID = $db_row->cat_blog_ID;
$this->urlname = $db_row->cat_urlname;
$this->description = $db_row->cat_description;
$this->order = $db_row->cat_order;
}
}
/**
* Load data from Request form fields.
*
* @return boolean true if loaded data seems valid.
*/
function load_from_request()
{
global $DB, $Settings;
parent::load_from_Request();
// Check url name
param( 'cat_urlname', 'string' );
$this->set_from_Request( 'urlname' );
// Check description
param( 'cat_description', 'string' );
$this->set_from_Request( 'description' );
if( $Settings->get('chapter_ordering') == 'manual' )
{ // Manual ordering
param( 'cat_order', 'integer' );
$this->set_from_Request( 'order' );
}
return ! param_errors_detected();
}
/**
*
*/
function & get_parent_Chapter()
{
if( ! isset( $this->parent_Chapter ) )
{ // Not resoleved yet!
if( empty( $this->parent_ID ) )
{
$this->parent_Chapter = NULL;
}
else
{
$ChapterCache = & get_Cache( 'ChapterCache' );
$this->parent_Chapter = & $ChapterCache->get_by_ID( $this->parent_ID );
}
}
return $this->parent_Chapter;
}
/**
* Get URL path (made of URL names) back to the root
*/
function get_url_path()
{
$r = $this->urlname.'/';
$parent_Chapter = & $this->get_parent_Chapter();
if( !is_null( $parent_Chapter ) )
{ // Recurse:
$r = $parent_Chapter->get_url_path().$r;
}
return $r;
}
/**
* Generate the URL to access the category.
*
* @param string|NULL'param_num', 'subchap', 'chapters'
* @param string|NULLurl to use
* @param integer category page to link to, default:1
* @param integer|NULLnumber of posts per page (used for param_num only)
* @param string glue between url params
*/
function get_permanent_url( $link_type = NULL, $blogurl = NULL, $paged = 1, $chapter_posts_per_page = NULL, $glue = '&' )
{
global $DB, $cacheweekly, $Settings;
if( empty( $link_type ) )
{ // Use default from settings:
$this->get_Blog();
$link_type = $this->Blog->get_setting( 'chapter_links' );
}
if( empty( $blogurl ) )
{
$this->get_Blog();
$blogurl = $this->Blog->gen_blogurl();
}
switch( $link_type )
{
case 'param_num':
$r = url_add_param( $blogurl, 'cat='.$this->ID, $glue );
if( empty($chapter_posts_per_page) )
{ // Use default from Blog
$this->get_Blog();
$chapter_posts_per_page = $this->Blog->get_setting( 'chapter_posts_per_page' );
}
if( !empty($chapter_posts_per_page) && $chapter_posts_per_page != $this->Blog->get_setting( 'posts_per_page' ) )
{ // We want a specific post per page count:
$r = url_add_param( $r, 'posts='.$chapter_posts_per_page, $glue );
}
break;
case 'subchap':
$this->get_Blog();
$category_prefix = $this->Blog->get_setting('category_prefix');
if( !empty( $category_prefix ) )
{
$r = url_add_tail( $blogurl, '/'.$category_prefix.'/'.$this->urlname.'/' );
}
else
{
$r = url_add_tail( $blogurl, '/'.$this->urlname.'/' );
}
break;
case 'chapters':
default:
$this->get_Blog();
$category_prefix = $this->Blog->get_setting('category_prefix');
if( !empty( $category_prefix ) )
{
$r = url_add_tail( $blogurl, '/'.$category_prefix.'/'.$this->get_url_path() );
}
else
{
$r = url_add_tail( $blogurl, '/'.$this->get_url_path() );
}
break;
}
if( $paged > 1 )
{
$r = url_add_param( $r, 'paged='.$paged, $glue );
}
return $r;
}
/**
* Get the Blog object for the Chapter.
*
* @return Blog
*/
function & get_Blog()
{
if( is_null($this->Blog) )
{
$this->load_Blog();
}
return $this->Blog;
}
/**
* Load the Blog object for the Chapter, without returning it.
*/
function load_Blog()
{
if( is_null($this->Blog) )
{
$BlogCache = & get_Cache( 'BlogCache' );
$this->Blog = & $BlogCache->get_by_ID( $this->blog_ID );
}
}
/**
* Insert object into DB based on previously recorded changes.
*
* @param boolean Whether to notify the user when the url title has been changed.
* @return boolean true on success
*/
function dbinsert( $urlname_verbose_change = true )
{
global $DB;
if( $this->ID != 0 ) debug_die( 'Existing object cannot be inserted!' );
$DB->begin();
// validate url title / slug
$this->set( 'urlname', urltitle_validate( $this->urlname, $this->name,
$this->ID, false, $this->dbprefix.'urlname', $this->dbIDname,
$this->dbtablename, $urlname_verbose_change ) );
$r = parent::dbinsert();
$DB->commit();
return $r;
}
/**
* Update the DB based on previously recorded changes
*
* @return boolean true on success
*/
function dbupdate()
{
global $DB;
$DB->begin();
// validate url title / slug
if( empty($this->urlname) || isset($this->dbchanges['cat_urlname']) )
{ // Url title has changed or is empty
$this->set( 'urlname', urltitle_validate( $this->urlname, $this->name, $this->ID, false, $this->dbprefix.'urlname', $this->dbIDname, $this->dbtablename) );
}
$r = parent::dbupdate();
$DB->commit();
return $r;
}
}
?>

Source for file _chapter.class.php