Class: PagesFlat

Source Location: /modules/pages_flat.php

Class PagesFlat

Class Overview

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

Located in /modules/pages_flat.php [line 20]

Method Summary

PagesFlat	PagesFlat()	Initialisation.
void	addChapter()	Add a chapter.
void	checkTimedPublish()	Checks if any pages set to 'timed publish' should be published.
void	delChapter()	Delete a chapter.
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
void	saveIndex()	Save the index to the file system
void	savePage()	Save a single page
void	setIndex()	Sets the index from
int	sort()	Sort the pages based on the order and string comparison of (page) title if order is identical.
void	updateChapter()	Update the information for a chapter.

[ Top ]

Methods

Constructor PagesFlat [line 27]

PagesFlat PagesFlat(
)

Initialisation.

[ Top ]

addChapter [line 276]

void addChapter(
array
$chapter 
)

Add a chapter.

Parameters:

array

$chapter:

[ Top ]

checkTimedPublish [line 474]

void checkTimedPublish(
)

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

This code might have to be optimized to only check the latest pages for a very big site.

[ Top ]

delChapter [line 296]

void delChapter(
integer
$uid 
)

Delete a chapter.

Parameters:

integer

$uid:

[ Top ]

delPage [line 418]

void delPage(
integer
$uid 
)

Delete a single page

Parameters:

integer

$uid:

[ Top ]

getIndex [line 141]

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

Get the current index of the pages.

Parameters:

	$filter_user:
	$excerpts:
	$links:

[ Top ]

getLatestPages [line 386]

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

Gets a list of the $amount latest pages

Parameters:

integer	$amount:
	$filter_user:

[ Top ]

getPage [line 328]

array getPage(
integer
$uid 
)

Get a single page by its uid

Parameters:

integer

$uid:

[ Top ]

getPageByUri [line 353]

array getPageByUri(
string
$uri 
)

Get a single page by its URI

Parameters:

string

$uri:

[ Top ]

saveIndex [line 230]

void saveIndex(
[
$reindex = true] 
)

Save the index to the file system

Parameters:

$reindex:

[ Top ]

savePage [line 434]

void savePage(
array
$page, integer
$id 
)

Save a single page

Parameters:

integer	$id:
array	$page:

[ Top ]

setIndex [line 265]

void setIndex(
array
$index 
)

Sets the index from

Parameters:

array

$index:

[ Top ]

sort [line 508]

int sort(
array
$a, array
$b 
)

Sort the pages based on the order and string comparison of (page) title if order is identical.

Parameters:

array	$a:
array	$b:

[ Top ]

updateChapter [line 311]

void updateChapter(
integer
$id, array
$chapter 
)

Update the information for a chapter.

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 ]