phpcr/src/PHPCR/RepositoryInterface.php

Show:

inherited

Table of Contents

This file is part of the PHPCR API and was originally ported from the Java JCR API to PHP by Karsten Dambekalns for the FLOW3 project.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

License: Apache Software License 2.0
Link: http://phpcr.github.com/

\PHPCR\RepositoryInterface
jump to top

Package: Default

The entry point into the content repository.

The Repository object is usually acquired through an implementation of the RepositoryFactoryInterface.

PHPCR Note: This interface has been simplified compared to JCR:

getDescriptor returns array on multivalue, single variable otherwise
removed isSingleValueDescriptor
removed getDescriptorValue and getDescriptorValues as ValueInterface has been dropped. Use getDescriptor to get the variable value.

Api

Constants

 
                SPEC_VERSION_DESC
                = "jcr.specification.version"

The descriptor key for the version of the specification this repository implements.

 
                SPEC_NAME_DESC
                = "jcr.specification.name"

The descriptor key for the name of the specification this repository implements.

 
                REP_VENDOR_DESC
                = "jcr.repository.vendor"

The descriptor key for the name of the repository vendor.

 
                REP_VENDOR_URL_DESC
                = "jcr.repository.vendor.url"

The descriptor key for the URL of the repository vendor.

 
                REP_NAME_DESC
                = "jcr.repository.name"

The descriptor key for the name of this repository implementation.

 
                REP_VERSION_DESC
                = "jcr.repository.version"

The descriptor key for the version of this repository implementation.

 
                WRITE_SUPPORTED
                = "write.supported"

Key to a boolean descriptor.

 
                IDENTIFIER_STABILITY
                = "identifier.stability"

Key to a String descriptor.

 
                IDENTIFIER_STABILITY_METHOD_DURATION
                = "identifier.stability.method.duration"

One of four possible values for the descriptor IDENTIFIER_STABILITY.

 
                IDENTIFIER_STABILITY_SAVE_DURATION
                = "identifier.stability.save.duration"

One of four possible values for the descriptor IDENTIFIER_STABILITY.

 
                IDENTIFIER_STABILITY_SESSION_DURATION
                = "identifier.stability.session.duration"

One of four possible values for the descriptor IDENTIFIER_STABILITY.

 
                IDENTIFIER_STABILITY_INDEFINITE_DURATION
                = "identifier.stability.indefinite.duration"

One of four possible values for the descriptor IDENTIFIER_STABILITY.

 
                OPTION_XML_EXPORT_SUPPORTED
                = "option.xml.export.supported"

Key to a boolean descriptor.

 
                OPTION_XML_IMPORT_SUPPORTED
                = "option.xml.import.supported"

Key to a boolean descriptor.

 
                OPTION_UNFILED_CONTENT_SUPPORTED
                = "option.unfiled.content.supported"

Key to a boolean descriptor.

 
                OPTION_VERSIONING_SUPPORTED
                = "option.versioning.supported"

Key to a boolean descriptor.

 
                OPTION_SIMPLE_VERSIONING_SUPPORTED
                = "option.simple.versioning.supported"

Key to a boolean descriptor.

 
                OPTION_ACTIVITIES_SUPPORTED
                = "option.activities.supported"

Key to a boolean descriptor.

 
                OPTION_BASELINES_SUPPORTED
                = "option.baselines.supported"

Key to a boolean descriptor.

 
                OPTION_ACCESS_CONTROL_SUPPORTED
                = "option.access.control.supported"

Key to a boolean descriptor.

 
                OPTION_LOCKING_SUPPORTED
                = "option.locking.supported"

Key to a boolean descriptor.

 
                OPTION_OBSERVATION_SUPPORTED
                = "option.observation.supported"

Key to a boolean descriptor.

 
                OPTION_JOURNALED_OBSERVATION_SUPPORTED
                = "option.journaled.observation.supported"

Key to a boolean descriptor.

 
                OPTION_RETENTION_SUPPORTED
                = "option.retention.supported"

Key to a boolean descriptor.

 
                OPTION_LIFECYCLE_SUPPORTED
                = "option.lifecycle.supported"

Key to a boolean descriptor.

 
                OPTION_TRANSACTIONS_SUPPORTED
                = "option.transactions.supported"

Key to a boolean descriptor.

 
                OPTION_WORKSPACE_MANAGEMENT_SUPPORTED
                = "option.workspace.management.supported"

Key to a boolean descriptor.

 
                OPTION_UPDATE_PRIMARY_NODETYPE_SUPPORTED
                = "option.update.primary.nodetype.supported"

Key to a boolean descriptor.

 
                OPTION_UPDATE_MIXIN_NODETYPES_SUPPORTED
                = "option.update.mixin.nodetypes.supported"

