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

Class: PagesSql

Source Location: /modules/pages_sql.php

Class PagesSql

Class Overview
Method Summary
PagesFlat   __construct()   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
void   saveIndex()   Save the index to the file system
void   savePage()   Save a single page
void   setIndex()   Sets the index from
void   updateChapter()   Update the information for a chapter, and save the index

[ Top ]
Methods
Constructor __construct  [line 28]

  PagesFlat __construct( )

Initialisation.



[ Top ]
addChapter  [line 161]

  void addChapter( array $chapter  )

Add a chapter, and save the index

Parameters:
array   $chapter: 


[ Top ]
checkTimedPublish  [line 511]

  void checkTimedPublish( )

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



[ Top ]
delChapter  [line 189]

  void delChapter( integer $uid  )

Delete a chapter, and save the index

Parameters:
integer   $uid: 


[ Top ]
delPage  [line 365]

  void delPage( integer $uid  )

Delete a single page

Parameters:
integer   $uid: 


[ Top ]
getIndex  [line 53]

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

Get the current index of the pages.

Parameters:
   $filter_user: 
   $excerpts: 
   $links: 


[ Top ]
getLatestPages  [line 330]

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

Gets a list of the $amount latest pages

Parameters:
integer   $amount: 
   $filter_user: 


[ Top ]
getPage  [line 245]

  array getPage( integer $uid  )

Get a single page by its uid

Parameters:
integer   $uid: 


[ Top ]
getPageByUri  [line 286]

  array getPageByUri( string $uri  )

Get a single page by its URI

Parameters:
string   $uri: 


[ Top ]
saveIndex  [line 138]

  void saveIndex( )

Save the index to the file system



[ Top ]
savePage  [line 387]

  void savePage( array $page, integer $id  )

Save a single page

Parameters:
integer   $id: 
array   $page: 


[ Top ]
setIndex  [line 149]

  void setIndex( array $index  )

Sets the index from

Parameters:
array   $index: 


[ Top ]
updateChapter  [line 215]

  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 Tue, 05 Sep 2017 01:06:15 +0200 by phpDocumentor 1.4.3