ShipSimuGuest Class Reference
Inheritance diagram for ShipSimuGuest:
Collaboration diagram for ShipSimuGuest:
Detailed Description
A special guest class for Ship-Simu.
- 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 24 of file class_ShipSimuGuest.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. | |
| 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. | |
| flushPendingUpdates () | |
| Flushs all pending updates to the database layer. | |
| 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. | |
| getEmail () | |
| Getter for email. | |
| getField ($fieldName) | |
| Getter for field name. | |
| getPasswordHash () | |
| "Getter" for user's password hash | |
| getPrimaryKey () | |
| Getter for primary key value. | |
| 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. | |
| getUserId () | |
| Getter for user id. | |
| getUserInstance () | |
| Getter for user instance. | |
| getUserName () | |
| Getter for username. | |
| getWebOutputInstance () | |
| Getter for web output instance. | |
| ifEmailAddressExists () | |
| Determines wether the email exists or not. | |
| ifEmailAddressExists () | |
| Determines wether the email exists or not. | |
| ifGovernmentPaysStartupHelp () | |
| Determines if government can still pay a "startup help" to the user. | |
| ifGovernmentPaysTraining () | |
| Determines if government can still pay a "virtual training course" in general. | |
| ifPasswordHashMatches (Requestable $requestInstance) | |
| Checks if supplied password hash in request matches with stored in database. | |
| ifPasswordHashMatches (Requestable $requestInstance) | |
| Checks if supplied password hash in request matches with the stored in database. | |
| ifUserAllowedTakeCreditsFromMoneyBank () | |
| Checks wether the user can take points from the money bank. | |
| ifUserCreatedMaximumAllowedCompanies () | |
| Checks wether the user has reached maximum allowed companies to found. | |
| ifUserHasMaximumCreditsWithMoneyBank () | |
| Checks wether the user has maximum credits with the money bank. | |
| ifUserHasRequiredPoints ($action) | |
| Checks wether the user has the required amount of points left for the specified action. | |
| ifUsernameExists () | |
| Determines wether the username exists or not. | |
| ifUsernameExists () | |
| Determines wether the username exists or not. | |
| 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. | |
| removeNumberFormaters () | |
| Removes number formating characters. | |
| removeSystemArray () | |
| Remove the $systemClasses array from memory. | |
| 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. | |
| setUserId ($userId) | |
| Setter for user id. | |
| setUserName ($userName) | |
| Setter for username. | |
| setWebOutputInstance (OutputStreamer $webInstance) | |
| Setter for web output instance. | |
| updateDatabaseField ($fieldName, $fieldValue) | |
| Updates a given field with new value. | |
| updateDatabaseField ($fieldName, $fieldValue) | |
| Updates a given field with new value. | |
| updateLastActivity (Requestable $requestInstance) | |
| Updates the last activity timestamp and last performed action in the database result. | |
Static Public Member Functions | |
| static | createGuestByEmail ($email) |
| Creates an instance of this user class by a provided email address. | |
| static | createGuestByUsername ($userName) |
| Creates an instance of this user class by a provided username. | |
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_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_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_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_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_USER_EMAIL_NOT_FOUND = 0x171 |
| const | EXCEPTION_USER_PASS_MISMATCH = 0x172 |
| const | EXCEPTION_USERNAME_NOT_FOUND = 0x170 |
| const | EXCEPTION_VARIABLE_NOT_SET = 0x02a |
| const | EXCEPTION_WRITE_PROTECED_PATH = 0x018 |
Protected Member Functions | |
| __construct ($className=__CLASS__) | |
| Protected constructor. | |
| getApplicationInstance () | |
| Protected getter for a manageable application helper class. | |
| getDatabaseEntry () | |
| "Getter" for databse entry | |
| getFileIoInstance () | |
| Private getter for file IO instance. | |
| getLanguageInstance () | |
| Private getter for language instance. | |
| getTemplateInstance () | |
| Getter for template engine instances. | |
| 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). | |
| setEmail ($email) | |
| Setter for email. | |
| setResultInstance (SearchableResult $resultInstance) | |
| Setter for database result instance. | |
| setTemplateInstance (CompileableTemplate $templateInstance) | |
| Setter for template engine instances. | |
| setUserInstance (ManageableAccount $userInstance) | |
| Protected setter for user instance. | |
The documentation for this class was generated from the following file:
- ship-simu/application/ship-simu/main/user/extended/class_ShipSimuGuest.php
