Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

Patterns in kernel/private

Every class, view, fetch function, operator and plugin point of kernel/private with its design patterns.

Download as PDF

Address: https://doc.exponential.earth/learninminutes/exphelp/viewer/standards/patterns/area-kernel-private.md

On this page

Patterns in kernel/private

Note

This page is generated from the source code by php bin/php/exppatterncatalogue.php --write. Do not edit it by hand: change the code or the generator, then run the command again. How the patterns are recognized: the pattern catalogue.

Every class, interface and trait of kernel/private with the patterns it was recognized as, followed by the module views, policy functions, fetch functions, template operators, cronjobs, event hooks and INI plugin points of the area. All patterns.

Classes (181)

ClassKindPatternsFileDescription
expApiKeyAuthFilterclass extends ezcAuthenticationFilterDecorator / filterkernel/private/rest/classes/auth/apikey_auth_filter.php:19Authentication filter for a personal API key (expApiKey) presented as "Authorization: Bearer expk_..." (doc/eng-us/guides/api-keys.md, "How the REST…
expApiKeyRestclassUtility (static helper)kernel/private/rest/classes/auth/apikey_rest.php:24How the REST layer resolves a personal API key (doc/eng-us/guides/api-keys.md, "For developers").
expContentAccessReportclassUtility (static helper)kernel/private/classes/expcontentaccessreport.php:23Answers "may this user do this with this object or node, and if not, which limitation refuses it": the access checks of the kernel made for another u…
expContentSecurityPolicyclassUtility (static helper)kernel/private/classes/expcontentsecuritypolicy.php:39The Content Security Policy of a page, from site.ini [ContentSecurityPolicy].
expContentSecurityPolicyReportclass–kernel/private/classes/expcontentsecuritypolicyreport.php:40The reports of the Content Security Policy (doc/eng-us/features/6.0/content-security-policy.md, "Reports"): what the view csp/report receives from th…
expFileConsistencyReportclassFactory and static factory methodskernel/private/classes/expfileconsistencyreport.php:36Compares the files of an installation with the checksum lists that ship with it: share/filelist.md5 of Exponential and the share/filelist.md5 an exte…
expOAuthAuthorizePolicyclassUtility (static helper)kernel/private/rest/classes/oauth/authorize_policy.php:21Decides whether a signed in user may authorize an OAuth client in oauth/authorize.
expOAuthAuthorizePolicyGrantclassUtility (static helper)kernel/private/rest/classes/oauth/authorize_policy_grant.php:26Plans and applies the upgrade grant of the policy oauth/authorize (bin/php/addoauthauthorizepolicy.php).
expOAuthPkceclassUtility (static helper)kernel/private/rest/classes/oauth/pkce.php:24Proof Key for Code Exchange (PKCE, RFC 7636) for the OAuth authorization code flow.
expRestContentPermissionclassFactory and static factory methods, Utility (static helper)kernel/private/rest/classes/auth/content_permission.php:36The current user's rights on the content a REST call reads or writes, checked the way the content module checks them (doc/eng-us/guides/api-keys.md,…
expRestCorsclassFactory and static factory methodskernel/private/rest/classes/cors.php:29Cross-origin resource sharing (CORS) for the REST interface (index_rest.php: the content API, the OAuth token end point and every other route of a RE…
expRestPasswordAuthFilterclass extends ezcAuthenticationFilterDecorator / filterkernel/private/rest/classes/auth/password_auth_filter.php:23Checks a login and password for the REST interface's basic authentication the way the sign-in does.
expRestPasswordChangeRequiredStatusclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/password_change_required.php:15403 Forbidden with the error code password_change_required: the credentials are right, but the account is marked "change password at next sign-in" (e…
expRestRateLimitedStatusclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/rate_limited.php:14429 Too Many Requests with Retry-After, for a personal API key over its rate limit (rest.ini [ApiKeySettings] RateLimitPerMinute).
expRestSecondFactorRequiredStatusclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/second_factor_required.php:16The REST answer to a password that was right for an account that needs a second sign-in step (expSignInSecondFactor): 401 with WWW-Authenticate (an a…
expSchemaConsistencyReportclassFactory and static factory methodskernel/private/classes/expschemaconsistencyreport.php:36Compares the database with the schema that ships with Exponential and its active extensions (share/db_schema.dba of the root and of each extension),…
eZAutoloadGeneratorclassBuilder, Factory and static factory methodskernel/private/classes/ezautoloadgenerator.php:19Utility class for generating autoload arrays for Exponential.
eZClusterFileHandlerInterfaceinterfaceInterface (contract)kernel/private/interfaces/ezclusterfilehandlerinterface.php:15Cluster file handlers interface
eZContentObjectStateclass extends eZPersistentObjectActive Record (eZPersistentObject), INI plugin point (extension point)kernel/private/classes/ezcontentobjectstate.php:18Class representing a content object state
eZContentObjectStateGroupclass extends eZPersistentObjectActive Record (eZPersistentObject), INI plugin point (extension point)kernel/private/classes/ezcontentobjectstategroup.php:18Class respresenting a content object state group
eZContentObjectStateGroupLanguageclass extends eZPersistentObjectActive Record (eZPersistentObject), INI plugin point (extension point)kernel/private/classes/ezcontentobjectstategrouplanguage.php:21This class takes care of the localization of a content object state group.
eZContentObjectStateLanguageclass extends eZPersistentObjectActive Record (eZPersistentObject), INI plugin point (extension point)kernel/private/classes/ezcontentobjectstatelanguage.php:21This class takes care of the localization of a content object state.
ezpActiveExtensionsclassFactory and static factory methodskernel/private/classes/ezpactiveextensions.php:26Changes [ExtensionSettings] ActiveExtensions in settings/override/site.ini.append.php, for Setup › Extensions, without touching anything else in that…
ezpAsynchronousPublisherOutputinterfaceInterface (contract)kernel/private/interfaces/asynchronouspublisheroutput.php:16This interface is used as the basis for the ezpasynchronouspublisher.php daemon
ezpAsynchronousPublishingFilterabstract class implements ezpAsynchronousPublishingFilterInterfaceDecorator / filter, Template Method / abstract base classkernel/private/classes/ezpasynchronouspublishingfilter.php:24This interface is to be used to create accept/reject filters for the Asynchronous Publishing feature Each filter class must implement the accept() me…
ezpAsynchronousPublishingFilterInterfaceinterfaceDecorator / filter, Interface (contract)kernel/private/interfaces/asynchronouspublishingfilter.php:17Base interface for eZ Asynchronous Publishing filter classes
ezpAttributeOperatorFormatterclass–kernel/private/eztemplate/ezpattributeoperatorformatter.php:12–
ezpAttributeOperatorFormatterInterfaceinterfaceInterface (contract)kernel/private/eztemplate/ezpattributeoperatorformatterinterface.php:12–
ezpAttributeOperatorHTMLFormatterclass extends ezpAttributeOperatorFormatter implements ezpAttributeOperatorFormatterInterfaceINI plugin point (extension point)kernel/private/eztemplate/ezpattributeoperatorhtmlformatter.php:12–
ezpAttributeOperatorManagerclassFacade / service, Factory and static factory methods, Utility (static helper)kernel/private/eztemplate/ezpattributeoperatormanager.php:12–
ezpAttributeOperatorTextFormatterclass extends ezpAttributeOperatorFormatter implements ezpAttributeOperatorFormatterInterfaceINI plugin point (extension point)kernel/private/eztemplate/ezpattributeoperatortextformatter.php:12–
ezpAutoloadCliOutputclass implements ezpAutoloadOutput–kernel/private/classes/ezpautoloadclioutput.php:17Utility class for providing CLI output and incremental progress information.
ezpAutoloadFileFindContextclass extends ezcBaseStructValue object / structkernel/private/structs/ezpautoloadfilefindcontext.php:17Struct which defines the information collected by the file walker for locating files.
ezpAutoloadGeneratorOptionsclass extends ezcBaseOptions–kernel/private/options/ezpautoloadgeneratoroptions.php:55Class containing options for eZAutoloadGenerator
ezpAutoloadOutputinterfaceInterface (contract)kernel/private/interfaces/ezpautoloadoutput.php:17Interface for classes providing output for autoload generation.
ezpCacheClusterExceptionclass extends ezcCacheExceptionException hierarchykernel/private/rest/classes/cache/exceptions/cluster.php:15Generic exception class for ezpCacheCluster
ezpCacheStorageClusterOptionsclass extends ezcBaseOptions–kernel/private/rest/classes/cache/options/storage_cluster.php:15Option class for the ezpCacheStorageCluster class.
ezpContentclassFactory and static factory methodskernel/private/api/content/content.php:56Class that represents a content item.
ezpContentAccessDeniedExceptionclass extends ezpContentExceptionException hierarchykernel/private/api/content/exceptions/access_denied.php:12–
ezpContentClassCriteriaclass implements ezpContentCriteriaInterface–kernel/private/api/content/criteria/class.php:16This class allows for configuration of a content class based criteria
ezpContentCriteriaclass–kernel/private/api/content/criteria.php:28This class is used to instantiate and manipulate content listing criterias.
ezpContentCriteriaInterfaceinterfaceInterface (contract)kernel/private/api/interfaces/content_criteria.php:16This interface is the base one when it comes to implementing content query criteria
ezpContentCriteriaSetclass implements ArrayAccess, Countable, IteratorIteratorkernel/private/api/content/criteria_set.php:16This class handles a list of content query criteria
ezpContentDepthCriteriaclass implements ezpContentCriteriaInterface–kernel/private/api/content/criteria/depth.php:16Depth criteria
ezpContentExceptionabstract class extends ezcBaseExceptionException hierarchy, Template Method / abstract base classkernel/private/api/content/exceptions/content_exception.php:17This is the base exception for the Exponential content API
ezpContentFieldclassFactory and static factory methodskernel/private/api/content/field.php:17This class handles content fields.
ezpContentFieldCriteriaclass implements ezpContentCriteriaInterface–kernel/private/api/content/criteria/field.php:17This class is used to instantiate and manipulate a field value content criteria.
ezpContentFieldNotFoundExceptionclass extends ezpContentExceptionException hierarchykernel/private/api/content/exceptions/content_field_not_found.php:11–
ezpContentFieldSetclass implements ArrayAccess, IteratorFactory and static factory methods, Iteratorkernel/private/api/content/field_set.php:18Allows for reading/writing of content fields (attributes) through an array like interface.
ezpContentLimitationclassUtility (static helper)kernel/private/classes/ezpcontentlimitation.php:26Asks the handler an extension registered for a content policy limitation the kernel does not know (site.ini [RoleSettings] LimitationHandlers[]=, see…
ezpContentLimitationHandlerinterfaceInterface (contract), Strategy / handlerkernel/private/interfaces/ezpcontentlimitationhandler.php:29Evaluates a policy limitation of the content module that the kernel does not know itself.
ezpContentLimitationSolrHandlerinterface extends ezpContentLimitationHandlerInterface (contract), Strategy / handlerkernel/private/interfaces/ezpcontentlimitationsolrhandler.php:23A content limitation handler that can also restrict a search in a search engine that filters by the policies of the user itself, such as eZ Find with…
ezpContentLimitCriteriaclass implements ezpContentCriteriaInterface–kernel/private/api/content/criteria/limit.php:16This class allows for configuration of an offset/limit based criteria
ezpContentListclass implements Countable, IteratorIteratorkernel/private/api/content/list.php:18This class lets you browse a previously fetched content list, for instance using ezpContentRepository::query() It is more or less a ResultSet from a…
ezpContentLocationclass extends ezpLocationFactory and static factory methodskernel/private/api/content/location.php:21This class is used to manipulate a specific content location.
ezpContentLocationCriteriaclass implements ezpContentCriteriaInterface–kernel/private/api/content/criteria/location.php:16This class allows for configuration of a location based criteria
ezpContentLocationSetclass–kernel/private/api/content/location_set.php:15This class represents the locations for a piece of content
ezpContentNotFoundExceptionclass extends ezpContentExceptionException hierarchykernel/private/api/content/exceptions/content_not_found.php:12–
ezpContentPublishingProcessclass extends eZPersistentObjectActive Record (eZPersistentObject), Factory and static factory methodskernel/private/classes/ezpcontentpublishingprocess.php:18This class provides a PersistentObject interface to a publishing queue process.
ezpContentPublishingQueueclass implements ezpContentPublishingQueueReaderInterfaceINI plugin point (extension point), Utility (static helper)kernel/private/classes/ezpcontentpublishingqueue.php:19This class manages the content publishing queue.
ezpContentPublishingQueueProcessorclassSingleton / instance()kernel/private/classes/ezpcontentpublishingqueueprocessor.php:21This class manages the publishing queue through ezpContentPublishingProcess persistent objects
ezpContentPublishingQueueReaderInterfaceinterfaceInterface (contract)kernel/private/interfaces/ezpcontentpublishingqueuereader.php:18This interface describes an asynchronous publishing queue reader Queue readers are meant to provide the asynchronous publishing system with the next…
ezpContentRepositoryclassUtility (static helper)kernel/private/api/content/repository.php:16This class handles querying of content repository
ezpContentSortingCriteriaclass implements ezpContentCriteriaInterface–kernel/private/api/content/criteria/sorting.php:16Sorting criteria
ezpContentXHTMLRendererclass extends ezpRestContentRendererInterfaceINI plugin point (extension point)kernel/private/rest/classes/renderers/xhtml_content_renderer.php:12–
ezpDatabaseBasedClusterFileHandlerinterfaceInterface (contract), Strategy / handlerkernel/private/interfaces/ezpdatabasebasedclusterfilehandler.php:20This interface describes a database based cluster file handler
ezpEventclassObserver / listener / event, Singleton / instance()kernel/private/classes/ezpevent.php:20This class handles internal kernel events in Exponential, aka hooks.
ezpExtensionclassSingleton / instance()kernel/private/classes/ezpextension.php:15Object representing an Exponential extension
ezpExtensionOptionsclass extends ezcBaseOptions–kernel/private/options/ezpextensionoptions.php:58Class containing options for eZExtension, this option system is only used by eZExtension::getHandlerClass so far.
ezpFormTokenRefusalclassUtility (static helper)kernel/private/classes/ezpformtokenrefusal.php:27Turns an ezpFormTokenException -- a POST whose form token was missing or wrong -- into a refusal: HTTP 403, Cache-Control: no-store, the security hea…
ezpHttpResponseCodesclass–kernel/private/rest/classes/http_response_codes.php:12–
ezpKernelclass implements ezpWebBasedKernelHandlerFront Controller, Singleton / instance(), Strategy / handlerkernel/private/classes/ezpkernel.php:16Base Exponential kernel class.
ezpKernelHandlerinterfaceFront Controller, Interface (contract), Strategy / handlerkernel/private/interfaces/ezpkernelhandler.php:14Interface for kernel handlers
ezpKernelRedirectclass extends ezpKernelResult–kernel/private/classes/ezpkernelredirect.php:14Struct containing information on HTTP redirection.
ezpKernelRestclass implements ezpKernelHandlerFront Controller, Strategy / handlerkernel/private/rest/classes/ezpkernelrest.php:11–
ezpKernelResultclass–kernel/private/classes/ezpkernelresult.php:14Struct containing the kernel result.
ezpKernelTreeMenuclass implements ezpKernelHandlerFront Controller, Strategy / handlerkernel/private/classes/ezpkerneltreemenu.php:11–
ezpKernelWebclass implements ezpWebBasedKernelHandlerFront Controller, Strategy / handlerkernel/private/classes/ezpkernelweb.php:16Provides a kernel handler in web context
ezpLanguageSwitcherclass implements ezpLanguageSwitcherCapableINI plugin point (extension point)kernel/private/classes/ezplanguageswitcher.php:18Utility class for transforming URLs between siteaccesses.
ezpLanguageSwitcherCapableinterfaceInterface (contract)kernel/private/interfaces/ezplanguageswitchercapable.php:17Interface for classes providing language switcher functionality.
ezpLanguageSwitcherFunctionCollectionclassFetch function (Query Object, Facade)kernel/private/modules/switchlanguage/ezpLanguageSwitcherFunctionCollection.php:14–
ezpLanguageSwitcherOperatorclassTemplate operator (Interpreter plugin)kernel/private/eztemplate/ezplanguageswitcheroperator.php:12–
ezpLocationclass–kernel/private/api/location.php:16This class is used to manipulate locations
ezpMailclass extends ezcMail–kernel/private/classes/ezpmail.php:14ezpMail extends ezcMail in order to override default values and limitations.
ezpMobileDeviceDetectclass–kernel/private/classes/ezpmobiledevicedetect.php:15ezpMobileDeviceDetect class implementation
ezpMobileDeviceDetectFilterclassDecorator / filterkernel/private/classes/ezpmobiledevicedetectfilter.php:12–
ezpMobileDeviceDetectFilterInterfaceinterfaceDecorator / filter, Interface (contract)kernel/private/classes/ezpmobiledevicedetectfilterinterface.php:12–
ezpMobileDeviceRegexpFilterclass implements ezpMobileDeviceDetectFilterInterfaceDecorator / filter, INI plugin point (extension point)kernel/private/classes/ezpmobiledeviceregexpfilter.php:15Default implementation of mobile device detect interface.
ezpMultivariateTestclass–kernel/private/classes/ezpmultivariatetest.php:12–
ezpMultivariateTestHandlerclass implements ezpMultivariateTestHandlerInterfaceINI plugin point (extension point), Strategy / handlerkernel/private/classes/ezpmultivariatetesthandler.php:12–
ezpMultivariateTestHandlerInterfaceinterfaceInterface (contract)kernel/private/classes/ezpmultivariatetesthandlerinterface.php:12–
ezpMvcConfigurableDispatcherclass extends ezcMvcConfigurableDispatcher–kernel/private/rest/classes/dispatcher.php:12–
ezpMvcConfigurationclass implements ezcMvcDispatcherConfiguration–kernel/private/rest/classes/mvc_configuration.php:11–
ezpMvcRailsRouteclass extends ezcMvcRailsRoute–kernel/private/rest/classes/routes/rails.php:11–
ezpMvcRegexpRouteclass extends ezcMvcRegexpRouteFront Controllerkernel/private/rest/classes/routes/regexp.php:16Override of ezcMvcRegexpRoute.
ezpNativeUserAuthFilterclass extends ezcAuthenticationFilterDecorator / filterkernel/private/rest/classes/auth/native_user_authfilter.php:11–
ezpOauthBadRequestExceptionabstract class extends ezpOauthExceptionException hierarchy, Template Method / abstract base classkernel/private/rest/classes/exceptions/bad_request.php:17This is the base exception for triggering BAD REQUEST response.
ezpOauthErrorTypeclass–kernel/private/rest/classes/outh_error_type.php:12–
ezpOauthExceptionabstract class extends ezcBaseExceptionException hierarchy, Template Method / abstract base classkernel/private/rest/classes/exceptions/oauth.php:17This is the base exception for the Exponential oauth library.
ezpOauthExpiredTokenExceptionclass extends ezpOauthRequiredExceptionException hierarchykernel/private/rest/classes/exceptions/expired_token.php:18This exception is thrown when the accept token has expired, but can be renewed.
ezpOauthFilterclass extends ezcAuthenticationFilterDecorator / filterkernel/private/rest/classes/oauth/oauth_filter.php:12–
ezpOauthInsufficientScopeExceptionclass extends ezpOauthRequiredExceptionException hierarchykernel/private/rest/classes/exceptions/insufficient_scope.php:18This exception is thrown when a request is made with a token not repsresenting sufficient scope for the request to be accepted.
ezpOauthInvalidRequestExceptionclass extends ezpOauthBadRequestExceptionException hierarchykernel/private/rest/classes/exceptions/invalid_request.php:21This exception is thrown when a request is invalid.
ezpOauthInvalidTokenExceptionclass extends ezpOauthRequiredExceptionException hierarchykernel/private/rest/classes/exceptions/invalid_token.php:19This exception is thrown when a token is invalid.
ezpOauthNoAuthInfoExceptionclass extends ezpOauthRequiredExceptionException hierarchykernel/private/rest/classes/exceptions/missing_auth_info.php:18This exception is thrown when the client did not provide any authentication information in the request.
ezpOauthRequiredclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/oauth_required.php:15This result type is used to signal a HTTP basic auth header
ezpOauthRequiredExceptionabstract class extends ezpOauthExceptionException hierarchy, Template Method / abstract base classkernel/private/rest/classes/exceptions/auth.php:17This is the base exception for responsenses need authentication.
ezpOauthTokenEndpointErrorTypeclass–kernel/private/rest/classes/oauth_token_endpoint_error.php:12–
ezpOauthTokenNotFoundExceptionclass extends ezpOauthExceptionException hierarchykernel/private/rest/classes/exceptions/oauth_token_not_found.php:17This is the base exception for the Exponential oauth library.
ezpOauthUtilityclass extends ezpRestModelUtility (static helper)kernel/private/rest/classes/oauth/utility.php:17Functionality for working against the draft 10 of the oauth2 spec.
ezpRestAuthcodeclass implements ezcPersistentObject–kernel/private/rest/classes/models/ezprest_authcode.php:16Data class ezprest_tokens.
ezpRestAuthConfigurationclass–kernel/private/rest/classes/auth/auth_configuration.php:19Class controlling authentication inside REST layer.
ezpRestAuthControllerclass extends ezcMvcController–kernel/private/rest/classes/controllers/auth.php:15Handles authentication with the REST interface.
ezpRestAuthenticationStyleabstract classTemplate Method / abstract base classkernel/private/rest/classes/auth/styles/abstract_auth_style.php:11–
ezpRestAuthenticationStyleInterfaceinterfaceInterface (contract)kernel/private/rest/classes/auth/auth_style.php:12–
ezpRestAuthorizedClientclass–kernel/private/oauth/classes/restauthorizedclient.php:16Persistent object class representing a REST application authorization by a user.
ezpRestAuthProviderclass implements ezpRestProviderInterfaceINI plugin point (extension point), Strategy / handlerkernel/private/rest/classes/auth/auth_provider.php:11–
ezpRestAuthStyleNotFoundExceptionclass extends ezpRestExceptionException hierarchykernel/private/rest/classes/exceptions/auth_style_not_found.php:12–
ezpRestBasicAuthStyleclass extends ezpRestAuthenticationStyle implements ezpRestAuthenticationStyleInterface–kernel/private/rest/classes/auth/styles/basic_auth.php:23HTTP basic authentication against the site's users.
ezpRestCacheStorageApcClusterclass extends ezcCacheStorageApcPlain–kernel/private/rest/classes/cache/apc.php:11–
ezpRestCacheStorageClusterabstract class extends ezpRestCacheStorageFile implements ezcCacheStackableStorage, ezcCacheStackMetaDataStorageTemplate Method / abstract base classkernel/private/rest/classes/cache/cluster.php:11–
ezpRestCacheStorageClusterObjectclass extends ezpRestCacheStorageCluster–kernel/private/rest/classes/cache/object.php:16Cache storage implementation for compatible objects (implementing ezcBaseExportable interface).
ezpRestCacheStorageFileabstract class extends ezcCacheStorageFile–kernel/private/rest/classes/cache/storage.php:11–
ezpRestClientclass–kernel/private/oauth/classes/restclient.php:15Persistent object class representing a REST application.
ezpRestContentRendererclassFactory and static factory methods, Utility (static helper)kernel/private/rest/classes/content_renderer.php:12–
ezpRestContentRendererInterfaceabstract class–kernel/private/rest/classes/interfaces/content_renderer.php:12–
ezpRestContentRendererNotFoundExceptionclass extends ezpRestExceptionException hierarchykernel/private/rest/classes/exceptions/content_renderer_not_found.php:12–
ezpRestDbConfigclass implements ezcBaseConfigurationInitializerRegistry, Utility (static helper)kernel/private/rest/classes/lazy.php:12–
ezpRestDebugclassSingleton / instance()kernel/private/rest/classes/debug/debug.php:11–
ezpRestDebugPHPFormatterclass implements ezcDebugOutputFormatter–kernel/private/rest/classes/debug/formatters/php_formatter.php:11–
ezpRestDefaultRegexpPrefixFilterclass extends ezpRestPrefixFilterInterfaceDecorator / filter, INI plugin point (extension point)kernel/private/rest/classes/default_regexp_prefix_filter.php:15Default implementation of prefix filter interface.
ezpRestErrorControllerclass extends ezcMvcController–kernel/private/rest/classes/controllers/error.php:15This controller deals with error situations arising in the REST layer.
ezpRestExceptionabstract class extends ezcBaseExceptionException hierarchy, Template Method / abstract base classkernel/private/rest/classes/exceptions/rest_exception.php:17This is the base exception for the Exponential REST layer
ezpRestFeedDecoratorclassDecorator / filterkernel/private/rest/classes/views/feed_decorator.php:24This class decorates the feed provided in the REST interface for content sync mechanisms.
ezpRestFilterMissingParameterExceptionclass extends ezpRestExceptionDecorator / filter, Exception hierarchykernel/private/rest/classes/exceptions/filter_param_missing.php:12–
ezpRestFilterNotFoundExceptionclass extends ezpRestExceptionDecorator / filter, Exception hierarchykernel/private/rest/classes/exceptions/filter_not_found.php:12–
ezpRestHttpRequestParserclass extends ezcMvcHttpRequestParser–kernel/private/rest/classes/request/http_parser.php:19Custom request parser which creates instances of ezpRestRequest.
ezpRestHttpResponseclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/http_response.php:12–
ezpRestHttpResponseWriterclass extends ezcMvcHttpResponseWriter–kernel/private/rest/classes/rest_http_response_writer.php:12–
ezpRestHTTPSRequiredExceptionclass extends ezpRestExceptionException hierarchykernel/private/rest/classes/exceptions/https_required.php:12–
ezpRestIniRouteFilterclass extends ezpRestRouteFilterInterfaceDecorator / filter, INI plugin point (extension point)kernel/private/rest/classes/auth/ini_route_security.php:12–
ezpRestJsonViewclass extends ezcMvcView–kernel/private/rest/classes/views/json.php:12–
ezpRestModelabstract class–kernel/private/rest/classes/models/rest_model.php:15Abstract class for every REST model
ezpRestMvcControllerabstract class extends ezcMvcControllerFront Controller, Template Method / abstract base classkernel/private/rest/classes/controllers/rest_controller.php:15Abstract class that must be extended by every REST controller
ezpRestMvcResultclass extends ezcMvcResult implements ezcBaseExportableFactory and static factory methods, Value object / structkernel/private/rest/classes/response/result.php:15This struct contains the result data to be returned by eZP REST controllers
ezpRestNoAuthStyleclass extends ezpRestAuthenticationStyle implements ezpRestAuthenticationStyleInterface–kernel/private/rest/classes/auth/styles/no_auth.php:16This auth style is used when no authentication is required for current REST request A default user will be returned.
ezpRestOauthAuthenticationStyleclass extends ezpRestAuthenticationStyle implements ezpRestAuthenticationStyleInterfaceINI plugin point (extension point)kernel/private/rest/classes/auth/styles/oauth.php:12–
ezpRestOauthErrorStatusclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/oauth_error.php:12–
ezpRestOauthTokenControllerclass extends ezcMvcController–kernel/private/rest/classes/controllers/oauth_token.php:18Controller for OAuth token endpoint.
ezpRestPoConfigclass implements ezcBaseConfigurationInitializer–kernel/private/rest/classes/lazy.php:101–
ezpRestPrefixFilterInterfaceabstract classDecorator / filter, Template Method / abstract base classkernel/private/rest/classes/prefix_filter.php:12–
ezpRestPreRoutingFilterInterfaceinterfaceDecorator / filter, Interface (contract)kernel/private/rest/classes/interfaces/prerouting_filter.php:12–
ezpRestProviderclassFactory and static factory methods, Strategy / handler, Utility (static helper)kernel/private/rest/classes/rest_provider.php:12–
ezpRestProviderInterfaceinterfaceInterface (contract)kernel/private/rest/classes/interfaces/rest_provider.php:12–
ezpRestProviderNotFoundExceptionclass extends ezpRestExceptionException hierarchykernel/private/rest/classes/exceptions/rest_provider_not_found.php:12–
ezpRestRequestclass extends ezcMvcRequest–kernel/private/rest/classes/request/rest_request.php:20Class mimicking ezcMvcRequest with distinct containers for GET and POST variables.
ezpRestRequestFilterInterfaceinterfaceDecorator / filter, Interface (contract)kernel/private/rest/classes/interfaces/request_filter.php:12–
ezpRestResponseFilterInterfaceinterfaceDecorator / filter, Interface (contract)kernel/private/rest/classes/interfaces/response_filter.php:12–
ezpRestResultFilterInterfaceinterfaceDecorator / filter, Interface (contract)kernel/private/rest/classes/interfaces/result_filter.php:12–
ezpRestRouteFilterInterfaceabstract classDecorator / filter, Template Method / abstract base classkernel/private/rest/classes/interfaces/route_filter.php:11–
ezpRestRouterclass extends ezcMvcRouterChain of Responsibilitykernel/private/rest/classes/router.php:11–
ezpRestRoutesCacheClearclassINI plugin point (extension point), Utility (static helper)kernel/private/rest/classes/cache/clear_routes.php:15Clear cache handler.
ezpRestRouteSecurityFilterNotFoundExceptionclass extends ezpRestExceptionDecorator / filter, Exception hierarchykernel/private/rest/classes/exceptions/route_security_filter_not_found.php:12–
ezpRestStatusResponseclass implements ezcMvcResultStatusObject–kernel/private/rest/classes/status/response.php:12–
ezpRestTokenclass implements ezcPersistentObject–kernel/private/rest/classes/models/ezprest_token.php:16Data class ezprest_tokens.
ezpRestTokenManagerclassFacade / servicekernel/private/oauth/classes/tokenmanager.php:17This class handles application tokens
ezpRestVersionedRouteclass implements ezcMvcRoute, ezcMvcReversibleRoute–kernel/private/rest/classes/routes/versioned_route.php:19Route wrapping around existing instance of ezcMvcRoute providing multiple versions of it.
ezpRestViewControllerInterfaceinterfaceInterface (contract)kernel/private/rest/classes/interfaces/view_controller.php:12–
ezpRouteMethodNotAllowedExceptionclass extends ezcMvcToolsExceptionException hierarchykernel/private/rest/classes/exceptions/route_method_not_allowed.php:12–
ezpSearchEngineinterfaceInterface (contract), Strategy / handlerkernel/private/interfaces/ezpsearchengine.php:18This interface is used as the basis for the different search engine implementation
ezpSiteAccessMenuclassFactory and static factory methods, Utility (static helper)kernel/private/classes/ezpsiteaccessmenu.php:48The administration's site menu: the siteaccesses of this installation with their front page addresses, for the globe button in the admin4 header.
ezpSiteAccessURLclassUtility (static helper)kernel/private/classes/ezpsiteaccessurl.php:44The address of a siteaccess's front page, worked out from the siteaccess settings and the request the visitor is on: the admin's "open the site" link…
ezpStaticCacheinterfaceInterface (contract)kernel/private/interfaces/ezpstaticcache.php:16This interface is used as the basis for the different StaticCache engine implementation
ezpTemplateOverridesclass–kernel/private/classes/ezptemplateoverrides.php:33Changes the template overrides of one siteaccess, for Design › Templates, in settings/siteaccess//override.ini.append.php and nowhere else.
ezpTopologicalSortclass–kernel/private/classes/ezptopologicalsort.php:15Sorts a series of dependencies in linear order (topological sort).
ezpTopologicalSortNodeclass–kernel/private/classes/ezptopologicalsortnode.php:17Node in a topological sort.
ezpUpdatedContentabstract classTemplate Method / abstract base classkernel/private/rest/classes/sync/updates.php:23This class provides API through which one can query for updated content items.
ezpUserNotFoundExceptionclass extends ezpRestExceptionException hierarchykernel/private/rest/classes/exceptions/user_not_found.php:11–
ezpWebBasedKernelHandlerinterface extends ezpKernelHandlerInterface (contract), Strategy / handlerkernel/private/interfaces/ezpwebbasedkernelhandler.php:14Interface for web-based kernel handlers
eZScriptClusterPurgeclass–kernel/private/classes/ezscriptclusterpurge.php:32This class handles purging of cluster items.
eZScriptTrashPurgeclass–kernel/private/classes/ezscripttrashpurge.php:12This class handles purging of trash items.

Module views (8)

ViewScriptPolicy functionsDefined in
/oauth/authorizeauthorize.php–kernel/private/modules/oauth/module.php:21
/oauthadmin/listlist.php–kernel/private/modules/oauthadmin/module.php:21
/oauthadmin/editedit.php–kernel/private/modules/oauthadmin/module.php:26
/oauthadmin/actionaction.php–kernel/private/modules/oauthadmin/module.php:37
/oauthadmin/viewview.php–kernel/private/modules/oauthadmin/module.php:46
/oauthadmin/keyskeys.php–kernel/private/modules/oauthadmin/module.php:54
/oauthadmin/keyactionkeyaction.php–kernel/private/modules/oauthadmin/module.php:61
/switchlanguage/toto.php–kernel/private/modules/switchlanguage/module.php:16

Policy functions (1)

FunctionLimitationsDefined in
oauth/authorize–kernel/private/modules/oauth/module.php:29

Fetch functions (1)

FetchImplemented byDefined in
fetch( 'switchlanguage', 'url_alias' )ezpLanguageSwitcherFunctionCollection::fetchUrlAlias()kernel/private/modules/switchlanguage/function_definition.php:13

Template operators (1)

OperatorsClassRegistered in
language_switcherezpLanguageSwitcherOperatorkernel/private/eztemplate/eztemplateautoload.php:13

Event hooks (4)

EventKindCalled in
request/preinputnotifykernel/private/classes/ezpkernelweb.php:1661
request/inputnotifykernel/private/classes/ezpkernelweb.php:1786
response/preoutputfilterkernel/private/classes/global_functions.php:83
response/outputfilterkernel/private/classes/global_functions.php:102

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x