Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AbstractFilterDecoratorAn abstract filter decorator for decorating filters with other filters
AccountPasswordMismatchExceptionA class for mismatching passwords
AccountPasswordVerifierFilterA concrete filter for validating the password
ActionResolverAn instance for action resolver classes
AdminLoginHelperA helper for administration area login
AdminUserLoginA special login class for administration area
Akismet
AkismetHttpClient
AkismetObject
ApplicationEntryPointThe main class with the entry point to the whole application
ApplicationHelperA class holding general data about the application and some methods for the management including the entry point
ApplicationSelectorThe application selector class
ArrayObject
Assert
AssertionExceptionAn exception thrown when a assertion fails
AuthorizeableAn interface for authorization methods
BaseActionA general action class
BaseActionResolverA generic action resolver class
BaseApplicationA general application class for the ApplicationHelper classes
BaseCabinA general cabin class
BaseCabinStructureGeneral cabin structure class
BaseCaptchaA general captcha
BaseCommandA general (base) command
BaseCommandResolverA generic command resolver class
BaseConstructionA general construction (land) class
BaseControllerA generic controller class
BaseControllerResolverA generic controller resolver class
BaseDatabaseFrontendAn abstract database access class for handling database I/O requests
BaseDatabaseWrapperA generic database wrapper
BaseDeckA general cabin class
BaseDeckStructureA general deck structure class
BaseDiscoveryA general discovery class
BaseDriveA general drive class for all kind of "drives"
BaseFactoryA general (base) factory
BaseFilterA general filter class
BaseFrameworkSystemThe simulator system class is the super class of all other classes
BaseHelperA generic helper class with generic methods
BaseImageA general image class
BaseLoginHelperA general login helper class
BaseMailerA general mailer class for all other mailers
BaseMiddlewareAn abstract middleware class for all other middlware classes
BasePathIsEmptyExceptionAn exception thrown when the base path is empty
BasePathIsNoDirectoryExceptionAn exception thrown when the base path is no directory
BasePathReadProtectedExceptionAn exception thrown when the base path is read-protected
BasePersonellA general class for personell
BaseRegistrationA general registration class
BaseResolverA generic resolver class
BaseResponseA generic request class
BaseShipA general ship class for all other kinds of ships even small sail ships
BaseShipPartThis is a general ship part which can be used for all other ship parts
BaseShipSimuActionA general action class for blog
BaseShipSimuFilterA general filter class for Ship-Simu
BaseSimulatorThe general simulator class
BaseStructureA general construction class
BaseTemplateEngineA generic template engine
BaseUpperStructureA general upper structure class
BaseUserA general user class
BaseWebHelperA general purpose web helper
BerthA berth is a place where ships can wait for their next assignment
BirthdayInvalidExceptionAn exception for invalid birthdays (like 13-01-2008)
BirthdayVerifierFilterA verifier filter for birthday data
BridgeThe control bridge of the ship
Bzip2CompressorBZIP2 compression and decompression class
CabinShipMismatchExceptionAn exception for cabins which doesn't match the ship (why?)
CacheableAn interface for classes which are "able" to cache
CacheFactoryA cache factory
CaptchaEncryptFilterA filter for checking if value "encrypt" is set and fine
CarDeckA deck class for cars with ramps and about 2.5 meters hich
ClassLoaderThis class loads class include files with a specific prefix and suffix
ClassMismatchExceptionAn exception thrown when two classes are not matching
ClassNotFoundExceptionAn exception thrown when a class was not found
CommandableAn interface for commands for the front controller
CommandResolverAn instance for command resolver classes
CompanyDatabaseWrapperA wrapper for database access to shipping company data
CompanyEmployeeCampany employees may be handled and payed within this class
CompileableTemplateAn interface for template engines
CompressorAn interface for compression classes
CompressorChannelMiddleware class for selecting the right compressor channel
ConfigEntryIsEmptyExceptionAn exception thrown when a configuration entry is empty
ConfigEntryNotFoundExceptionAn exception thrown when a configuration entry is not found
ConfigTestA test case for the configuration sub system
ConfirmCodeVerifierFilterA filter for checking if supplied confirmation code is valid
ConsoleOutputThis class simply puts text without any HTML code out
ConsoleToolsThis class contains static helper functions for console applications
ConstructableShipAn interface for constructable ships
ConstructableShipPartAn interface for constructable ship parts
ContainerItemIsNoArrayExceptionAn exception thrown when a container item is not an array
ContainerItemIsNullExceptionAn exception thrown when a container item is null
ContainerMaybeDamagedExceptionAn exception thrown when the container is possibly damaged
ContractAllreadySignedExceptionAn exception thrown when the contract we want to sign is already signed
ContractPartnerAn interface for contract partners
ContractPartnerMismatchExceptionAn exception thrown when the contract partner did not match the excepted one
ControllerAn interface for controller
ControllerResolverAn instance for controller resolver classes
CookieAuthA cookie-bases authorization class
CriteriaAn interface for criterias
CryptableA helper class for cryptographical things like hashing passwords and so on
CryptoHelperA helper class for cryptographical things like hashing passwords and so on
CustomerAn interface for all customers
DatabaseConnectionDatabase selector class
DatabaseConnectorAn interface for middleware database classes
DatabaseExceptionA general database exception
DatabaseFrontendInterfaceAn interface for front-end database classes
DatabaseResultA database result class
DatabaseUpdateSupportExceptionAn exception thrown when a class tries an unallowed database update
DataSetCriteriaA set of data storeable in databases
DebugA dummy class for debugging
DebugConsoleOutputA debug output class for the console (e.g
DebugErrorLogOutputA debug output class for PHP's error_log() command
DebuggerAn interface for debugger classes
DebugMailerA mailer class for debugging purposes only
DebugMiddlewareThe middlware debug output system
DebugWebOutputA debug output class for the web browser
DeckShipMismatchExceptionAn exception thrown when the deck mismatches the ship (why?)
DefaultControllerExceptionThis exception is thrown when the default controller is missing
DefaultNewsReaderA default news reader class reads news from database layer
DeliverableMailAn interface for deliverable mail aka
DimNotFoundInArrayExceptionAn exception thron when dimension entries are not found in an array
DirPointerNotOpenedExceptionAn exception thrown when a directory pointer is not opended
DiscoverableAn interface for discovery
DryDockA dry dock where ships can be repaired, repainted or modified in
EconomyCabinCabins in the economy class may use this class
EmailChangeFilterA filter for detecting email changes
EmailValidatorFilterA concrete filter for validating the email address
EmptyStructuresListExceptionAn exception thrown when the structure list is empty
EmptyVariableExceptionThis exception is thrown when a variable is unexpected empty
EncryptInvalidLengthExceptionAn exception thrown when the decrypted "encrypt" string has an invalid length
EncryptMissingExceptionAn exception thrown when the "encrypt" string is missing
Exception
ExceptionNotFoundExceptionAn exception thrown when an other exception was not found
FatalErrorExceptionAn exception thrown when a "fatal" error has been captured by an error handler
FileInputStreamerAn interface for file input operations
FileIoHandlerThis is a file IO handler
FileIoStreamAn universal class for file input/output streams
FileNotFoundExceptionAn exception thrown when a file was not found
FileOutputStreamerAn interface for file output operations
FilePointerNotOpenedExceptionAn exception thrown when a file pointer is not opened
FileReadProtectedExceptionAn exception thrown when a file is read-protected
FilterableA class for pre and post filters
FilterChainA filter chain for pre and post filters
FilterChainExceptionAn exception thrown in a filter chain to stop processing further filters
FormClosedExceptionAn exception thrown when the form is still closed but input field shall be added to it
FormGroupClosedExceptionAn exception thrown when a form group is still closed
FormOpenedExceptionAn exception thrown when the form is still opened but we e.g
FrameworkArrayObjectClass for saving arrays as an object
FrameworkConfigurationA class for the configuration stuff implemented in a singleton design paddern
FrameworkDatabaseInterfaceThe general interface for all other database interfaces
FrameworkDirectoryPointerA class for directory reading and getting its contents
FrameworkExceptionA general abstract exception
FrameworkFileInputPointerA class for reading files
FrameworkFileOutputPointerA class for writing files
FrameworkInterfaceThis is the top-level interface for all other interfaces and should contain method stubs which is being used in every class
GetterNotFoundExceptionAn exception thrown when a getter for an attribute was not found
GraphicalCodeCaptchaA solveable graphical code CAPTCHA
GraphicalCodeCaptchaVerifierFilterA concrete filter for validating code graphical CAPTCHAs with hashes
GuestA generic class for handling guests
GzipCompressorGZIP compression and decompression class
HarborA harbor class suitable for all kind of harbors
HelpableLoginA helper interface for logins
HelpableTemplateA helper interface for template helper ;)
HelperGroupAlreadyCreatedExceptionAn exception thrown when a group was added twice
HelperNoPreviousOpenedSubGroupExceptionAn exception thrown when no sub group was opened previously
HelperSubGroupAlreadyCreatedExceptionAn exception thrown when a sub group was added twice
HttpRequestA concrete and secured HTTP request class to make HTTP requests more abstract
HttpResponseA class for an HTTP response on an HTTP request
ImageCodeCaptchaCommandA command for creating code CAPTCHAs
ImageCodeCaptchaControllerA controller for a code-based CAPTCHA where the user has to repeat a shown code
ImageCommandResolverA command resolver for local (non-hubbed) image commands
ImageControllerResolverA resolver for resolving controllers locally
ImageDefaultControllerA default controller for images
ImageHelperA helper for creating images
ImageResponseA class for an image response on an HTTP request
ImageTemplateEngineThe own template engine for loading caching and sending out images
InvalidActionExceptionThis exception is thrown when a requested action is invalid
InvalidArrayCountExceptionAn exception thrown when the number of array elements mismatch
InvalidBasePathStringExceptionAn exception thrown hen the base path string is invalid
InvalidCommandExceptionThis exception is thrown when a command is invalid
InvalidCommandInstanceExceptionThis exception is thrown when a command instance is invalid
InvalidContractPartnerExceptionAn exception thrown when the contract partner is invalid
InvalidControllerExceptionThis exception is thrown when the default controller is missing
InvalidDatabaseResultExceptionAn exception thrown if a database result does not contain expected entries
InvalidDataLengthExceptionAn exception thrown when the length of the data mismatch
InvalidDirectoryResourceExceptionAn exception thrown when the returned directory resource is invalid
InvalidFormNameExceptionAn exception thrown when the form name is invalid (set to false)
InvalidIDFormatExceptionAn exception thrown when the format of the id number is invalid
InvalidInterfaceExceptionAn exception thrown when an class instance does not implement a given interface
InvalidLanguagePathStringExceptionAn exception thrown when the language path string is invalid
InvalidMD5ChecksumExceptionAn exception thrown when a MD5 checksum does not exception
InvalidObjectExceptionAn exception thrown when an instance variable instances a non-object
InvalidXmlNodeExceptionAn exception thrown when an XML parser error was detected
ItemNotInPriceListExceptionAn exception thrown when the requested item is not in pricing list
ItemNotTradeableExceptionAn exception thrown when an item is not tradeable (maybe unneccessary)
LanguagePathIsEmptyExceptionAn exception thrown when the language path string is empty
LanguagePathIsNoDirectoryExceptionAn exception thrown when the language path is no directory
LanguagePathReadProtectedExceptionAn exception thrown when the language path is read-protected
LanguageSystemThe language sub-system for handling language strings being used in the application and whole framework
LocalFileDatabaseDatabase backend class for storing objects in locally created files
LocalPaymentDiscoveryA local payment discovery class
LocalSearchCriteriaAn interface for local criterias
LocalUpdateCriteriaAn interface for local criterias
LoginableUserAn interface for user login classes
LoginAfterRegistrationActionA post registration action to login after the registration is done
LowCabinCabins in the lower decks may use this class
LuxuryCabinLuxury class cabins resists here
MailTemplateEngineThe own template engine for loading caching and sending out images
ManageableAccountAn interface for manageable accounts (logged-in users and guests likewise)
ManageableApplicationAn interface for managing applications
ManageableGuestAn interface for manageable guests
ManageableLanguageAn interface for language systems
ManageableMemberAn interface for manageable users
MaschineRoomA maschine room class for really huge ships
MemberA generic class for handling users
MemoryCacheA simple memory cache (similar to a registry)
MerchantA class for merchants which can trade items
MismatchingCompressorsExceptionAn exception thrown when compressors are mismatching
MissingArrayElementsExceptionAn exception thrown when required array elements are missing
MissingDecimalsThousandsSeperatorExceptionAn exception thrown when the decimal and thousands seperators are missing
MissingFileIoHandlerExceptionAn exception thrown when the language handler is missing
MissingLanguageHandlerExceptionAn exception thrown when the language handler is missing
MissingMethodExceptionAn exception thrown when a method is missing
MissingSimulatorIdExceptionAn exception thrown when the provided simulator id is invalid
MoneyBankA money bank which may lend points to the user
MotorA motorized drive for bigger ships
MotorShipMismatchExceptionAn exception thrown when the motor does not match the ship (why?)
NewsDatabaseWrapperA database wrapper for news classes
NewsDownloadFilterA pre-filter for downloading news from a source
NewsProcessFilterA post-filter for processing downloaded news
NoArrayCreatedExceptionAn exception thrown then no array was created in a dynamic environment
NoArrayException
NoGroupOpenedExceptionAn exception thrown when a group was not opened before
NoObjectExceptionA deprecated exception which should be replaced with InvalidObjectException
NoShippingCompanyOwnedExceptionAn exception thrown when a user owns no shipping companies
NoShipyardsConstructedExceptionAn exception thrown when there are no shipyards constructed yet
NullCompressorNull compression and decompression class
NullFilterAs the name said: A null filter does just pass through the data
NullPointerExceptionAn exception thrown when an object instance is null
ObjectFactoryAn general object factory
OutputStreamerAn interface for output streams
PassengerShipA passenger ship with one or more decks, cabins, bridge (replacement for the captain) and many more
PasswordChangeFilterA filter for password change detection
PasswordGuestVerifierFilterA concrete filter for validating the guest password
PasswordValidatorFilterA concrete filter for validating the password
PasswordVerifierFilterA concrete filter for validating the password
PathIsEmptyExceptionAn exception thrown when the path string is empty
PathIsNoDirectoryExceptionAn exception thrown when a given path is not a directory
PathReadProtectedExceptionAn exception thrown when a path is read-protected
PaymentDiscoveryFilterA filter for payment discovery
PaymentsDatabaseWrapperA database wrapper for payments
PerformableActionAn interface for performable actions
PersonellizerAn interface for all personells
PersonellListAlreadyCreatedExceptionAn exception thrown when a crew list has already been initialized
PHPMailer
phpmailerTestPerforms authentication tests
PHPUnit_Framework_TestCase
PngImageA PNG image generator
POP3
PremierCabinSo-called "premier class" cabins are constructed with this class (medium class)
PrimeraApiPrimusInterface ------------------------------------------- Mit dieser Klasse ist ein einfacher Primeratransfer von Ihrem Account zu dem Account eines bei Primusportal.de registrierten Mitglieds möglich
RandomNumberGeneratorA standard random number generator
ReadableNewsAn interface for news reader
RefillPageFilterA filter for money refill page
RefillRequestValidatorFilterA filter for validating the refill request
ReflectionException
RegisterAn interface for registries
RegisterableA class for registerable classes
RegistryA registry for several data types
RegistryTestA test case for the registry
RequestableAn interface for requests
RequestTestA test case for faked HTTP requests
ResolverAn interface for all resolvers
ResponseableAn interface for responses
ResponseHeadersAlreadySentExceptionAn exception thrown when an object instance is null
ResultUpdateExceptionAn exception thrown if result was not updated
RoomShipMismatchExceptionAn exception thrown when a room mismatches the ship (why?)
RulesAcceptedFilterA filter for checking if the user has accepted the rules
SavePathIsEmptyExceptionAn exception thrown when the save path string is empty
SavePathIsNoDirectoryExceptionAn exception thrown when the save path is no directory
SavePathReadProtectedExceptionAn exception thrown when the save path is read-protected
SavePathWriteProtectedExceptionAn exception thrown when the save path is write-protected
SearchableResultAn interface for searchable results
SearchCriteriaSearch criteria for e.g
SeekableIterator
ShipNotConstructedExceptionAn exception thrown when a ship is not constructed (yet)
ShipPartNotConstructableExceptionAn exception thrown when the ship part is not constructed yet
ShippingCompanyA shipping company may be founded with this class
ShipSimuBaseUserA special member class for Ship-Simu
ShipSimuGovernmentPaysStartupHelpFilterA filter for checking if government can pay startup helps
ShipSimuGovernmentPaysTrainingFilterA filter for checking if government can pay a training for current user
ShipSimuGuestA special guest class for Ship-Simu
ShipSimuGuestLoginA special guest login class for Ship-Simu
ShipSimuLoginActionAn action class for the login welcome page
ShipSimuLoginHelperA helper for Ship-Simu to login
ShipSimuMemberA special member class for Ship-Simu
ShipSimuProfileActionAn action class for the profile page
ShipSimuRegistrationA user registration class specially for Ship-Simu
ShipSimuUserLoginA special login class for Ship-Simu
ShipSimuWebNewsFactoryA class for the special news object factory
ShipyardA shipyard construction class which can be used for constructing all kinds of ships
SignableContractAn interface for signable contracts
SimplifiedGovernmentA government class with simplified ways
SimulatorPersonellThe general simulator personell class
SMTP
SolveableCaptchaAn interface for solveable CAPTCHAs
SqlExceptionA SQL exception thrown when an SQL error was detected
stdClass
StoreableCriteriaAn interface for storeable data sets
StreamableAn interface for streams
StructureShipMismatchExceptionAn exception thrown when a structure does not match the ship (why?)
StructuresOutOfBoundsExceptionAn exception thrown when the ship part index is out of bounds
TerminalA terminal class where ships can land and passengers can board the ship
TestA test case for
TestCase
TestFailure
TestResult
TestRunner
TestSuite
TextTestResult
ToMuchEmployeesExceptionAn exception thrown when to less people are unemployed and cannot be recruited
TotalPriceNotCalculatedExceptionAn exception thrown when the total price was not calculated
TradeableItemAn interface for tradeable items
TrainDeckA train deck with rails constructed in it
TruckDeckA truck and bus decks
UnexpectedTemplateTypeExceptionAn exception thrown when the template type is not supported
UnsupportedLimitationPartExceptionAn exception thrown when the limitation type is not supported
UnsupportedTemplateEngineExceptionAn exception thrown when the template engine instance is not supported
UpdateableAn interface for classes which are allowed to update database records
UpdateableResultAn interface for searchable results
UpdateCriteriaSearch criteria for e.g
UserAuthFilterA filter for checking user permissions
UserAuthorizationExceptionAn exception thrown when authorization of the user has failed
UserDatabaseWrapperA database wrapper for the User class
UserEmailMissingExceptionA class for non-existing user emails
UserGovernmentDatabaseWrapperA wrapper for database access to government->user data
UserGuestVerifierFilterA concrete filter for verfying the guest username
UserInstanceMissingExceptionAn exception thrown when a user instance is invalid
UserNameIsGuestFilterA filter for checking if username "guest" has been choosen as configured
UsernameMissingExceptionA class for non-existing usernames
UserNameValidatorFilterA concrete filter for validating the username
UserNameVerifierFilterA concrete filter for verfying the username
UserPasswordMismatchExceptionA class for mismatching passwords
UserPointsA class for handling user points which can be real or Internet currency
UserPointsDatabaseWrapperA database wrapper for user points classes
UserRegisterA class for user registration
UserStatusConfimedUpdateFilterA filter for updating the user account status to confirmed
UserStatusVerifierFilterA filter for checking if user status is GUEST or CONFIRMED
UserUnconfirmedVerifierFilterA filter for checking if user status is UNCONFIRMED
UserUpdateFilterA filter for updating the user account like last activity, last action performed and so on
VariableIsNotSetExceptionAn exception thrown when a variable is not set
ViewHelperAn interface for view helpers
ViewHelperNotFoundExceptionAn exception thrown when a given view helper was not found
WebActionResolverA action resolver for local (non-hubbed) actions
WebAdminLoginWelcomeActionAn action class for the admin "welcome" page
WebAdminUserLoginCommandA command for user login
WebBlockHelperA helper for generating blocks (div or span) on web pages
WebCommandResolverA command resolver for local (non-hubbed) web commands
WebConfirmCommandA command for the confirmation link handling
WebConfirmControllerController for confirmation link
WebControllerResolverA resolver for resolving controllers locally
WebDefaultControllerThe default controller for all other web requests
WebDefaultNewsControllerThe default controller with news for e.g
WebDoFormCommandA command for the form processor
WebDoFormControllerA controller for handling sent forms
WebFormHelperA helper for constructing web forms
WebGovernmentFailedCommandResolverA command resolver for local (non-hubbed) web commands including the failed government request
WebGovernmentFailedControllerController for failed government requests
WebGovernmentFailedStartupCommandA command for a failed startup request
WebHomeCommandA command for the home page
WebLinkHelperA helper for web links
WebLoginAreaCommandA command for the login area (member/gamer area)
WebLoginAreaControllerController for login area with news
WebLoginCommandA command for the login form
WebLoginControllerController for login form with password reminder and maybe enabled "guest-login" button
WebLoginFailedCommandA command for the login failed page
WebLoginFailedControllerA controller for login failed page
WebLoginProfileActionAn action for the profile page in login area
WebLogoutCommandA command for logout
WebLogoutControllerThe default controller for logout page
WebLogoutDoneCommandA command for the login failed page
WebLogoutDoneControllerController for logout done page
WebNewsFactoryA news factory for web pages
WebOutputThis class simply puts HTML code / JavaScript code or CSS code out to the browser
WebRefillFormCommandA command for the money refill page
WebRegisterCommandA command class for the registration form
WebRegisterControllerController for register form
WebResendLinkCommandA command class for resending the confirmation link
WebShipsimuGovernmentStartupCommandA command for a failed startup request
WebShipsimuGuestLoginCommandA command for guest logins
WebShipSimuLoginCompanyActionAn action for shipping company page
WebShipSimuLoginGovernmentStartupHelpActionAn action for government startup help form
WebShipSimuLoginGovernmentTrainingActionAn action for trainings payed by government
WebShipSimuLoginLogoutActionAn action for logout
WebShipSimuLoginProfileActionAn action for profile (editing) page
WebShipSimuLoginRefillActionAn action for money refill page
WebShipSimuLoginWelcomeActionAn action for the welcome page
WebShipsimuProfileCommandA command for profile-update handling
WebShipsimuRegisterCommandA command for registration handling
WebShipsimuUserLoginCommandA command for user login
WebStatusControllerController for changing user status
WebTemplateEngineThe own template engine for loading caching and sending out the web pages and emails
WernisApiClass for connecting to the Wernis-Portal at http://www.wds66.com
WorksContractThe work constract class which can be used for contract parties
WrapperUserNameNotFoundExceptionAn exception thrown when the database wrapper has not found the username
WrongGenderSpecifiedExceptionAn exception thrown when a wrong gender was specified
XmlNodeMismatchExceptionAn exception thrown when an XML node does not match the excepted
XmlParserExceptionAn exception thrown when an XML parser error was detected

Generated on Mon Dec 8 01:06:50 2008 for Ship-Simulator by  doxygen 1.5.6