eZPublishCommunityProject  2013.4
eZ Namespace Reference

Container interface. More...

Namespaces

 Bundle
 
 Publish
 

Detailed Description

Container interface.

Interface for validation errors.

The field type interface which all field types have to implement to be indexable by search backends.

Interface for setting field type data.

UserService class .

URLWildcardService class .

URLAliasService class .

TrashService class .

UpdateUserSignal class .

UpdateUserGroupSignal class .

UnAssignUserFromUserGroupSignal class .

MoveUserGroupSignal class .

DeleteUserSignal class .

DeleteUserGroupSignal class .

CreateUserSignal class .

CreateUserGroupSignal class .

AssignUserToUserGroupSignal class .

TranslateSignal class .

RemoveSignal class .

CreateSignal class .

RemoveAliasesSignal class .

CreateUrlAliasSignal class .

CreateGlobalUrlAliasSignal class .

TrashSignal class .

RecoverSignal class .

EmptyTrashSignal class .

DeleteTrashItemSignal class .

UpdateSectionSignal class .

DeleteSectionSignal class .

CreateSectionSignal class .

AssignSectionSignal class .

UpdateRoleSignal class .

UpdatePolicySignal class .

UnassignRoleFromUserSignal class .

UnassignRoleFromUserGroupSignal class .

RemovePolicySignal class .

DeleteRoleSignal class .

CreateRoleSignal class .

AssignRoleToUserSignal class .

AssignRoleToUserGroupSignal class .

AddPolicySignal class .

UpdateObjectStateSignal class .

UpdateObjectStateGroupSignal class .

SetPriorityOfObjectStateSignal class .

SetContentStateSignal class .

DeleteObjectStateSignal class .

DeleteObjectStateGroupSignal class .

CreateObjectStateSignal class .

CreateObjectStateGroupSignal class .

UpdateLocationSignal class .

UnhideLocationSignal class .

SwapLocationSignal class .

MoveSubtreeSignal class .

HideLocationSignal class .

DeleteLocationSignal class .

CreateLocationSignal class .

CopySubtreeSignal class .

UpdateLanguageNameSignal class .

EnableLanguageSignal class .

DisableLanguageSignal class .

DeleteLanguageSignal class .

CreateLanguageSignal class .

UpdateFieldDefinitionSignal class .

UpdateContentTypeGroupSignal class .

UpdateContentTypeDraftSignal class .

UnassignContentTypeGroupSignal class .

RemoveFieldDefinitionSignal class .

PublishContentTypeDraftSignal class .

DeleteContentTypeSignal class .

DeleteContentTypeGroupSignal class .

CreateContentTypeSignal class .

CreateContentTypeGroupSignal class .

CreateContentTypeDraftSignal class .

CopyContentTypeSignal class .

AssignContentTypeGroupSignal class .

AddFieldDefinitionSignal class .

UpdateContentSignal class .

UpdateContentMetadataSignal class .

TranslateVersionSignal class .

PublishVersionSignal class .

DeleteVersionSignal class .

DeleteRelationSignal class .

DeleteContentSignal class .

CreateContentSignal class .

CreateContentDraftSignal class .

CopyContentSignal class .

AddTranslationInfoSignal class .

AddRelationSignal class .

SectionService class .

SearchService class .

RoleService class .

ObjectStateService class .

LocationService class .

LanguageService class .

FieldTypeService class .

ContentTypeService class .

ContentService class .

Trash service used for content/location trash handling.

File containing the ObjectStateService class.

Service used to handle io operations.

This class represents a FieldType available to Public API users.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

Repository class .

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

This class represents a FieldType available to SPI users.

The io service for managing binary files.

File containing the eZ class.

Base class fro translation messages.

Class for translatable messages, which may contain plural forms.

File containing the eZ class.

Class for translatable messages, which only occur in singular form.

File containing the eZ class.

File containing the eZ class.

This class is the base for SortClause classes, used to set sorting of content queries .

File containing the eZ class.

File containing the eZ class.

Struct that stores extra target informations for a SortClause object .

File containing the eZ class.

This class is the base class for facet builders.

File containing the eZ class.

Build a user facet.

File containing the eZ class.

Build a term facet.

File containing the eZ class.

Build a section facet.

File containing the eZ class.

Build a Subtree facet.

File containing the eZ class.

Build a field range facet.

Build a field term facet.

File containing the eZ class.

Build a date range facet.

File containing the eZ class.

Build a criterion facet.

File containing the eZ class.

Building a content type facet.

File containing the eZ class.

Base interface for Criterion implementations .

File containing the eZ class.

File containing the eZ class.

