• Home
• Jackalope
• Transport
• Jackrabbit
• Client

PHP Class Jackalope\Transport\Jackrabbit\Client

This class handles the communication between Jackalope and Jackrabbit over Davex. Once the login method has been called, the workspace is set and can not be changed anymore. We make one exception to the rule that nothing may be cached in the transport: Repository descriptors are considered immutable and cached (because they are also used in startup to check the backend version is compatible). Show file Open project: jackalope/jackalope-jackrabbit Class Usage Examples

Protected Properties

Property	Type	Description
$checkLoginOnServer	boolean	Check if an initial PROPFIND should be send to check if repository exists This is according to the JCR specifications and set to true by default
$credentials	PHPCR\SimpleCredentials	Set once login() has been executed and may not be changed later on.
$curl	Jackalope\Transport\Jackrabbit\curl	The cURL resource handle
$defaultHeaders	array[]string	A list of additional HTTP headers to be sent on each request
$descriptors		This is our exception to the rule that nothing may be cached in transport.
$factory	Jackalope\FactoryInterface	The factory to instantiate objects
$jsopBody
$nodeTypeManager	Jackalope\NodeType\NodeTypeManager
$sendExpect		Send Expect: 100-continue header
$server	string	i.e http://localhost:8080/server/ constructor ensures the trailing slash /
$typeXmlConverter	Jackalope\NodeType\NodeTypeXmlConverter
$userData
$valueConverter	PHPCR\Util\ValueConverter
$workspace	string	Set once login() has been executed and may not be changed later on.
$workspaceUri	string	"$server/$workspace" without trailing slash
$workspaceUriRoot	string	"$server/$workspace/jcr%3aroot (make sure you never hardcode the jcr%3aroot, its ugly)

Public Methods

Method	Description
__construct ( Jackalope\FactoryInterface $factory, string $serverUri )	Create a transport pointing to a server url.
__destruct ( )	Tidies up the current cUrl connection.
addCurlOptions ( array $options ) : array	Add global curl-options.
addDefaultHeader ( string $header )	Add a HTTP header which is sent on each Request.
addVersionLabel ( $versionPath, $label, $moveLabel )
checkinItem ( $path )	{@inheritDoc}
checkoutItem ( $path )	{@inheritDoc}
cloneFrom ( $srcWorkspace, $srcAbsPath, $destAbsPath, $removeExisting )	{@inheritDoc}
copyNode ( $srcAbsPath, $dstAbsPath, $srcWorkspace = null )	{@inheritDoc}
createWorkspace ( $name, $srcWorkspace = null )	{@inheritDoc}
deleteNodeImmediately ( $path )	{@inheritDoc}
deleteNodes ( array $operations )	{@inheritDoc}
deleteProperties ( array $operations )	{@inheritDoc}
deletePropertyImmediately ( $path )	{@inheritDoc}
deleteWorkspace ( $name )
fetchEventData ( $date ) : array	Internal method to fetch event data.
finishSave ( )	{@inheritDoc}
forceHttpVersion10 ( $forceHttpVersion10 = true )	Set to true to force HTTP version 1.0
getAccessibleWorkspaceNames ( )	{@inheritDoc}
getBinaryStream ( $path )	{@inheritDoc}
getEvents ( $date, PHPCR\Observation\EventFilterInterface $filter, PHPCR\SessionInterface $session )	{@inheritDoc}
getNamespaces ( )	{@inheritDoc}
getNode ( $path )	{@inheritDoc}
getNodeByIdentifier ( $uuid )	{@inheritDoc}
getNodePathForIdentifier ( $uuid, $workspace = null )	{@inheritDoc}
getNodeTypes ( $nodeTypes = [] )	{@inheritDoc}
getNodes ( $paths, $query = ':include' )	{@inheritDoc}
getNodesByIdentifier ( $identifiers )	{@inheritDoc}
getPermissions ( $path )	{@inheritDoc}
getProperty ( $path )	{@inheritDoc}
getReferences ( $path, $name = null )	{@inheritDoc}
getRepositoryDescriptors ( )	{@inheritDoc}
getSupportedQueryLanguages ( )	{@inheritDoc}
getUserData ( ) : mixed
getWeakReferences ( $path, $name = null )	{@inheritDoc}
getWorkspaceUri ( ) : null | string	Return the URL to the workspace determined during login
isLocked ( $absPath )	{@inheritDoc}
lockNode ( $absPath, $isDeep, $isSessionScoped, $timeoutHint = PHP_INT_MAX, $ownerInfo = null )	{@inheritDoc}
login ( PHPCR\CredentialsInterface $credentials = null, $workspaceName = null )	{@inheritDoc}
logout ( )	{@inheritDoc}
moveNodeImmediately ( $srcAbsPath, $dstAbsPath )	{@inheritDoc}
moveNodes ( array $operations )	{@inheritDoc}
prepareSave ( )	{@inheritDoc}
query ( Query $query )	{@inheritDoc}
registerNamespace ( $prefix, $uri )	{@inheritDoc}
registerNodeTypesCnd ( $cnd, $allowUpdate )	{@inheritDoc}
removeVersion ( $versionPath, $versionName )	{@inheritDoc}
removeVersionLabel ( $versionPath, $label )
reorderChildren ( Node $node )	{@inheritDoc}
restoreItem ( $removeExisting, $versionPath, $path )	{@inheritDoc}
rollbackSave ( )	{@inheritDoc}
sendExpect ( boolean $send = true )	If you want to send the "Expect: 100-continue" header on larger PUT and POST requests, set this to true.
setCheckLoginOnServer ( $bool )	Configure whether to check if we are logged in before doing a request.
setNodeTypeManager ( $nodeTypeManager )	{@inheritDoc}
setUserData ( $userData )	{@inheritDoc}
storeNodes ( array $operations )	{@inheritDoc}
unlock ( $absPath, $lockToken )	{@inheritDoc}
unregisterNamespace ( $prefix )	{@inheritDoc}
updateNode ( Node $node, $srcWorkspace )	{@inheritDoc}
updateProperties ( Node $node )	{@inheritDoc}

