include/externalAPI/cmis_repository_wrapper.php

Show: inherited
Table of Contents

Constants

Constant  HTTP_OK = 200
Constant  HTTP_CREATED = 201
Constant  HTTP_ACCEPTED = 202
Constant  HTTP_NONAUTHORITATIVE_INFORMATION = 203
Constant  HTTP_NO_CONTENT = 204
Constant  HTTP_RESET_CONTENT = 205
Constant  HTTP_PARTIAL_CONTENT = 206
Constant  HTTP_MULTIPLE_CHOICES = 300
Constant  HTTP_BAD_REQUEST = 400
Constant  HTTP_UNAUTHORIZED = 401
Constant  HTTP_FORBIDDEN = 403
Constant  HTTP_NOT_FOUND = 404
Constant  HTTP_METHOD_NOT_ALLOWED = 405
Constant  HTTP_NOT_ACCEPTABLE = 406
Constant  HTTP_PROXY_AUTHENTICATION_REQUIRED = 407
Constant  xHTTP_REQUEST_TIMEOUT = 408
Constant  HTTP_CONFLICT = 409
Constant  HTTP_UNSUPPORTED_MEDIA_TYPE = 415
Constant  HTTP_UNPROCESSABLE_ENTITY = 422
Constant  HTTP_INTERNAL_SERVER_ERROR = 500
Constant  OPT_MAX_ITEMS = "maxItems"
Constant  OPT_SKIP_COUNT = "skipCount"
Constant  OPT_FILTER = "filter"
Constant  OPT_INCLUDE_PROPERTY_DEFINITIONS = "includePropertyDefinitions"
Constant  OPT_INCLUDE_RELATIONSHIPS = "includeRelationships"
Constant  OPT_INCLUDE_POLICY_IDS = "includePolicyIds"
Constant  OPT_RENDITION_FILTER = "renditionFilter"
Constant  OPT_INCLUDE_ACL = "includeACL"
Constant  OPT_INCLUDE_ALLOWABLE_ACTIONS = "includeAllowableActions"
Constant  OPT_DEPTH = "depth"
Constant  OPT_CHANGE_LOG_TOKEN = "changeLogToken"
Constant  LINK_ALLOWABLE_ACTIONS = "http://docs.oasis-open.org/ns/cmis/link/200908/allowableactions"
Constant  MIME_ATOM_XML = 'application/atom+xml'
Constant  MIME_ATOM_XML_ENTRY = 'application/atom+xml;type=entry'
Constant  MIME_ATOM_XML_FEED = 'application/atom+xml;type=feed'
Constant  MIME_CMIS_TREE = 'application/cmistree+xml'
Constant  MIME_CMIS_QUERY = 'application/cmisquery+xml'

\CMISRepositoryWrapper

Package:
Children
\CMISService

Properties

Propertyprotected  $_addlCurlOptions= 'array()'
Default valuearray()Details
Type
n/a
Propertypublic  $authenticated= ''
Details
Type
n/a
Propertypublic  $do_not_urlencode= ''
Details
Type
n/a
Propertypublic  $last_request= ''
Details
Type
n/a
Propertypublic  $namespaces= 'array ( "cmis" => "http://docs.oasis-open.org/ns/cmis/core/200908/", "cmisra" => "http://docs.oasis-open.org/ns/cmis/restatom/200908/", "atom" => "http://www.w3.org/2005/Atom", "app" => "http://www.w3.org/2007/app", )'
static
Default valuearray ( "cmis" => "http://docs.oasis-open.org/ns/cmis/core/200908/", "cmisra" => "http://docs.oasis-open.org/ns/cmis/restatom/200908/", "atom" => "http://www.w3.org/2005/Atom", "app" => "http://www.w3.org/2007/app", )Details
Type
n/a
Propertypublic  $password= ''
Details
Type
n/a
Propertypublic  $url= ''
Details
Type
n/a
Propertypublic  $username= ''
Details
Type
n/a
Propertypublic  $workspace= ''
Details
Type
n/a

Methods

