AdminLoginHelper Class Reference

Inheritance diagram for AdminLoginHelper:

[legend]

Collaboration diagram for AdminLoginHelper:

[legend]

List of all members.

---

Detailed Description

A helper for administration area login.

This login helper first checks what setting (cookie or session) the admin has choosen then overwrites it with the setting from current user. The registry instance should hold an instance of this user class at key 'user' else an exception will be thrown. After this the setting from a login form will be taken as login method and be stored in database for later usage.

The user shall be able to choose "Default login method" or similar to use his own login method.

Author:

Roland Haeder <webmaster@ship-simu.org>

Version:

0.0.0 Copyright (c) 2007, 2008 Roland Haeder, this is free software GNU GPL 3.0 or any newer version This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Definition at line 32 of file class_AdminLoginHelper.php.

Public Member Functions
	__call ($methodName, $args)
	The call method where all non-implemented methods end up.
	__toString ()
	Getter for $realClass.
	addMissingTrailingSlash ($str)
	Appends a trailing slash to a string.
	assignField ($fieldName)
	Assigns a field from the value instance with a template variable.
	assignFieldWithFilter ($fieldName, $filterMethod)
	Assigns a field from the value instance with a template variable but parses its content through a given filter method of the value instance.
	closePreviousGroupByContent ($content="")
	Closes the previously opened group by added given content to it or throws an exception if no previous group was opened.
	closePreviousSubGroupByContent ($content="")
	Closes the previously opened sub group by added given content to it or throws an exception if no previous sub group was opened.
	convertToClassName ($str)
	Converts e.g.
	debugBackTrace ()
	Outputs a debug backtrace and stops further script execution.
	debugInstance ($message="")
	Debugs this instance by putting out it's full content.
	debugOutput ($message, $doPrint=true)
	Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message.
	doFilterFormatTimestamp ($timestamp)
	Filter a given GMT timestamp (non Uni* stamp!) to make it look more beatiful for web-based front-ends.
	executeLogin (Responseable $responseInstance)
	Execute the login request by given response instance.
	formatCurrency ($value, $currency="€", $decNum=2)
	Formats computer generated price values into human-understandable formats with thousand and decimal seperators.
	getCompressorChannel ()
	Getter for compressor channel.
	getConfigInstance ()
	Getter for configuration instance.
	getControllerInstance ()
	Getter for controller instance (this surely breaks a bit the MVC patterm).
	getDatabaseInstance ()
	Getter for database layer.
	getDebugInstance ()
	Getter for debug instance.
	getField ($fieldName)
	Getter for field name.
	getRequestInstance ()
	Getter for request instance.
	getResolverInstance ()
	Getter for resolver instance.
	getResponseInstance ()
	Getter for response instance.
	getResultInstance ()
	Getter for database result instance.
	getSearchInstance ()
	Getter for search instance.
	getUserInstance ()
	Getter for user instance.
	getValueField ($fieldName)
	Getter for direct field values.
	getValueInstance ()
	Getter for value instance.
	getWebOutputInstance ()
	Getter for web output instance.
	isCabin ()
	Stub method (only real cabins shall override it).
	isClass ($className)
	Compare class name of this and given class name.
	isTradeable ()
	Stub method for tradeable objects.
	markupCode ($phpCode)
	Marks up the code by adding e.g.
	prefetchValueInstance ($registryKey, $extraKey=null)
	Pre-fetches field default values from the given registry key instance into this class.
	removeNumberFormaters ()
	Removes number formating characters.
	removeSystemArray ()
	Remove the $systemClasses array from memory.
	renderContent ()
	Renders all group and sub group in their order.
	setApplicationInstance (ManageableApplication $applicationInstance)
	Setter for a manageable application helper class.
	setCompressorChannel (CompressorChannel $compressorChannel)
	Setter for compressor channel.
	setConfigInstance (FrameworkConfiguration $configInstance)
	Setter for language instance.
	setControllerInstance (Controller $controllerInstance)
	Setter for controller instance (this surely breaks a bit the MVC patterm).
	setDatabaseInstance (DatabaseConnection $dbInstance)
	Setter for database instance.
	setDebugInstance (DebugMiddleware $debugInstance)
	Setter for debug instance.
	setFileIoInstance (FileIoHandler $fileIoInstance)
	Setter for file I/O instance.
	setLanguageInstance (ManageableLanguage $langInstance)
	Setter for language instance.
	setRealClass ($realClass)
	Setter for the real class name.
	setRequestInstance (Requestable $requestInstance)
	Setter for request instance.
	setResolverInstance (Resolver $resolverInstance)
	Setter for resolver instance.
	setResponseInstance (Responseable $responseInstance)
	Setter for response instance.
	setSearchInstance (LocalSearchCriteria $searchInstance)
	Setter for search instance.
	setWebOutputInstance (OutputStreamer $webInstance)
	Setter for web output instance.
Static Public Member Functions
static	createAdminLoginHelper (Requestable $requestInstance)
	Creates an instance of this class by given request instance.
