Class: PagesSql

Source Location: /modules/pages_sql.php

Class PagesSql

Class Overview

Class to work with Pages, using the flat file storage model.

Located in /modules/pages_sql.php [line 22]

Properties

$shadow_columns

Methods

[ Top ]

Property Summary

static mixed

$shadow_columns

[ Top ]

Method Summary

PagesFlat	PagesSql()	Initialisation.
void	addChapter()	Add a chapter, and save the index
void	checkTimedPublish()	Checks if any pages set to 'timed publish' should be published.
void	delChapter()	Delete a chapter, and save the index
void	delPage()	Delete a single page
array	getIndex()	Get the current index of the pages.
void	getLatestPages()	Gets a list of the $amount latest pages
array	getPage()	Get a single page by its uid
array	getPageByUri()	Get a single page by its URI
array	getPageInAllLanguages()	Get a single page in all languages by its uid
integer	getUidPageShadow()	Return the UID of the shadow page for a specific page uid and language
boolean	readPageShadow()	Read shadow columns for a specific uid and language
void	sanitizePostedPage()	Sanitize pivotx back save
void	saveIndex()	Save the index to the file system
void	savePage()	Save a single page
void	savePageInAllLanguages()	Save a single page in all languages
void	setIndex()	Sets the index from
void	updateChapter()	Update the information for a chapter, and save the index

[ Top ]

Properties

static mixed $shadow_columns = array ( 'title','uri','subtitle','introduction','body','convert_lb','extra_search_text' ) [line 24]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor PagesSql [line 31]

PagesFlat PagesSql(
)

Initialisation.

[ Top ]

addChapter [line 166]

void addChapter(
array
$chapter 
)

Add a chapter, and save the index

Parameters:

array

$chapter:

[ Top ]

checkTimedPublish [line 859]

void checkTimedPublish(
)

Checks if any pages set to 'timed publish' should be published.

[ Top ]

delChapter [line 193]

void delChapter(
integer
$uid 
)

Delete a chapter, and save the index

Parameters:

integer

$uid:

[ Top ]

delPage [line 589]

void delPage(
integer
$uid 
)

Delete a single page

Parameters:

integer

$uid:

[ Top ]

getIndex [line 58]

array getIndex(
[
$filter_user = ""], [
$excerpts = false], [
$links = false] 
)

Get the current index of the pages.

Parameters:

	$filter_user:
	$excerpts:
	$links:

[ Top ]

getLatestPages [line 538]

void getLatestPages(
integer
$amount, [
$filter_user = ""], [
$language = false] 
)

Gets a list of the $amount latest pages

Parameters:

integer	$amount:
	$filter_user:
	$language:

[ Top ]

getPage [line 313]

array getPage(
integer
$uid, [
$language = false], [
$keep_extrafields = false] 
)

Get a single page by its uid

Parameters:

integer	$uid:
	$language:
	$keep_extrafields:

[ Top ]

getPageByUri [line 411]

array getPageByUri(
string
$uri, [mixed
$language = false], [
$keep_extrafields = false] 
)

Get a single page by its URI

Parameters:

string	$uri:
mixed	$language:	if string get a specific language version of a page, \ if false get the current language
	$keep_extrafields:

[ Top ]

getPageInAllLanguages [line 378]

array getPageInAllLanguages(
integer
$uid 
)

Get a single page in all languages by its uid

Parameters:

integer

$uid:

[ Top ]

getUidPageShadow [line 247]

integer getUidPageShadow(

$uid, 
$language 
)

Return the UID of the shadow page for a specific page uid and language

Parameters:

	$uid:
	$language:

API Tags:

Return:	return -1 if there is no shadow page or uid if there is
Access:	protected

[ Top ]

readPageShadow [line 279]

boolean readPageShadow(

$page_uid, array
&$page, string
$language, integer
$uid 
)

Read shadow columns for a specific uid and language

Parameters:

integer	$uid:	page uid
array	&$page:	page assoc. array
string	$language:	language to read
	$page_uid:

API Tags:

Return:	true if shadow data available
Access:	protected

[ Top ]

sanitizePostedPage [line 833]

void sanitizePostedPage(
array
&$page 
)

Sanitize pivotx back save

Parameters:

array

&$page:

page to save values in

[ Top ]

saveIndex [line 143]

void saveIndex(
)

Save the index to the file system

[ Top ]

savePage [line 624]

void savePage(
array
$page, [string
$language = false] 
)

Save a single page

Parameters:

array	$page:
string	$language:

[ Top ]

savePageInAllLanguages [line 795]

void savePageInAllLanguages(
array
$page 
)

Save a single page in all languages

Parameters:

array

$page:

[ Top ]

setIndex [line 154]

void setIndex(
array
$index 
)

Sets the index from

Parameters:

array

$index:

[ Top ]

updateChapter [line 219]

void updateChapter(
integer
$id, array
$chapter 
)

Update the information for a chapter, and save the index

Parameters:

integer	$id:
array	$chapter:

[ Top ]

Documentation generated on Thu, 17 May 2012 01:07:29 +0200 by phpDocumentor 1.4.3

	pivotx

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