methodpublic__construct(  $url,  $username = null,  $password = null,  $options = null,  $addlCurlOptions = array() ) : void

Parameters
Name Type Description
$url
$username
$password
$options
$addlCurlOptions
methodpublicconnect(  $url,  $username,  $password,  $options ) : void

Parameters
Name Type Description
$url
$username
$password
$options
methodpublicconvertStatusCode(  $code,  $message ) : void

Parameters
Name Type Description
$code
$message
methodpublicdoDelete(  $url ) : void

Parameters
Name Type Description
$url
methodpublicdoGet(  $url ) : void

Parameters
Name Type Description
$url
methodpublicdoPost(  $url,  $content,  $contentType,  $charset = null ) : void

Parameters
Name Type Description
$url
$content
$contentType
$charset
methodpublicdoPut(  $url,  $content,  $contentType,  $charset = null ) : void

Parameters
Name Type Description
$url
$content
$contentType
$charset
methodpublicdoRequest(  $url,  $method = "GET",  $content = null,  $contentType = null,  $charset = null ) : void

Parameters
Name Type Description
$url
$method
$content
$contentType
$charset
methodpublicdoXQuery(  $xmldata,  $xquery ) : void
static

Parameters
Name Type Description
$xmldata
$xquery
methodpublicdoXQueryFromNode(  $xmlnode,  $xquery ) : void
static

Parameters
Name Type Description
$xmlnode
$xquery
methodpublicextractAllowableActions(  $xmldata ) : void
static

