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

Class: PagesFlat

Source Location: /modules/pages_flat.php

Class PagesFlat

Property Summary
mixed   $index  

[ Top ]
Method Summary
PagesFlat   __construct()   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 ]
Properties
mixed   $index [line 22]

[ Top ]
Methods
Constructor __construct  [line 29]

  PagesFlat __construct( )

Initialisation.



[ Top ]
addChapter  [line 278]

  void addChapter( array $chapter  )

Add a chapter.

Parameters:
array   $chapter: 


[ Top ]
checkTimedPublish  [line 482]

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

  void delChapter( integer $uid  )

Delete a chapter.

Parameters:
integer   $uid: 


[ Top ]
delPage  [line 426]

  void delPage( integer $uid  )

Delete a single page

Parameters:
integer   $uid: 


[ Top ]
getIndex  [line 143]

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

Get the current index of the pages.

Parameters:
   $filter_user: 
   $excerpts: 
   $links: 


[ Top ]
getLatestPages  [line 388]

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

Gets a list of the $amount latest pages

Parameters:
integer   $amount: 
   $filter_user: 


[ Top ]
getPage  [line 330]

  array getPage( integer $uid  )

Get a single page by its uid

Parameters:
integer   $uid: 


[ Top ]
getPageByUri  [line 355]

  array getPageByUri( string $uri  )

Get a single page by its URI

Parameters:
string   $uri: 


[ Top ]
saveIndex  [line 232]

  void saveIndex( [ $reindex = true]  )

Save the index to the file system

Parameters:
   $reindex: 


[ Top ]
savePage  [line 442]

  void savePage( array $page, integer $id  )

Save a single page

Parameters:
integer   $id: 
array   $page: 


[ Top ]
setIndex  [line 267]

  void setIndex( array $index  )

Sets the index from

Parameters:
array   $index: 


[ Top ]
sort  [line 516]

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

  void updateChapter( integer $id, array $chapter  )

Update the information for a chapter.

Parameters:
integer   $id: 
array   $chapter: 


[ Top ]

Documentation generated on Tue, 05 Sep 2017 01:06:15 +0200 by phpDocumentor 1.4.3