HtmlInterface Class Reference

Inheritance diagram for HtmlInterface:

[legend]Collaboration diagram for HtmlInterface:

[legend]List of all members.

Public Member Functions
	HtmlInterface ($modname=null)
	GetInterfacePath ()
&	GetInterfaceModule ()
	GetLoginPath ()
&	GetLoginModule ()
	GetCurrentModulePath ()
	GetModulePath ($module)
	LoadCurrentModule ()
	CheckSession ()
	GetCSSPath ()
Public Attributes
	$webpath
	The web path of the system.
	$modules
	The Modules object.
	$errorloading
	module

---

Detailed Description

Class that handles the HTML interface of the system.

Definition at line 12 of file HtmlInterface.class.php.

---

Constructor & Destructor Documentation

HtmlInterface::HtmlInterface (  $  modname = null  )

The constructor. If the module sets a value to modname the constructor also calls to JSystem::InitModule($modname) in order to initialize the global variables and to check whether the session is still alive or not. Parameters: modname  The name of the module that is creating the HtmlInterface. Definition at line 25 of file HtmlInterface.class.php. References JSystem::GetConfig(), Modules::GetInstance(), JSystem::InitModule(), and JSystem::IsError().

---

Member Function Documentation

HtmlInterface::CheckSession (   )

Static method that checks if the user is logged and shows an error if he isn't. Definition at line 124 of file HtmlInterface.class.php. References JSystem::GetConfig(), JSystem::IsError(), and JSystem::IsLogged().

HtmlInterface::GetCSSPath (   )

Static method that returns the path where the CSS is. Returns: string The CSS path. Definition at line 147 of file HtmlInterface.class.php. References JSystem::GetConfig().

HtmlInterface::GetCurrentModulePath (   )

Returns the path to load the html interface of the current module. Returns: string Definition at line 82 of file HtmlInterface.class.php. References $module, and JSystem::GetCurrentModule().

& HtmlInterface::GetInterfaceModule (   )

Returns the name of the Html Interface module. Returns: Module Definition at line 52 of file HtmlInterface.class.php. References JSystem::GetConfig().

HtmlInterface::GetInterfacePath (   )

Gets the HTML Interface of the system. Returns: string The path of the interface. Definition at line 43 of file HtmlInterface.class.php.

& HtmlInterface::GetLoginModule (   )

Returns the name of the Html Login module. Returns: Module Definition at line 71 of file HtmlInterface.class.php. References JSystem::GetConfig().

HtmlInterface::GetLoginPath (   )

Gets the HTML login of the system. Returns: string The path of the login module. Definition at line 62 of file HtmlInterface.class.php.

HtmlInterface::GetModulePath (  $  module  )

Returns the path to load the html interface of the given module. Parameters: module  A Module object. Returns: string Definition at line 93 of file HtmlInterface.class.php. References $module, and $url.

HtmlInterface::LoadCurrentModule (   )

Loads the HTML interface of the current module using the location HTTP header. Returns: boolean False if there was an error and the redirection couldn't be done due to the headers were already sent, for example. Definition at line 107 of file HtmlInterface.class.php.

---

Member Data Documentation

HtmlInterface::$errorloading

module Indicates whether there was an error loading the Definition at line 16 of file HtmlInterface.class.php.

HtmlInterface::$modules

The Modules object. Definition at line 15 of file HtmlInterface.class.php.

HtmlInterface::$webpath

The web path of the system. Definition at line 14 of file HtmlInterface.class.php.

---

The documentation for this class was generated from the following file:

• HtmlInterface.class.php

---