eZPublishCommunityProject(LegacyStack)  2013.9
lib Namespace Reference

File containing the eZClusterFileHandlerInterface interface. More...

Detailed Description

File containing the eZClusterFileHandlerInterface interface.

File containing the eZPublishSDK class.

File containing the eZWizardBaseClassLoader class.

File containing the eZWizardBase class.

File containing the eZURI class.

File containing the eZTextTool class.

File containing the eZSysInfo class.

Easy access to various system settings.

File containing the eZSys class.

File containing the eZStringUtils class.

File containing the eZSMTPTransport class.

File containing the eZSendmailTransport class.

This class provides tools around remote ids.

File containing the eZRemoteIdUtility class.

File containing the eZRegExpValidator class.

File containing the eZProcess class.

File containing the eZPHPCreator class.

File containing the eZOperationMemento class.

File containing the eZOperationHandler class.

File containing the eZMutex class.

File containing the eZModuleOperationInfo class.

File containing the eZModuleFunctionInfo class.

File containing the eZModule class.

File containing the eZMimeType class.

File containing the eZMath class.

File containing the eZMailTransport class.

File containing the eZMail class.

File containing the eZIntegerValidator class.

File containing the eZInputValidator class.

File containing the eZINI class.

File containing the eZHTTPTool class.

File containing the eZHTTPPersistence class.

File containing the eZHTTPFile class.

File containing the eZFunctionHandler class.

File containing the eZFloatValidator class.

File containing the eZFileTransport class.

File containing the eZExtension class.

File containing the eZExpiryHandler class.

File containing the eZExecution class.

File containing the eZDebugSetting class.

File containing the eZDebug class.

File containing the eZDateTimeValidator class.

File containing the eZCLI class.

File containing the eZTemplateWhileFunction class.

File containing the eZTemplateVariableElement class.

File containing the eZTemplateUnitOperator class.

File containing the eZTemplateTypeOperator class.

File containing the eZTemplateTreeCache class.

File containing the eZTemplateToolbarFunction class.

File containing the eZTemplateTextOperator class.

File containing the eZTemplateTextElement class.

File containing the eZTemplateSwitchFunction class.

File containing the eZTemplateStringOperator class.

File containing the eZTemplateSetFunction class.

File containing the eZTemplateSequenceFunction class.

File containing the eZTemplateSectionIterator class.

File containing the eZTemplateSectionFunction class.

File containing the eZTemplateRoot class.

File containing the eZTemplatePHPOperator class.

File containing the eZTemplateParser class.

File containing the eZTemplateOptimizer class.

File containing the eZTemplateOperatorElement class.

File containing the eZTemplateOperator class.

File containing the eZTemplateNodeTool class.

File containing the eZTemplateNl2BrOperator class.

File containing the eZTemplateMultiPassParser class.

File containing the eZTemplateMenuFunction class.

File containing the eZTemplateLoop class.

File containing the eZTemplateLogicOperator class.

File containing the eZTemplateLocaleOperator class.

File containing the eZTemplateIncludeFunction class.

File containing the eZTemplateImageOperator class.

File containing the eZTemplateIfFunction class.

File containing the eZTemplateFunctionElement class.

File containing the eZTemplateForFunction class.

File containing the eZTemplateForeachFunction class.

File containing the eZTemplateFileResource class.

File containing the eZTemplateExecuteOperator class.

File containing the eZTemplateElementParser class.

File containing the eZTemplateDoFunction class.

File containing the eZTemplateDigestOperator class.

File containing the eZTemplateDelimitFunction class.

File containing the eZTemplateDefFunction class.

File containing the eZTemplateDebugFunction class.

File containing the eZTemplateControlOperator class.

File containing the eZTemplateCompiler class.

File containing the eZTemplateCompiledLoop class.

File containing the eZTemplateCacheFunction class.

File containing the eZTemplateCacheBlock class.

File containing the eZTemplateBlockFunction class.

File containing the eZTemplateAttributeOperator class.

File containing the eZTemplateArrayOperator class.

File containing the eZTemplateArithmeticOperator class.

File containing the eZTemplate class.

Exception occuring when the execution of a compiled template fails.

File containing the eZTemplateFailedExecutingCompiledTemplate exception.

File containing the eZSOAPServer class.

File containing the eZSOAPResponse class.

File containing the eZSOAPRequest class.

File containing the eZSOAPParameter class.

File containing the eZSOAPHeader class.

File containing the eZSOAPFault class.

File containing the eZSOAPEnvelope class.

File containing the eZSOAPCodec class.

File containing the eZSOAPClient class.

File containing the eZSOAPBody class.

eZ Publish Session interface class

File containing session interface.

Symfony session handler.

File containing Symfony session handler.

PHP session handler class Does not register it self as opposed to most other handler, as the point is to let PHP handle most things.

File containing PHP session handler.

DB session handler class.

File containing DB session handler.

Abstract session handler class to extend.

File containing abstract session handler.

File containing the eZPDF class.

File containing the Cpdf class.

File containing the eZPDFTable class.

File containing the Cezpdf class.

File containing the eZPHPMath class.

File containing the eZBCMath class.

File containing the eZTime class.

File containing the eZLocale class.

File containing the eZDateUtils class.

File containing the eZDateTime class.

File containing the eZDate class.

File containing the eZCurrency class.

File containing the eZImageTextLayer class.

File containing the eZImageShellHandler class.

