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

Class: Parser

Source Location: /modules/module_parser.php

Class Parser

Property Summary
mixed   $action  
mixed   $html  
mixed   $maintemplate  
mixed   $modifier  

[ Top ]
Method Summary
Parser   __construct()   Initialise the Parser object.
string   get()   Returns some properties of the Parser.
string   getDebugCode()   Create the code for the debugbar and returns it..
string   getDebugCodeServerHelper()   Helper for the debugbar: Adds a section to the 'server' tab..
void   output()   Output the compiled HTML to the browser.
void   parseTemplate()   The function that does the actual rendering of the smarty template
void   render()   Wrapper for the different functions that render the different types of pages.
void   render404()   Render a '404' page, using our own templates.
void   renderCustom()   Render a custom page,
void   renderEntry()   Render an Entry, using the template as was set in the config.
void   renderFeed()   Render a 'Feed' page, using our own templates.
void   renderPage()   Render a Page, using the template that it was set to.
void   renderSearch()   Render a Search page, using the template as was set in the config.
void   renderSpecial()   Render a 'Special' page, using the template as was set in the config.
void   renderTag()   Render a Tag page, using the template as was set in the config.
void   renderWeblog()   Render a Weblog, using the template as was set in the config.
string   _cleanFeedText()   Cleans the text (to be inserted into feeds) for unwanted elements and attributes.
string   _feedTemplate()   Load the feed templates.
string   _renderFeedComments()   Creates a feed of comments.
string   _renderFeedEntries()   Creates a feed of entries.
void   _rssOffset()   Generates a time offset for the feeds (using the correct format).

[ Top ]
Properties
mixed   $action [line 38]

[ Top ]
mixed   $html [line 37]

[ Top ]
mixed   $maintemplate [line 40]

[ Top ]
mixed   $modifier [line 39]

[ Top ]
Methods
Constructor __construct  [line 50]

  Parser __construct( [string $action = "weblog"], [array $modifier = array()]  )

Initialise the Parser object.

Parameters:
string   $action: 
array   $modifier: 


[ Top ]
get  [line 71]

  string get( string $property  )

Returns some properties of the Parser.

Parameters:
string   $property: 


[ Top ]
getDebugCode  [line 1448]

  string getDebugCode( )

Create the code for the debugbar and returns it..



[ Top ]
getDebugCodeServerHelper  [line 1627]

  string getDebugCodeServerHelper( string $name, array $var, $server_log, array $padding, array $server  )

Helper for the debugbar: Adds a section to the 'server' tab..

Parameters:
string   $name: 
array   $var: 
array   $server: 
array   $padding: 
   $server_log: 


[ Top ]
output  [line 1382]

  void output( )

Output the compiled HTML to the browser.

We also takes this as an opportunity to add the 'generated by' meta-tag to the header, as well as the autodiscovery links for the XML Feeds.



[ Top ]
parseTemplate  [line 1044]

  void parseTemplate( string $template  )

The function that does the actual rendering of the smarty template

Parameters:
string   $template: 


[ Top ]
render  [line 93]

  void render( )

Wrapper for the different functions that render the different types of pages.


API Tags:
See:  $Parser::renderSearch
See:  $Parser::renderSpecial
See:  $Parser::renderTag
See:  $Parser::renderEntry
See:  $Parser::renderWeblog
See:  $Parser::renderPage


[ Top ]
render404  [line 766]

  void render404( $not_found  )

Render a '404' page, using our own templates.

Parameters:
   $not_found: 


[ Top ]
renderCustom  [line 603]

  void renderCustom( )

Render a custom page,


API Tags:
See:  $Parser::render


[ Top ]
renderEntry  [line 375]

  void renderEntry( )

Render an Entry, using the template as was set in the config.


API Tags:
See:  $Parser::render


[ Top ]
renderFeed  [line 823]

  void renderFeed( )

Render a 'Feed' page, using our own templates.


API Tags:
See:  $Parser::render


[ Top ]
renderPage  [line 142]

  void renderPage( )

Render a Page, using the template that it was set to.


API Tags:
See:  $Parser::render


[ Top ]
renderSearch  [line 555]

  void renderSearch( )

Render a Search page, using the template as was set in the config.


API Tags:
See:  $Parser::render


[ Top ]
renderSpecial  [line 664]

  void renderSpecial( )

Render a 'Special' page, using the template as was set in the config.

for now, the only 'special' page is the tagcloud overview..


API Tags:
See:  $Parser::render


[ Top ]
renderTag  [line 508]

  void renderTag( )

Render a Tag page, using the template as was set in the config.


API Tags:
See:  $Parser::render


[ Top ]
renderWeblog  [line 255]

  void renderWeblog( )

Render a Weblog, using the template as was set in the config.


API Tags:
See:  $Parser::render


[ Top ]
_cleanFeedText  [line 1937]

  string _cleanFeedText( string $text  )

Cleans the text (to be inserted into feeds) for unwanted elements and attributes.

Currently only (java)script is removed.

Parameters:
string   $text: 


[ Top ]
_feedTemplate  [line 1905]

  string _feedTemplate( string $format, string $whatpart  )

Load the feed templates.

Parameters:
string   $format:  What type of XML feed, currently Atom or RSS
string   $whatpart:  Selects ead, item or footer part of the templates


[ Top ]
_renderFeedComments  [line 1790]

  string _renderFeedComments( string $feed_template, [ $amount = 10], $comments, array $comment  )

Creates a feed of comments.

Parameters:
string   $feed_template: 
array   $comment: 
   $amount: 
   $comments: 

Information Tags:
Todo:  Do not display comments that haven't been moderated/approved.

[ Top ]
_renderFeedEntries  [line 1666]

  string _renderFeedEntries( string $feed_template, array $entries  )

Creates a feed of entries.

Parameters:
string   $feed_template: 
array   $entries: 


[ Top ]
_rssOffset  [line 1877]

  void _rssOffset( [string $type = ""]  )

Generates a time offset for the feeds (using the correct format).

Parameters:
string   $type: 


[ Top ]

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