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

Class: Pages

Source Location: /objects.php

Class Pages

Property Summary
mixed   $currentpage  
mixed   $index  

[ Top ]
Method Summary
Pages   __construct()   Initialisation
void   addChapter()   Add a chapter, and save the index
int   chapSort()   Sort the chapters based on the order and string comparison of chapter name if order is identical.
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   getChapter()   Get the information for a specific Chapter
void   getCurrentPage()   Gets the current page
array   getIndex()   Get the index of the available chapters and pages.
void   getLatestPages()   Gets the $amount latest pages as an array, suitable for displaying an overview
array   getPage()   Get a single page
array   getPageByUri()   Get a single page, as defined by its URI
void   saveIndex()   Save the index to the DB, using the selected model.
integer.   savePage()   Save a single page. Returns the uid of the inserted page.
void   updateChapter()   Update the information for a chapter, and save the index

[ Top ]
Properties
mixed   $currentpage [line 2554]

[ Top ]
mixed   $index [line 2553]

[ Top ]
Methods
Constructor __construct  [line 2561]

  Pages __construct( )

Initialisation



[ Top ]
addChapter  [line 2629]

  void addChapter( array $chapter  )

Add a chapter, and save the index

Parameters:
array   $chapter: 


[ Top ]
chapSort  [line 2772]

  int chapSort( array $a, array $b  )

Sort the chapters based on the order and string comparison of chapter name if order is identical.

Parameters:
array   $a: 
array   $b: 


[ Top ]
checkTimedPublish  [line 2793]

  void checkTimedPublish( )

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



[ Top ]
delChapter  [line 2643]

  void delChapter( integer $uid  )

Delete a chapter, and save the index

Parameters:
integer   $uid: 


[ Top ]
delPage  [line 2742]

  void delPage( integer $uid  )

Delete a single page

Parameters:
integer   $uid: 


[ Top ]
getChapter  [line 2618]

  array getChapter( integer $id  )

Get the information for a specific Chapter

Parameters:
integer   $id: 


[ Top ]
getCurrentPage  [line 2717]

  void getCurrentPage( )

Gets the current page



[ Top ]
getIndex  [line 2589]

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

Get the index of the available chapters and pages.

Parameters:
   $excerpts: 
   $links: 


[ Top ]
getLatestPages  [line 2729]

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

Gets the $amount latest pages as an array, suitable for displaying an overview

Parameters:
integer   $amount: 
   $filter_user: 


[ Top ]
getPage  [line 2688]

  array getPage( integer $uid  )

Get a single page

Parameters:
integer   $uid: 


[ Top ]
getPageByUri  [line 2704]

  array getPageByUri( string $uri  )

Get a single page, as defined by its URI

Parameters:
string   $uri: 


[ Top ]
saveIndex  [line 2671]

  void saveIndex( [boolean $reindex = true]  )

Save the index to the DB, using the selected model.

Parameters:
boolean   $reindex: 


[ Top ]
savePage  [line 2755]

  integer. savePage( array $page  )

Save a single page. Returns the uid of the inserted page.

Parameters:
array   $page: 


[ Top ]
updateChapter  [line 2658]

  void updateChapter( integer $uid, array $chapter  )

Update the information for a chapter, and save the index

Parameters:
integer   $uid: 
array   $chapter: 


[ Top ]

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