File containing the eZImageShellFactory class.

File containing the eZImageObject class.

File containing the eZImageManager class.

File containing the eZImageLayer class.

File containing the eZImageInterface class.

File containing the eZImageHandler class.

File containing the eZImageGDHandler class.

File containing the eZImageGDFactory class.

File containing the eZImageFont class.

File containing the eZImageFactory class.

File containing the eZImageAnalyzer class.

File containing the eZGIFImageAnalyzer class.

File containing the eZEXIFImageAnalyzer class.

File containing the eZUTF8Codec class.

Provides internationalization using XML (.ts) files.

File containing the eZTSTranslator class.

File containing the eZTranslatorManager class.

File containing the eZTranslatorHandler class.

File containing the eZTranslatorGroup class.

File containing the eZTranslationCache class.

File containing the eZTextCodec class.

File containing the eZShuffleTranslator class.

File containing the eZRandomTranslator class.

File containing the eZMBStringMapper class.

File containing the eZCodePageMapper class.

File containing the eZCodePageCodec class.

File containing the eZCodePage class.

File containing the eZCodeMapper class.

File containing the eZCharTransform class.

File containing the eZCharsetInfo class.

File containing the eZBorkTranslator class.

File containing the eZ1337Translator class.

File containing the eZNoCompressionHandler class.

File containing the eZMD5 class.

File containing the eZLog class.

File containing the eZGZIPZLIBCompressionHandler class.

File containing the eZGZIPShellCompressionHandler class.

File containing the eZGZIPCompressionHandler class.

File containing the eZForwardCompressionHandler class.

File containing the eZFileHandler class.

File containing the eZFile class.

File containing the eZDir class.

File containing the eZCompressionHandler class.

File containing the eZBZIP2Handler class.

File containing the eZXMLTextDiff class.

File containing the eZTextDiff class.

File containing the eZDiffXMLTextEngine class.

File containing the eZDiffTextEngine class.

File containing the eZDiffMatrix class.

File containing the eZDiffEngine class.

File containing the eZDiffContent class.

File containing the eZDiffContainerObjectEngine class.

File containing the eZDiffContainerObject class.

File containing the eZDiff class.

File containing the eZPgsqlSchema class.

File containing the eZMysqlSchema class.

File containing the eZLintSchema class.

File containing the eZDBSchemaInterface class.

File containing the eZDbSchemaChecker class.

File containing the eZDbSchema class.

File containing the eZPostgreSQLDB class.

File containing the eZNullDB class.

File containing the eZMySQLiDB class.

File containing the eZMySQLCharset class.

File containing the eZDBTool class.

The eZDBInterface defines the interface for all database implementations.

File containing the eZDBInterface class.

File containing the eZDB class.

Version
2013.9
Todo:
Convert methods and variables marked as protected/private to protected/private methods and variables
Version
2013.9
Since
4.4

CALLBACKS: destroy, gc, regenerate & cleanup functions MUST implement callbacks. Definition is documented in functions on this class, examples can be found in the handlers and examples of use can be sessin in ezsession.php class doc section.

Since
4.4
4.4

Basically, it let Symfony manage the session and call the Symfony session storage when needed for very specific operation.

Session wrapper for session management, with support for handlers. Handler is defined by site.ini[Session] setting.

The session system has a hook system which allows external code to perform extra tasks before and after a certain action is executed. For instance to cleanup a table when sessions are removed. This can be used by adding a callback with the eZSession::addCallback function, first param is type and second is callback (called with call_user_func_array)

* function cleanupStuff( $db, $key, $escKey )
* {
* // Do cleanup here
* }
*
* eZSession::addCallback( 'destroy_pre', 'cleanupstuff');
* // Or if it was a class function:
* // eZSession::addCallback( 'destroy_pre', array('myClass', 'myCleanupStuff') );
*

When a specific session is destroyed in the database it will call the destroy_pre and destroy_post hooks. The signature of the function is function destroy( $db, $key, $escapedKey )

When a specific session is regenerated (login/logout) and kept it will call regenerate_pre and regenerate_post hooks. The signature of the function is function regenerate( $db, $escapedNewKey, $escapedOldKey, $escUserID )

When multiple sessions are expired (garbage collector) in the database it will call the gc_pre and gc_post hooks. The signature of the function is function gcollect( $db, $expiredTime )

When all sessions are removed from the database it will call the cleanup_pre and cleanup_post hooks. The signature of the function is function cleanup( $db )

Parameters
$dbThe database object used by the session manager.
$keyThe session key which are being worked on, see also $escapedKey
$escapedKeyThe same key as $key but is escaped correctly for the database. Use this to save a call to eZDBInterface::escapeString()
$expirationTimeAn integer specifying the timestamp of when the session will expire.
$expiredTimeSimilar to $expirationTime but is the time used to figure if a session is expired in the database. ie. all sessions with lower expiration times will be removed.

Portions are modifications of patches by Andreas B??ckler and Francis Nart

Version
2013.9

The system is checked to see whether a virtualhost-less setup is used and sets the appropriate variables which can be fetched with siteDir(), wwwDir() and indexFile(). It also detects file and environment separators, fetch them with fileSeparator() and envSeparator().

// Run the init in the index file eZSys::init( 'index.php', $ini->variable( 'SiteAccessSettings', 'ForceVirtualHost' ) === 'true' ); echo eZSys::indexFile(); echo eZSys::wwwDir();