Welcompose
[ class tree: Welcompose ] [ index: Welcompose ] [ all elements ]

Class: Display_SimplePageIndex

Source Location: /display_classes/simplepageindex.class.php

Class Overview




Implements interfaces:

Variables

Methods



Class Details

[line 56]


[ Top ]


Class Variables

$base =  null

[line 63]

Reference to base class



Tags:

access:  public

Type:   object


[ Top ]

$_page = array()

[line 77]

Container for page information



Tags:

access:  protected

Type:   array


[ Top ]

$_project = array()

[line 70]

Container for project information



Tags:

access:  protected

Type:   array


[ Top ]

$_simple_page = array()

[line 84]

Container for simple page information



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 97]

Display_SimplePageIndex __construct( array $project, array $page, array 2)

Creates new instance of display driver. Takes an array with the project information as first argument, an array with the information about the current page as second argument.



Tags:

throws:  Display_SimplePageIndexException
access:  public



Implementation of:
Display::__construct()
Creates new instance of display driver. Takes an array with the project information as first argument, an array with the information about the current page as second argumenht.

Parameters:

array   2   Simple page content
array   $project   Project information
array   $page   Page information

[ Top ]

method getLocationSelf [line 198]

string getLocationSelf( [bool $remove_amps = false])

Returns the redirect location of the the current document (~ $PHP_SELF without it's problems). Already encoded ampersands will be removed if the optional parameter remove_amps is set to true.



Tags:

access:  public



Implementation of:
Display::getLocationSelf()
Returns the redirect location of the the current document (~ $PHP_SELF without it's problems). Already encoded ampersands will be removed if the optional parameter remove_amps is set to true.

Parameters:

bool   $remove_amps   Remove encoded ampersands

[ Top ]

method getMainTemplateCacheLifetime [line 162]

int getMainTemplateCacheLifetime( )

Returns the cache lifetime of the current template.



Tags:

access:  public



Implementation of:
Display::getMainTemplateCacheLifetime()
Returns the cache lifetime of the current template.
[ Top ]

method getMainTemplateCacheMode [line 152]

int getMainTemplateCacheMode( )

Returns the cache mode for the current template.



Tags:

access:  public



Implementation of:
Display::getMainTemplateCacheMode()
Returns the cache mode for the current template.
[ Top ]

method getMainTemplateName [line 172]

string getMainTemplateName( )

Returns the name of the current template.



Tags:

access:  public



Implementation of:
Display::getMainTemplateName()
Returns the name of the current template.
[ Top ]

method getRedirectLocationSelf [line 184]

string getRedirectLocationSelf( )

Returns the redirect location of the the current document (~ $PHP_SELF without it's problems) with the Location: header prepended.



Tags:

access:  public



Implementation of:
Display::getRedirectLocationSelf()
Returns the redirect location of the the current document (~ $PHP_SELF without it's problems) with the Location: header prepended.
[ Top ]

method render [line 141]

bool render( )

Default method that will be called from the display script and has to care about the page preparation. Returns boolean true on success.



Tags:

access:  public



Implementation of:
Display::render()
Default method that will be called from the display script and has to care about the page preparation. Returns boolean true on success.
[ Top ]

method setTemplateHeader [line 224]

string setTemplateHeader( )

Returns appropriate header For example this should be used to asure valid feed output



Tags:

access:  public



Implementation of:
Display::setTemplateHeader()
Returns appropriate header For example this should be used to asure valid feed output
[ Top ]

method skipAuthentication [line 235]

bool skipAuthentication( )

Returns information whether to skip authentication or not.



Tags:

access:  public



Implementation of:
Display::skipAuthentication()
Returns information whether to skip authentication or not.
[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:52:02 +0100 by phpDocumentor 1.4.3