Operators struct.

File containing the eZ class.

This class is used by Criteria to describe which operators they support.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

File containing the eZ class.

Trash service, used for managing trashed content.

File containing the eZ class.

Interface for a translation service.

Interface implemented by everything which should be translatable.

Section service, used for section operations.

File containing the eZ class.

Search service.

File containing the eZ class.

This service provides methods for managing Roles and Policies.

Repository interface .

File containing the eZ class.

File containing the eZ interface.

File containing the eZ class.

Language service, used for language operations.

File containing the eZ class.

This class provides service methods available to FieldTypes.

File containing the eZ class.

An implementation of this class provides access to FieldTypes.

File containing the eZ class.

Interface that FieldTypes expose to the public API.

File containing the eZ class.

This Exception is thrown on a write attempt in a read only property in a value object.

This Exception is thrown if an accessed property in a value object was not found.

This Exception is thrown if an object referenced by an id or identifier could not be found in the repository.

An Exception which is thrown if an operation cannot be performed by a service although the current user would have permission to perform this action.

File containing the eZ class.

File containing the eZ class.

Starting point for getting all Public API's

Version
See Also
eZ For implementer doc
eZ

This interface cannot be retrieved through the Public API and is not meant to be used by its users. It is only available to eZ implementers through the ::handleEvent() method.

Todo:
Change this to be able to handle relations for FieldTypes in an effective manner

This should for example be implemented by any exception, which might bubble up to a user, or validation errors.

Implement this to use translation backends like Symfony2 Translate, gettext or ezcTranslation.

Call the translation method with the current target locale from your templates, for example.

Version

Instances of this class are returned in an array by the {

See Also
Criterion::getSpecifications()} method

Note that the method is abstract as there is no point in instantiating it

Version

If provided the search service returns a ContentTypeFacet

If provided the search service returns a CriterionFacet based on the criterion provided in the FacetBuilder class.

If provided the search service returns a DateRangeFacet depending on the provided type (PUBLISHED, CREATED, MODIFIED)

If provided the search service returns a FieldFacet for the provided field path. A field path starts with a field identifier and may contain a subpath in the case of complex field types (e.g. author/name)

If provided the search service returns a FieldRangeFacet for the given field path. A field path starts with a field identifier and may contain a subpath in the case of complex field types

If provided the search service returns a LocationFacet which contains the counts for all content objects below the child locations.

Todo:
: check hierarchical facets

If provided the search service returns a SectionFacet. Which contains the counts for content in the existing sections.

If provided the search service returns a TermFacet which contains the counts for content containing terms in arbitrary fields

If provided the search service returns a UserFacet for the given type.

Version
Version

The message might include replacements, in the form %[A-Za-z]%. Those are replaced by the values provided. A raw % can be escaped like %%.

The message might include replacements, in the form %[A-Za-z]%. Those are replaced by the values provided. A raw % can be escaped like %%.

You need to provide a singular and plural variant for the string. The strings provided should be english and will be translated depending on the environment language.

This interface follows the interfaces of XLiff, gettext, Symfony2 Translations and Zend_Translate. For singular forms you just provide a plain string (with optional placeholders without effects on the plural forms). For potential plural forms you always provide a singular variant and an english simple plural variant. No implementation supports multiple different plural forms in one single message.

The singular / plural string could, for Symfony2, for example be converted to "$singular|$plural", and you would call gettext like: ngettext( $singular, $plural, $count ).

Use its extensions: Translation, Translation.

See Also
Version

This interface cannot be retrieved through the Public API and is not meant to be used by its users. It is only available to eZ implementers through the ::handleEvent() method.

Todo:
Change this to be able to handle relations for FieldTypes in an effective manner (incl op_code handling in SPI)
See Also
eZ
Version

Methods in this interface are called by storage engine.

$context array passed to most methods provides some context for the field handler about the currently used storage engine. The array should at least define 2 keys :

  • identifier (connection identifier)
  • connection (the connection handler) For example, using Legacy storage engine, $context will be:
  • identifier = 'LegacyStorage'
  • connection = eZ\Publish\Core\Persistence\Legacy\EzcDbHandlerobjecthandler(forDBconnection),tobeusedaccordinglyto@linkhttp://incubator.apache.org/zetacomponents/documentation/trunk/Database/tutorial.htmlezcDatabaseusage\Publish\SPI\FieldType\Publish\SPI\FieldTypeEnforcestoreturnatranslatablemessage,sinceitwillbenecessarytopresentvalidationerrorstotheuser.Thusweneedpluralformhandlingandreplacementsofplaceholdersandsoon.\Publish\SPI\FieldType