Public Attributes
const	EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c
const	EXCEPTION_ARRAY_EXPECTED = 0x01f
const	EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020
const	EXCEPTION_ASSERTION_FAILED = 0x037
const	EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b
const	EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b
const	EXCEPTION_CLASS_NOT_FOUND = 0x033
const	EXCEPTION_CLASSES_NOT_MATCHING = 0x005
const	EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026
const	EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028
const	EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013
const	EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011
const	EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012
const	EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039
const	EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032
const	EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007
const	EXCEPTION_DIR_POINTER_INVALID = 0x019
const	EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c
const	EXCEPTION_FATAL_ERROR = 0x035
const	EXCEPTION_FILE_CANNOT_BE_READ = 0x038
const	EXCEPTION_FILE_NOT_FOUND = 0x036
const	EXCEPTION_FILE_POINTER_INVALID = 0x01a
const	EXCEPTION_GENDER_IS_WRONG = 0x00a
const	EXCEPTION_GETTER_IS_MISSING = 0x01e
const	EXCEPTION_GROUP_ALREADY_FOUND = 0x1e4
const	EXCEPTION_GROUP_NOT_OPENED = 0x1e3
const	EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010
const	EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d
const	EXCEPTION_HEADERS_ALREADY_SENT = 0x031
const	EXCEPTION_ID_IS_INVALID_FORMAT = 0x021
const	EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006
const	EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b
const	EXCEPTION_INVALID_PATH_NAME = 0x016
const	EXCEPTION_INVALID_STRING = 0x029
const	EXCEPTION_INVALID_USER_INSTANCE = 0x190
const	EXCEPTION_IS_NO_ARRAY = 0x003
const	EXCEPTION_IS_NO_OBJECT = 0x002
const	EXCEPTION_IS_NULL_POINTER = 0x001
const	EXCEPTION_ITEM_IS_NO_ARRAY = 0x027
const	EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009
const	EXCEPTION_ITEM_NOT_TRADEABLE = 0x008
const	EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d
const	EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022
const	EXCEPTION_MISMATCHING_COMPRESSORS = 0x025
const	EXCEPTION_MISSING_ELEMENT = 0x030
const	EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f
const	EXCEPTION_MISSING_LANGUAGE_HANDLER = 0x02e
const	EXCEPTION_MISSING_METHOD = 0x004
const	EXCEPTION_NO_PREVIOUS_GROUP_OPENED = 0x1e7
const	EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED = 0x1e6
const	EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e
const	EXCEPTION_PATH_NOT_FOUND = 0x015
const	EXCEPTION_READ_PROTECED_PATH = 0x017
const	EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034
const	EXCEPTION_SIMULATOR_ID_INVALID = 0x024
const	EXCEPTION_SUB_GROUP_ALREADY_FOUND = 0x1e5
const	EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d
const	EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f
const	EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014
const	EXCEPTION_UNEXPECTED_OBJECT = 0x01c
const	EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023
const	EXCEPTION_VARIABLE_NOT_SET = 0x02a
const	EXCEPTION_WRITE_PROTECED_PATH = 0x018
const	EXCEPTION_XML_NODE_MISMATCH = 0x1e2
const	EXCEPTION_XML_NODE_UNKNOWN = 0x1e1
const	EXCEPTION_XML_PARSER_ERROR = 0x1e0
Protected Member Functions
	__construct ()
	Protected constructor.
	addContent ($newContent)
	Adds content directly.
	addContentToPreviousGroup ($newContent)
	Adds content to the previously opened group or sub group.
	addFooterContent ($content)
	Add footer content to the helper.
	addHeaderContent ($content)
	Add header content to the helper.
	getApplicationInstance ()
	Protected getter for a manageable application helper class.
	getContent ()
	Getter for content.
	getDatabaseEntry ()
	"Getter" for databse entry
	getFileIoInstance ()
	Private getter for file IO instance.
	getLanguageInstance ()
	Private getter for language instance.
	getPreviousGroupId ()
	Getter for previous group id.
	getPreviousSubGroupId ()
	Getter for previous sub group id.
	getTemplateInstance ()
	Getter for template engine instances.
	ifGroupIsOpened ($groupId)
	Checks wether the specified group is opened.
	ifGroupOpenedPreviously ()
	Check wether a group was opened previously.
	ifSubGroupOpenedPreviously ()
	Check wether a group was opened previously.
	openGroupByIdContent ($groupId, $content, $tag)
	Opens a helper group with given group id and content or throws an exception if that group is already found regardless if it is open or closed.
	openSubGroupByIdContent ($subGroupId, $content, $tag)
	Opens a helper sub group with given group id and content or throws an exception if that sub group is already found regardless if it is open or closed.
	partialStub ($message="")
	Output a partial stub message for the caller method.
	prepareTemplateInstance (BaseFrameworkSystem $appInstance=null)
	Prepare the template engine (WebTemplateEngine by default) for a given application helper instance (ApplicationHelper by default).
	setDefaultAuthMethod ()
	Setter for default login method from config.
	setPreviousGroupId ($previousGroupId)
	Setter for previous group id.
	setPreviousSubGroupId ($previousSubGroupId)
	Setter for previous sub group id.
	setResultInstance (SearchableResult $resultInstance)
	Setter for database result instance.
	setTemplateInstance (CompileableTemplate $templateInstance)
	Setter for template engine instances.
	setUserInstance (ManageableAccount $userInstance)
	Protected setter for user instance.
Private Attributes
	$authMethod = ""
	The login method we shall choose.

---

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

• ship-simu/application/admin/main/login/helper/class_AdminLoginHelper.php