Key to a boolean descriptor.

 
                OPTION_SHAREABLE_NODES_SUPPORTED
                = "option.shareable.nodes.supported"

Key to a boolean descriptor.

 
                OPTION_NODE_TYPE_MANAGEMENT_SUPPORTED
                = "option.node.type.management.supported"

Key to a boolean descriptor.

 
                OPTION_NODE_AND_PROPERTY_WITH_SAME_NAME_SUPPORTED
                = "option.node.and.property.with.same.name.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_INHERITANCE
                = "node.type.management.inheritance"

Key to string descriptor.

 
                NODE_TYPE_MANAGEMENT_INHERITANCE_MINIMAL
                = "node.type.management.inheritance.minimal"

One of three possible values for the descriptor NODE_TYPE_MANAGEMENT_INHERITANCE.

 
                NODE_TYPE_MANAGEMENT_INHERITANCE_SINGLE
                = "node.type.management.inheritance.single"

One of three possible values for the descriptor NODE_TYPE_MANAGEMENT_INHERITANCE.

 
                NODE_TYPE_MANAGEMENT_INHERITANCE_MULTIPLE
                = "node.type.management.inheritance.multiple"

One of three possible values for the descriptor NODE_TYPE_MANAGEMENT_INHERITANCE.

 
                NODE_TYPE_MANAGEMENT_OVERRIDES_SUPPORTED
                = "node.type.management.overrides.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_PRIMARY_ITEM_NAME_SUPPORTED
                = "node.type.management.primary.item.name.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_ORDERABLE_CHILD_NODES_SUPPORTED
                = "node.type.management.orderable.child.nodes.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_RESIDUAL_DEFINITIONS_SUPPORTED
                = "node.type.management.residual.definitions.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_AUTOCREATED_DEFINITIONS_SUPPORTED
                = "node.type.management.autocreated.definitions.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_SAME_NAME_SIBLINGS_SUPPORTED
                = "node.type.management.same.name.siblings.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_PROPERTY_TYPES
                = "node.type.management.property.types"

Key to an integer[] descriptor.

 
                NODE_TYPE_MANAGEMENT_MULTIVALUED_PROPERTIES_SUPPORTED
                = "node.type.management.multivalued.properties.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_MULTIPLE_BINARY_PROPERTIES_SUPPORTED
                = "node.type.management.multiple.binary.properties.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_VALUE_CONSTRAINTS_SUPPORTED
                = "node.type.management.value.constraints.supported"

Key to a boolean descriptor.

 
                NODE_TYPE_MANAGEMENT_UPDATE_IN_USE_SUPPORTED
                = "node.type.management.update.in.use.supported"

Key to boolean descriptor.

 
                QUERY_LANGUAGES
                = "query.languages"

Key to a string[] descriptor.

 
                QUERY_STORED_QUERIES_SUPPORTED
                = "query.stored.queries.supported"

Key to a boolean descriptor.

 
                QUERY_FULL_TEXT_SEARCH_SUPPORTED
                = "query.full.text.search.supported"

Key to a boolean descriptor.

 
                QUERY_JOINS
                = "query.joins"

Key to String descriptor.

 
                QUERY_JOINS_NONE
                = "query.joins.none"

One of three possible values for the descriptor QUERY_JOINS .

 
                QUERY_JOINS_INNER
                = "query.joins.inner"

One of three possible values for the descriptor QUERY_JOINS .

 
                QUERY_JOINS_INNER_OUTER
                = "query.joins.inner.outer"

One of three possible values for the descriptor QUERY_JOINS .

Methods

getDescriptor(string $key) : mixed

Get the value(s) for this key.

Name	Type	Description
$key	string	a descriptor key.

Type	Description
mixed	a descriptor value in string or boolean form or an array of strings or booleans for multivalue descriptors

getDescriptorKeys() : array

Returns a string array holding all descriptor keys available for this implementation.

Type	Description
array	a string array holding all descriptor keys

isStandardDescriptor(string $key) : boolean

Determines if the given identifier is a standard descriptor.

Name	Type	Description
$key	string	a descriptor key.

Type	Description
boolean	whether $key is a standard descriptor.

login(\PHPCR\CredentialsInterface $credentials = null, string $workspaceName = null) : \PHPCR\SessionInterface

Authenticates the user using the supplied credentials.

Exception	Description
\PHPCR\LoginException	if authentication or authorization (for the specified workspace) fails
\PHPCR\NoSuchWorkspaceException	if the specified workspaceName is not recognized
\PHPCR\RepositoryException	if another error occurs

Name	Type	Description
$credentials	\PHPCR\CredentialsInterface	The credentials of the user
$workspaceName	string	the name of a workspace

phpcr/src/PHPCR/RepositoryInterface.php

\PHPCR\RepositoryInterfacejump to top

Constants

Methods

\PHPCR\RepositoryInterface
jump to top