Parameters
Name Type Description
$xmldata
methodpublicextractAllowableActionsFromNode(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicextractObject(  $xmldata ) : void
static

Parameters
Name Type Description
$xmldata
methodpublicextractObjectFeed(  $xmldata ) : void
static

Parameters
Name Type Description
$xmldata
methodpublicextractObjectFeedFromNode(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicextractObjectFromNode(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicextractTypeDef(  $xmldata ) : void
static

Parameters
Name Type Description
$xmldata
methodpublicextractTypeDefFromNode(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicextractTypeFeed(  $xmldata ) : void
static

Parameters
Name Type Description
$xmldata
methodpublicextractTypeFeedFromNode(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicextractWorkspace(  $xmldata ) : void
static

Parameters
Name Type Description
$xmldata
methodpublicextractWorkspaceFromNode(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicgetLastRequest( ) : void

methodpublicgetLastRequestBody( ) : void

methodpublicgetLastRequestCode( ) : void

methodpublicgetLastRequestContentLength( ) : void

methodpublicgetLastRequestContentSent( ) : void

methodpublicgetLastRequestContentType( ) : void

methodpublicgetLastRequestContentTypeSent( ) : void

methodpublicgetLastRequestMethod( ) : void

methodpublicgetLastRequestURL( ) : void

methodpublicgetLinksArray(  $xmlnode ) : void
static

Parameters
Name Type Description
$xmlnode
methodpublicgetOpUrl(  $url,  $options = null ) : void
static

Parameters
Name Type Description
$url
$options
methodpublichandleSpaces(  $path ) : void

Parameters
Name Type Description
$path
methodpublicprocessTemplate(  $template,  $values = array () ) : void
static

Parameters
Name Type Description
$template
$values

\CMISService

Package:
Parent(s)
\CMISRepositoryWrapper

Properties

Propertyprotected  $_addlCurlOptions= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$_addlCurlOptions  
Propertypublic  $_link_cache= ''
Details
Type
n/a
Propertypublic  $_objTypeId_cache= ''
Details
Type
n/a
Propertypublic  $_title_cache= ''
Details
Type
n/a
Propertypublic  $_type_cache= ''
Details
Type
n/a
Propertypublic  $authenticated= ''
inheritedInherited from: \CMISRepositoryWrapper::$$authenticated
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$authenticated  
Propertypublic  $do_not_urlencode= ''
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$do_not_urlencode  
Propertypublic  $last_request= ''
inheritedInherited from: \CMISRepositoryWrapper::$$last_request
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$last_request  
Propertypublic  $namespaces= 'array ( "cmis" => "http://docs.oasis-open.org/ns/cmis/core/200908/", "cmisra" => "http://docs.oasis-open.org/ns/cmis/restatom/200908/", "atom" => "http://www.w3.org/2005/Atom", "app" => "http://www.w3.org/2007/app", )'
staticinheritedInherited from: \CMISRepositoryWrapper::$$namespaces
Default valuearray ( "cmis" => "http://docs.oasis-open.org/ns/cmis/core/200908/", "cmisra" => "http://docs.oasis-open.org/ns/cmis/restatom/200908/", "atom" => "http://www.w3.org/2005/Atom", "app" => "http://www.w3.org/2007/app", )Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$namespaces  
Propertypublic  $password= ''
inheritedInherited from: \CMISRepositoryWrapper::$$password
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$password  
Propertypublic  $url= ''
inheritedInherited from: \CMISRepositoryWrapper::$$url
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$url  
Propertypublic  $username= ''
inheritedInherited from: \CMISRepositoryWrapper::$$username
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$username  
Propertypublic  $workspace= ''
inheritedInherited from: \CMISRepositoryWrapper::$$workspace
Details
Type
n/a
Inherited_from
\CMISRepositoryWrapper::$$workspace  

Methods

methodpublic__construct(  $url,  $username,  $password,  $options = null,  $addlCurlOptions = array() ) : void

Parameters
Name Type Description
$url
$username
$password
$options
$addlCurlOptions
methodpublicaddObjectToFolder( ) : void

methodpublicapplyACL( ) : void

methodpublicapplyPolicy( ) : void

methodpubliccacheFeedInfo(  $objs ) : void

Parameters
Name Type Description
$objs
methodpubliccacheObjectInfo(  $obj ) : void

Parameters
Name Type Description
$obj
methodpubliccacheTypeFeedInfo(  $typs ) : void

Parameters
Name Type Description
$typs
methodpubliccacheTypeInfo(  $tDef ) : void

Parameters
Name Type Description
$tDef
methodpubliccancelCheckOut( ) : void

methodpubliccheckIn( ) : void

methodpubliccheckOut( ) : void

methodpublicconnect(  $url,  $username,  $password,  $options ) : void
inherited

Inherited from: \CMISRepositoryWrapper::connect()
Parameters
Name Type Description
$url
$username
$password
$options
methodpublicconvertStatusCode(  $code,  $message ) : void
Parameters
Name Type Description
$code
$message
methodpubliccreateAtomEntry(  $name,  $properties ) : void
static

Parameters
Name Type Description
$name
$properties
methodpubliccreateDocument(  $folderId,  $fileName,  $properties = array (),  $content = null,  $content_type = "application/octet-stream",  $options = array () ) : void

Parameters
Name Type Description
$folderId
$fileName
$properties
$content
$content_type
$options
methodpubliccreateDocumentFromSource( ) : void

methodpubliccreateFolder(  $folderId,  $folderName,  $properties = array (),  $options = array () ) : void

Parameters
Name Type Description
$folderId
$folderName
$properties
$options
methodpubliccreatePolicy( ) : void

methodpubliccreateRelationship( ) : void

methodpublicdeleteAllVersions( ) : void

methodpublicdeleteContentStream(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicdeleteObject(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicdeleteTree( ) : void

methodpublicdoDelete(  $url ) : void
inherited

Inherited from: \CMISRepositoryWrapper::doDelete()
Parameters
Name Type Description
$url
methodpublicdoGet(  $url ) : void
inherited

Inherited from: \CMISRepositoryWrapper::doGet()
Parameters
Name Type Description
$url
methodpublicdoPost(  $url,  $content,  $contentType,  $charset = null ) : void
inherited

Inherited from: \CMISRepositoryWrapper::doPost()
Parameters
Name Type Description
$url
$content
$contentType
$charset
methodpublicdoPut(  $url,  $content,  $contentType,  $charset = null ) : void
inherited

Inherited from: \CMISRepositoryWrapper::doPut()
Parameters
Name Type Description
$url
$content
$contentType
$charset
methodpublicdoRequest(  $url,  $method = "GET",  $content = null,  $contentType = null,  $charset = null ) : void
inherited

Inherited from: \CMISRepositoryWrapper::doRequest()
Parameters
Name Type Description
$url
$method
$content
$contentType
$charset
methodpublicdoXQuery(  $xmldata,  $xquery ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::doXQuery()
Parameters
Name Type Description
$xmldata
$xquery
methodpublicdoXQueryFromNode(  $xmlnode,  $xquery ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::doXQueryFromNode()
Parameters
Name Type Description
$xmlnode
$xquery
methodpublicextractAllowableActions(  $xmldata ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractAllowableActions()
Parameters
Name Type Description
$xmldata
methodpublicextractAllowableActionsFromNode(  $xmlnode ) : void
Parameters
Name Type Description
$xmlnode
methodpublicextractObject(  $xmldata ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractObject()
Parameters
Name Type Description
$xmldata
methodpublicextractObjectFeed(  $xmldata ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractObjectFeed()
Parameters
Name Type Description
$xmldata
methodpublicextractObjectFeedFromNode(  $xmlnode ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractObjectFeedFromNode()
Parameters
Name Type Description
$xmlnode
methodpublicextractObjectFromNode(  $xmlnode ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractObjectFromNode()
Parameters
Name Type Description
$xmlnode
methodpublicextractTypeDef(  $xmldata ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractTypeDef()
Parameters
Name Type Description
$xmldata
methodpublicextractTypeDefFromNode(  $xmlnode ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractTypeDefFromNode()
Parameters
Name Type Description
$xmlnode
methodpublicextractTypeFeed(  $xmldata ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractTypeFeed()
Parameters
Name Type Description
$xmldata
methodpublicextractTypeFeedFromNode(  $xmlnode ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractTypeFeedFromNode()
Parameters
Name Type Description
$xmlnode
methodpublicextractWorkspace(  $xmldata ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractWorkspace()
Parameters
Name Type Description
$xmldata
methodpublicextractWorkspaceFromNode(  $xmlnode ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::extractWorkspaceFromNode()
Parameters
Name Type Description
$xmlnode
methodpublicgetACL( ) : void

methodpublicgetAllVersions( ) : void

methodpublicgetAllowableActions(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicgetAppliedPolicies( ) : void

methodpublicgetCheckedOutDocs(  $options = array () ) : void

Parameters
Name Type Description
$options
methodpublicgetChildren(  $folderId,  $options = array () ) : void

Parameters
Name Type Description
$folderId
$options
methodpublicgetContentChanges( ) : void

methodpublicgetContentEntry(  $content,  $content_type = "application/octet-stream" ) : void
static

Parameters
Name Type Description
$content
$content_type
methodpublicgetContentStream(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicgetContentTemplate( ) : void
static

methodpublicgetDescendants(  $folderId,  $depth,  $options = array () ) : void

Parameters
Name Type Description
$folderId
$depth
$options
methodpublicgetEntryTemplate( ) : void
static

methodpublicgetFolderParent(  $folderId,  $options = array () ) : void

Parameters
Name Type Description
$folderId
$options
methodpublicgetFolderTree(  $folderId,  $depth,  $options = array () ) : void

Parameters
Name Type Description
$folderId
$depth
$options
methodpublicgetLastRequest( ) : void
inherited

Inherited from: \CMISRepositoryWrapper::getLastRequest()
methodpublicgetLastRequestBody( ) : void
methodpublicgetLastRequestCode( ) : void
methodpublicgetLastRequestContentLength( ) : void
methodpublicgetLastRequestContentSent( ) : void
methodpublicgetLastRequestContentType( ) : void
methodpublicgetLastRequestContentTypeSent( ) : void
methodpublicgetLastRequestMethod( ) : void
methodpublicgetLastRequestURL( ) : void
methodpublicgetLink(  $objectId,  $linkName ) : void

Parameters
Name Type Description
$objectId
$linkName
methodpublicgetLinksArray(  $xmlnode ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::getLinksArray()
Parameters
Name Type Description
$xmlnode
methodpublicgetObject(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicgetObjectByPath(  $path,  $options = array () ) : void

Parameters
Name Type Description
$path
$options
methodpublicgetObjectOfLatestVersion(  $objectId,  $major = false,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$major
$options
methodpublicgetObjectParents(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicgetObjectRelationships( ) : void

methodpublicgetObjectType(  $objectId ) : void

Parameters
Name Type Description
$objectId
methodpublicgetObjectTypeDefinition(  $objectId ) : void

Parameters
Name Type Description
$objectId
methodpublicgetOpUrl(  $url,  $options = null ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::getOpUrl()
Parameters
Name Type Description
$url
$options
methodpublicgetProperties(  $objectId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicgetPropertiesOfLatestVersion(  $objectId,  $major = false,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$major
$options
methodpublicgetPropertyTemplate( ) : void
static

methodpublicgetPropertyType(  $typeId,  $propertyId ) : void

Parameters
Name Type Description
$typeId
$propertyId
methodpublicgetQueryTemplate( ) : void
static

methodpublicgetRenditions(  $objectId,  $options = array ( OPT_RENDITION_FILTER => "*" ) ) : void

Parameters
Name Type Description
$objectId
$options
methodpublicgetRepositories( ) : void

methodpublicgetRepositoryInfo( ) : void

methodpublicgetSummaryTemplate( ) : void
static

methodpublicgetTitle(  $objectId ) : void

Parameters
Name Type Description
$objectId
methodpublicgetTypeChildren(  $typeId = null,  $options = array () ) : void

Parameters
Name Type Description
$typeId
$options
methodpublicgetTypeDefinition(  $typeId,  $options = array () ) : void

Parameters
Name Type Description
$typeId
$options
methodpublicgetTypeDescendants(  $typeId = null,  $depth,  $options = array () ) : void

Parameters
Name Type Description
$typeId
$depth
$options
methodpublicgetTypeLink(  $typeId,  $linkName ) : void

Parameters
Name Type Description
$typeId
$linkName
methodpublichandleSpaces(  $path ) : void
inherited

Inherited from: \CMISRepositoryWrapper::handleSpaces()
Parameters
Name Type Description
$path
methodpublicmoveObject(  $objectId,  $targetFolderId,  $sourceFolderId,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$targetFolderId
$sourceFolderId
$options
methodpublicpostObject(  $folderId,  $objectName,  $objectType,  $properties = array (),  $content = null,  $content_type = "application/octet-stream",  $options = array () ) : void

Parameters
Name Type Description
$folderId
$objectName
$objectType
$properties
$content
$content_type
$options
methodpublicprocessPropertyTemplates(  $objectType,  $propMap ) : void

Parameters
Name Type Description
$objectType
$propMap
methodpublicprocessTemplate(  $template,  $values = array () ) : void
staticinherited

Inherited from: \CMISRepositoryWrapper::processTemplate()
Parameters
Name Type Description
$template
$values
methodpublicquery(  $statement,  $options = array () ) : void

Parameters
Name Type Description
$statement
$options
methodpublicremoveObjectFromFolder( ) : void

methodpublicremovePolicy( ) : void

methodpublicsetContentStream(  $objectId,  $content,  $content_type,  $options = array () ) : void

Parameters
Name Type Description
$objectId
$content
$content_type
$options
methodpublicupdateProperties(  $objectId,  $properties = array (),  $options = array () ) : void

Parameters
Name Type Description
$objectId
$properties
$options

\CmisConstraintException

Package:
Parent(s)
\Exception

\CmisInvalidArgumentException

Package:
Parent(s)
\Exception

\CmisNotSupportedException

Package:
Parent(s)
\Exception

\CmisObjectNotFoundException

Package:
Parent(s)
\Exception

\CmisPermissionDeniedException

Package:
Parent(s)
\Exception

\CmisRuntimeException

Package:
Parent(s)
\Exception
Documentation was generated by DocBlox 0.18.1.