Protected Methods

Method	Description
addWorkspacePathToUri ( string $uri ) : string	Prepends the workspace root to the uris that contain an absolute path
buildLocateRequest ( string $uuid ) : string	Build REPORT XML request for locating a node path by uuid
buildNodeTypesRequest ( array $nodeTypes ) : string	Returns the XML required to request nodetypes
buildPropfindRequest ( array $properties ) : string	Build PROPFIND request XML for the specified property names
buildRegisterNamespaceRequest ( array $mappings )	Build the xml to update the namespaces
buildRegisterNodeTypeRequest ( string $cnd, $allowUpdate ) : string	Build the xml required to register node types
buildReportRequest ( string $name ) : string	Build a REPORT XML request string
checkForExistingNode ( $srcWorkspace, $srcAbsPath, $destAbsPath )	Prevent accidental creation of same name siblings during clone operation.
createNodeJsop ( string $path, array $properties ) : string	create the node markup and a list of value dispatches for multivalue properties
deleteItem ( string $path )	Record that we need to delete the item at $path
encodeAndValidatePathForDavex ( string $path ) : string	Checks if the path is absolute and valid, and properly urlencodes special characters
generateLockFromDavResponse ( DOMElement $response, boolean $sessionOwning = false, string $path = null ) : Lock	Extract the information from a LOCK DAV response and create the corresponding Lock object.
getCurl ( )
getMimePart ( $name, $value, $mime_boundary )
getNodeReferences ( string $path, string $name = null, boolean $weak_reference = false ) : array
getRequest ( $method, $uri, $addWorkspacePathToUri = true ) : Request	Makes sure there is an open curl connection.
getRequiredDomElementByTagNameNS ( DOMNode $dom, string $namespace, string $element, string $errorMessage = '' ) : boolean | DOMNode	Retrieve a child DOM element from a DOM element.
isStringValid ( $string ) : boolean	Checks for occurrence of invalid UTF characters, that can not occur in valid XML document.
parseTimeout ( string $timeoutValue ) : integer	Parse the timeout value from a WebDAV response and calculate the expire timestamp.
propertyToJsopString ( Property $property ) : mixed | string	This method is used when building a JSOP of the properties
setJsopBody ( $value, $key = ":diff", $type = null )
stripServerRootFromUri ( string $uri ) : string	remove the server and workspace part from an uri, leaving the absolute path inside the current workspace
updateLastModified ( Node $node )	Update the lastModified fields if they where not set manually.

Private Methods

Method	Description
copyNodeOtherWorkspace ( string $srcAbsPath, $dstAbsPath, string $srcWorkspace )	For copy from a different workspace, needs to be a JSOP.
copyNodeSameWorkspace ( string $srcAbsPath, $dstAbsPath )	For copy within the same workspace, this is a COPY request.
decodeBinaryDom ( string $xml ) : array	parse the multivalue binary response (a list of base64 encoded values)
getDcrValue ( DOMElement $node ) : mixed	Get the value of a dcr:value node in the right format specified by the dcr type.
removeTrailingSlash ( string $path ) : string	Remove the trailing slash if present. Used for backend responses when jackrabbit is sloppy
storeProperty ( Property $property )

Method Details

Property Details