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

Class: Display

Source Location: /display_classes/display.interface.php

Interface Overview


Project: Welcompose File: display.interface.php


Author(s):

  • Andreas Ahlenstorf

Copyright:

  • 2008 creatics, Olaf Gleba

Methods



Class Details

[line 25]
Project: Welcompose File: display.interface.php

Copyright (c) 2008 creatics

Project owner: creatics, Olaf Gleba 50939 Köln, Germany http://www.creatics.de

This file is licensed under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE v3 http://www.opensource.org/licenses/agpl-v3.html

$Id$




Tags:

author:  Andreas Ahlenstorf
copyright:  2008 creatics, Olaf Gleba
license:  GNU AFFERO GENERAL PUBLIC LICENSE v3


[ Top ]


Class Methods


constructor __construct [line 36]

Display __construct( array $project, array $page)

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.



Tags:

access:  public


Parameters:

array   $project   Project information
array   $page   Page information

[ Top ]

method getLocationSelf [line 86]

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


Parameters:

bool   $remove_amps   Remove encoded ampersands

[ Top ]

method getMainTemplateCacheLifetime [line 59]

int getMainTemplateCacheLifetime( )

Returns the cache lifetime of the current template.



Tags:

access:  public


[ Top ]

method getMainTemplateCacheMode [line 52]

int getMainTemplateCacheMode( )

Returns the cache mode for the current template.



Tags:

access:  public


[ Top ]

method getMainTemplateName [line 66]

string getMainTemplateName( )

Returns the name of the current template.



Tags:

access:  public


[ Top ]

method getRedirectLocationSelf [line 75]

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


[ Top ]

method render [line 45]

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


[ Top ]

method setTemplateHeader [line 94]

string setTemplateHeader( )

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



Tags:

access:  public


[ Top ]

method skipAuthentication [line 102]

bool skipAuthentication( )

Returns information whether to skip authentication or not.



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:46 +0100 by phpDocumentor 1.4.3