Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234567]
| ▼Nwcmf | |
| ▼Napplication | |
| ►Ncontroller | Application controllers |
| CAdminController | AdminController is used to perform admin tasks |
| CAssociateController | AssociateController is used to (dis-)associates Node instances, e.g |
| CBatchController | BatchController is used to process complex, longer running actions, that need to be divided into several requests to overcome resource limits and provide progress information to the user |
| CBatchDisplayController | BatchDisplayController is used to load a tree of Node instances recursivly and return them in lists of a given size |
| CConcurrencyController | ConcurrencyController is used to lock/unlock objects |
| CCopyController | CopyController is used to copy or move Node instances |
| CCSVExportController | CSVExportController exports instances of one type into a CSV file |
| CCSVImportController | CSVImportController imports instances of one type into the storage |
| CDeleteController | DeleteController is used to delete Node instances |
| CDisplayController | DisplayController is used to read a Node instance |
| CFailureController | FailureController is used to signal a failure to the user |
| CHistoryController | HistoryController returns a list of last changed entity instances |
| CListController | ListController is used to load Node lists |
| CLoggingController | LoggingController is used to log a message in the backend log |
| CLoginController | LoginController handles the login process |
| CMediaController | MediaController integrates elFinder (https://github.com/Studio-42/elFinder) into wCMF |
| CMessageController | MessageController is used to get all messages translated to the given language |
| CMultipleActionController | MultipleActionController executes multiple actions by passing them to the appropriate controllers and returning all results at once |
| CPermissionController | PermissionController checks, gets and sets permissions |
| CRESTController | RESTController handles requests sent from a dstore/Rest client |
| CSaveController | SaveController is a controller that saves Node data |
| CSearchController | SearchController executes a search and returns matching objects in a paged list |
| CSearchIndexController | SearchIndexController creates a Lucene index from the complete datastore |
| CSOAPController | SOAPController handles SOAP requests |
| CSortController | SortController is used to change the order of nodes |
| CTreeController | TreeController is used to visualize nodes in a tree view |
| CUserController | UserController is used to change the current user's password |
| CValueListController | ValueListController is used to resolve lists for input_type definitions |
| CXMLExportController | XMLExportController exports the content tree into an XML file |
| ▼Nlib | |
| ►Nconfig | Configuration related interfaces and classes |
| ►Nimpl | |
| CConfigActionKeyProvider | ConfigActionKeyProvider searches for action keys in the application configuration |
| CInifileConfiguration | InifileConfiguration reads the application configuration from ini files |
| CPersistenceActionKeyProvider | PersistenceActionKeyProvider searches for action keys in the application storage |
| CActionKey | An action key is a combination of a resource, context and action that is represented as a string |
| CActionKeyProvider | Implementations of ActionKeyProvider search for action keys |
| CConfigChangeEvent | ConfigChangeEvent signals a change of the application configuration |
| CConfiguration | Implementations of Configuration give access to the application configuration |
| CConfigurationException | ConfigurationException signals an exception in the configuration |
| CWritableConfiguration | Implementations of WritableConfiguration allow to change the whole or parts of the configuration and persist the changes |
| ►Ncore | Core classes |
| ►Nimpl | |
| CAbstractLogger | AbstractLogger is the abstract base class for Logger implementations |
| CAuthTokenSession | AuthTokenSession is a DefaultSession, but additionally requires clients to send a token in the X-Auth-Token request header (Double Submit Cookie) |
| CClientSideSession | ClientSideSession has no server state as it stores the data in cookies |
| CDefaultEventManager | DefaultEventManager is a simple EventManager implementation |
| CDefaultFactory | DefaultFactory is used to create service instances |
| CDefaultSession | DefaultSession uses the default PHP session implementation: |
| CLog4phpLogger | Log4phpLogger is a wrapper for the log4php library |
| CMonologFileLogger | MonologFileLogger is a wrapper for the Monolog library that logs to files |
| CClassLoader | ClassLoader tries to load missing class definitions |
| CErrorHandler | ErrorHandler catches all php errors and transforms fatal errors into ErrorExceptions and non-fatal into log messages |
| CEvent | Event is the base class for all events |
| CEventManager | EventManager is responsible for dispatching events to registered listeners |
| CFactory | Interface for Factory implementations |
| CIllegalArgumentException | IllegalArgumentException signals an exception in method arguments |
| CLogger | Interface for logger implementations |
| CLogManager | LogManager is used to retrieve Logger instances |
| CObjectFactory | ObjectFactory implements the service locator pattern by wrapping a Factory instance and providing static access to it |
| CSession | Session is the interface for session implementations and defines access to session variables |
| CTokenBasedSession | A session that requires clients to send a token for authentication |
| ►Ni18n | I18N related interfaces and classes |
| ►Nimpl | |
| CDefaultLocalization | DefaultLocalization is a Localization implementation that saves translations in the store |
| CFileMessage | FileMessage retrieves localized messages from files, that are stored in the localization directory |
| CLocalization | Localization defines the interface for storing localized entity instances and retrieving them back |
| CMessage | Message is used to get localized messages to be used in the user interface |
| ►Nio | Input/Output related interfaces and classes |
| ►Nimpl | |
| CFileCache | FileCache provides simple caching functionality |
| CNullCache | NullCache acts as no cache |
| CCache | Cache defines the interface for cache implementations |
| CFileUtil | FileUtil provides basic support for file functionality like HTTP file upload |
| CImageUtil | ImageUtil provides support for image handling |
| CIOException | IOException signals an exception in i/o operations |
| ►Nmodel | Node related interfaces and classes |
| ►Nimpl | |
| CAbstractNodeSerializer | NodeSerializerBase is a base class for NodeSerialize implementations |
| CDionysosNodeSerializer | DionysosNodeSerializer is used to serialize Nodes into the Dionysos format and vice versa |
| CDojoNodeSerializer | DojoNodeSerializer is used to serialize Nodes into the Dojo rest format and vice versa |
| CSoapNodeSerializer | SoapNodeSerializer is used to serialize Nodes into the soap format and vice versa |
| ►Nmapper | |
| ►Nimpl | WCMF - wemove Content Management Framework Copyright (C) 2005-2020 wemove digital solutions GmbH |
| CAbstractRDBMapper | AbstractRDBMapper maps objects of one type to a relational database schema |
| CNodeUnifiedRDBMapper | NodeUnifiedRDBMapper maps Node objects to a relational database schema where each Node type has its own table |
| CRDBAttributeDescription | Instances of RDBAttributeDescription describe attributes of PersistentObjects in a relational database |
| CRDBManyToManyRelationDescription | Instances of RDBManyToManyRelationDescription describe a many to many relation from 'this' end to 'other' end in a relational database |
| CRDBManyToOneRelationDescription | Instances of RDBManyToOneRelationDescription describe a many to one relation from 'this' end (many) to 'other' end (one) in a relational database |
| CRDBMapper | RDBMapper defines the interface for mapper classes that map to relational databases |
| CRDBOneToManyRelationDescription | Instances of RDBOneToManyRelationDescription describe a one to many relation from 'this' end (one) to 'other' end (many) in a relational database |
| CSelectStatement | Select statement |
| CSQLConst | Constant expression used in sql statements |
| ►Noutput | |
| CDotOutputStrategy | DotOutputStrategy outputs an object's content in a dot file |
| CElementImageOutputStrategy | ElementImageOutputStrategy outputs a tree of objects into an image file |
| CImageOutputStrategy | ImageOutputStrategy outputs a tree of objects into an image file |
| CPosition | Stores a coordinate tuple for use with the LayoutVisitor |
| ►Nvisitor | |
| CLayoutVisitor | LayoutVisitor is used to position a tree of objects on a plane (the objects must implement the getParent()) |
| COutputVisitor | OutputVisitor is used to output an object's content to different destinations and formats |
| CVisitor | Visitor is used to extend an object's functionality by not extending its interface |
| CAbstractQuery | AbstractQuery is the base class for all query classes |
| CNode | Node adds the concept of relations to PersistentObject |
| CNodeComparator | NodeComparator exists for compatibility reasons only |
| CNodeIterator | NodeIterator is used to iterate over a tree/list built of Nodes using a Depth-First-Algorithm |
| CNodeSerializer | NodeSerializer implementations are used to serialize Nodes into an array representation or deserialize an array representation into Nodes |
| CNodeSortkeyComparator | NodeSortkeyComparator is used to compare nodes by their sortkey in relation to a given node |
| CNodeUtil | NodeUtil provides services for the Node class |
| CNodeValueIterator | NodeValueIterator is used to iterate over all persistent values of a Node (not including relations) |
| CNullNode | NullNode is an implementation of the NullObject pattern, It inherits all functionality from Node (acts like a Node) and is only distinguishable from a Node instance by it's class or oid |
| CObjectQuery | ObjectQuery implements a template based object query |
| CObjectQueryUnionQueryProvider | ObjectQueryUnionQueryProvider provides queries as ObjectQuery instances |
| CPersistentIterator | PersistentIterator is used to iterate over a tree/list built of persistent objects using a Depth-First-Algorithm |
| CStringQuery | StringQuery executes queries from a string representation |
| ►Npdf | PDF related interfaces and classes |
| CPDF | PDF extends FPDF/FPDI |
| CPDFPage | PDFPage instances define the content of a pdf page by using a set of FPDF/FPDI commands inside the PDFPage::render method |
| CPDFTemplate | PDFTemplate is used to output pdf files based on a given pdf template |
| ►Npersistence | Persistence layer related interfaces and classes |
| ►Nconcurrency | |
| ►Nimpl | |
| CDefaultConcurrencyManager | Default ConcurrencyManager implementation |
| CDefaultLockHandler | DefaultLockHandler implements the LockHandler interface for relational databases |
| CNullLockHandler | NullLockHandler acts as if no LockHandler was installed |
| CConcurrencyManager | ConcurrencyManager is used to handle concurrency for objects |
| CLock | Lock represents a lock on an object |
| CLockHandler | LockHandler defines the interface for LockHandler implementations |
| COptimisticLockException | OptimisticLockException signals an exception when trying to create an optimistic lock |
| CPersistentLock | PersistentLock defines the interface for locks that may be persisted (e.g |
| CPessimisticLockException | PessimisticLockException signals an exception when trying to create an pessimistic lock |
| ►Nimpl | |
| CAbstractMapper | AbstractMapper provides a basic implementation for other mapper classes |
| CDefaultPersistenceFacade | Default PersistenceFacade implementation |
| CDefaultPersistentObject | DefaultPersistentObject is the base class of all persistent objects |
| CDefaultTransaction | Default implementation of Transaction |
| CDefaultUnionQueryProvider | DefaultUnionQueryProvider provides queries for multiple types using the PersistentFacade::loadObjects() method |
| CNullMapper | NullMapper acts as there is no mapper |
| CRemoteCapablePersistenceFacade | RemoteCapablePersistenceFacade delegates local persistence operations to the default PersistenceFacadeImpl and remote operations to a remote server |
| ►Noutput | |
| ►Nimpl | |
| CAuditingOutputStrategy | AuditingOutputStrategy outputs object changes to the logger category AuditingOutputStrategy, loglevel info |
| CDefaultOutputStrategy | DefaultOutputStrategy outputs an object's content to the Log category DefaultOutputStrategy |
| COutputStrategy | OutputStrategy defines the interface for classes that write an object's content to a destination (called 'document') using a special format |
| CAttributeDescription | Instances of AttributeDescription describe attributes of PersistentObjects |
| CBuildDepth | BuildDepth values are used to define the depth when loading object trees |
| CCriteria | Criteria defines a condition on a PersistentObject's attribute used to select specific instances |
| CDeleteOperation | DeleteOperation holds data necessary to accomplish an delete operation on the persistent store |
| CInsertOperation | InsertOperation holds data necessary to accomplish an insert operation on the persistent store |
| CObjectComparator | ObjectComparator is used to compare persistent objects by given criterias |
| CObjectId | ObjectId is the unique identifier of an object |
| CPagingInfo | PagingInfo contains information about a paged list |
| CPathDescription | PathDescription describes a path between two types |
| CPersistenceAction | PersistenceAction values are used to define actions on PersistentObject instances |
| CPersistenceEvent | PersistentEvent signals create/update/delete operations on a persistent entity |
| CPersistenceException | PersistenceException signals an exception in the persistence service |
| CPersistenceFacade | PersistenceFacade defines the interface for PersistenceFacade implementations |
| CPersistenceMapper | PersistenceMapper defines the interface for all mapper classes |
| CPersistenceOperation | A PersistenceOperation instance holds data necessary to accomplish an operation on the persistent store |
| CPersistentObject | PersistentObject defines the interface of all persistent objects |
| CPersistentObjectProxy | PersistentObjectProxy is proxy for an PersistentObject instance |
| CPropertyChangeEvent | PropertyChangeEvent signals a change of a property of a PersistentObject instance |
| CReferenceDescription | Instances of ReferenceDescription describe reference attributes of PersistentObjects |
| CRelationDescription | Instances of RelationDescription describe relations between different types of PersistentObjects |
| CStateChangeEvent | StateChangeEvent signals a change of the state of a PersistentObject instance |
| CTransaction | Transaction implements the Unit of Work pattern as it defines the interface for maintaining a list of PersistentObject changes inside a business transaction and commit/rollback them |
| CTransactionEvent | TransactionEvent instances are fired at different phases of a transaction |
| CTransientAttributeDescription | Instances of TransientAttributeDescription describe transient attributes of PersistentObjects |
| CUnionQuery | UnionQuery combines multiple query results to allow for sorting and paginating over different queries |
| CUnionQueryProvider | UnionQueryProvider is used to provide queries to a union query |
| CUnknownFieldException | UnknownFieldException signals an unknown field |
| CUpdateOperation | UpdateOperation instances hold data necessary to accomplish an update operation on the persistent store |
| CValueChangeEvent | ValueChangeEvent signals a change of a value of a PersistentObject instance |
| ►Npresentation | Presentation related interfaces and classes |
| ►Ncontrol | |
| ►Nlists | |
| ►Nimpl | |
| CConfigListStrategy | ConfigListStrategy implements a list of key/value pairs that is retrieved from a configuration section |
| CFileListStrategy | FileListStrategy implements a list of key value pairs that is retrieved from an configuration section |
| CFixedListStrategy | FixedListStrategy implements a constant list of key/value pairs |
| CFunctionListStrategy | FunctionListStrategy implements a list of key/value pairs that is retrieved by a global function |
| CNodeListStrategy | NodeListStrategy implements a list of entities that is retrieved from the store, where the keys are the object ids and the values are the display values |
| CListStrategy | ListStrategy defines the interface for classes that retrieve value lists |
| CValueListProvider | ValueListProvider provides lists of key/values to be used with list input controls |
| ►Nformat | |
| ►Nimpl | |
| CAbstractFormat | AbstractFormat is used as base class for specialized formats |
| CDefaultFormatter | Default Formatter implementation |
| CDownloadFormat | DownloadFormat is used for downloads |
| CGenericFormat | GenericFormat is used to output arbitrary responses |
| CHierarchicalFormat | HierarchicalFormat is used as base class for formats that are able to represent hierarchical data like JSON or XML |
| CHtmlFormat | HtmlFormat implements the HTML request/response format |
| CJsonFormat | JsonFormat implements the JSON request/response format |
| CNullFormat | NullFormat transfers the original request and response objects without modifying or transforming them |
| CSoapFormat | SoapFormat implements the SOAP request/response format |
| CFormat | Format defines the interface for all format classes |
| CFormatter | Formatter is the single entry point for request/response formatting |
| ►Nimpl | |
| CAbstractContentModule | AbstractContentModule is the base class for content module implementations |
| CAbstractControllerMessage | AbstractControllerMessage is the base class for request/response implementations |
| CAbstractDocument | AbstractFormat is used as base class for specialized documents |
| CDefaultActionMapper | Default ActionMapper implementation |
| CDefaultRequest | Default Request implementation |
| CDefaultRequestListener | DefaultRequestListener normalizes various search, sort and paging parameters into those understood by wcmf controllers |
| CDefaultResponse | Default Response implementation |
| CFileDocument | FileDocument represents a local file |
| CMemoryDocument | MemoryDocument represents content that resides in memory |
| CRemoteDocument | RemoteDocument represents a remote file retrieved via cURL |
| ►Nlink | WCMF - wemove Content Management Framework Copyright (C) 2005-2020 wemove digital solutions GmbH |
| CInternalLink | InternalLink contains static methods for handling internal application links |
| CLinkProcessor | LinkProcessor is used to process links in Node instances |
| CLinkProcessorStrategy | LinkProcessorStrategy defines the interface for strategies used by LinkProcessor |
| ►Nview | |
| ►Nimpl | |
| CNullView | NullView is a stub class that implements all view methods |
| CSmartyView | View is used by Controller to handle the view presentation in MVC pattern |
| CView | View defines the interface for all view implementations |
| CActionMapper | ActionMapper implementations are responsible for instantiating and executing Controllers based on the referring Controller and the given action |
| CApplication | Application is the main application class, that does all the initialization |
| CApplicationError | ApplicationError is used to signal errors that occur while processing a request |
| CApplicationEvent | ApplicationEvent instances are fired at different stages of the program flow |
| CApplicationException | ApplicationException signals a general application exception |
| CContentModule | Interface for smarty content modules |
| CController | Controller is the base class of all controllers |
| CControllerMessage | Messages are sent between Controllers and are used to transfer data between them |
| CRequest | Request holds the request values that are used as input to Controller instances |
| CResponse | Response holds the response values that are used as output from Controller instances |
| CResponseDocument | ResponseDocument is the interface for media returned in a response when using the DownloadFormat |
| ►Nsearch | Search related interfaces and classes |
| ►Nimpl | |
| CDefaultIndexStrategy | DefaultIndexStrategy implements indexing of PersistentObject values and might be customized by overriding the isIncluded and/or enhanceDocument methods |
| CIndexStrategy | IndexStrategy defines the interface for indexing implementations |
| CLuceneSearch | LuceneSearch provides access to the search based on ZendSearch/Lucene |
| CLuceneUtf8Analyzer | |
| CIndexedSearch | IndexedSearch implementations are used to search entity objects in a search index |
| CSearch | Search implementations are used to search entity objects |
| ►Nsecurity | Security related interfaces and classes |
| ►Nimpl | |
| CAbstractPermissionManager | AbstractPermissionManager is the base class for concrete PermissionManager implementations |
| CChainedPermissionManager | ChainedPermissionManager retrieves authorization rules included managers |
| CDefaultAuthenticationManager | DefaultAuthenticationManager uses PrincipalFactory to get a User instance that matches the given login/password combination |
| CDefaultPermissionManager | DefaultPermissionManager retrieves authorization rules the storage |
| CNullPermissionManager | NullPermissionManager acts like an absent PermissionManager |
| CStaticPermissionManager | StaticPermissionManager retrieves authorization rules from the application configuration |
| ►Nprincipal | |
| ►Nimpl | |
| CAbstractRole | Default implementation of a role |
| CAbstractUser | Default implementation of a user that is persistent |
| CAnonymousUser | Anonymous user |
| CCreatorRole | CreatorRole matches if the user created an entity |
| CDefaultPrincipalFactory | Default implementation of PrincipalFactory |
| COtherSuperUserRole | OtherSuperUserRole matches if the user has the super user attribute and the resource is a user instance with a different login than the user |
| CSuperUserRole | SuperUserRole matches if the user has the super user attribute |
| CDynamicRole | DynamicRole is the interface for user roles based on attributes |
| CPasswordService | Services for password handling |
| CPrincipalFactory | PrincipalFactory implementations are used to retrieve User and Role instances |
| CRole | Role is the interface for user roles |
| CUser | User is the interface for users |
| CAuthenticationManager | AuthenticationManager implementations are used to handle all authentication requests |
| CAuthorizationException | AuthorizationException signals an exception in authorization |
| CPermissionManager | PermissionManager implementations are used to handle all authorization requests |
| ►Nservice | Service related interfaces and classes |
| CSoapClient | SoapClient is used to communicate with wCMF soap services |
| CSoapServer | SoapServer extends nusoap server to actually process requests inside the application context |
| ►Nutil | Utility classes |
| CDBUtil | DBUtil provides database helper functions |
| CDOMUtils | DomUtils |
| CI18nUtil | I18nUtil provides support i18n functionality |
| CStringUtil | StringUtil provides support for string manipulation |
| CTestUtil | TestUtil provides helper methods for testing wCMF functionality |
| CURIUtil | URIUtil provides support for uri manipulation |
| ►Nvalidation | |
| ►Nimpl | |
| CDate | Date validates against the specified date format |
| CFilter | Filter validates against the given php filter |
| CImage | Image validates an image value |
| CRegExp | RegExp validates against the given regular expression |
| CRequired | Required checks if the value is not empty |
| CUnique | Unique checks if the value is unique regarding the given entity attribute |
| CValidateType | ValidateType defines the interface for all validator classes |
| CValidationException | ValidationException signals an exception in validation |
| CValidator | Validator is is the single entry point for validation |
| ▼Ntest | |
| ►Nlib | Test support classes |
| CArrayDataSet | |
| CBaseTestCase | BaseTestCase is the base class for all wCMF test cases |
| CControllerTestCase | ControllerTestCase is the base class for test cases used for Controllers |
| CDatabaseTestCase | DatabaseTestCase is the base class for test cases that need database support |
| CSeleniumTestCase | SeleniumTestCase is the base class for test cases that run with Selenium |
| ►Ntests |