This project has retired. For details please refer to its Attic page.
phpDocumentor » \CMISService
phpDocumentor
Back to top  

CMIS Service

api CMIS
since CMIS-1.0

 Methods

Construct a new CMISService Connector

__construct(String $url, String $username, String $password, mixed[] $options, array $addlCurlOptions) 
API
api CMIS-Service
since CMIS-1.0

Parameters

$url

String

Endpoint URL

$username

String

Username

$password

String

Password

$options

mixed[]

Connection Options

$addlCurlOptions

mixed[]

Additional CURL Options

addObjectToFolder() 

addObjectToFolder($objectId, $targetFolderId, $options) 

Parameters

$objectId

$targetFolderId

$options

Append Content to an Objects Content Stream

appendContentStream(String $objectId, String $content, String $content_type, mixed[] $options) 
API
returns Object
api CMIS-ObjectServices-NotImplemented
since CMIS-1.0

Parameters

$objectId

String

Object ID

$content

String

Content to be appended

$content_type

String

Content Mime Type

$options

mixed[]

Options

applyACL() 

applyACL() 

applyPolicy() 

applyPolicy() 

bulkUpdateProperties() 

bulkUpdateProperties() 

Cancel Checkout

cancelCheckOut(String $objectId, mixed[] $options) 
API
api CMIS-VersionServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$options

mixed[]

Options

Checkin

checkIn(String $objectId, mixed[] $options) : Object
API
api CMIS-VersionServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$options

mixed[]

Options

Returns

ObjectThe checked in object

Checkout

checkOut(String $objectId, mixed[] $options) : Object
API
api CMIS-VersionServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$options

mixed[]

Options

Returns

ObjectThe working copy

createDocument() 

createDocument($folderId, $fileName, $properties, $content, $content_type, $options) 

Parameters

$folderId

$fileName

$properties

$content

$content_type

$options

createDocumentFromSource() 

createDocumentFromSource() 

createFolder() 

createFolder($folderId, $folderName, $properties, $options) 

Parameters

$folderId

$folderName

$properties

$options

createItem() 

createItem() 

createPolicy() 

createPolicy() 

createRelationship() 

createRelationship() 

Creates a new type definition.

createType(String $objectType) 
API

Creates a new type definition that is a subtype of an existing specified parent type. Only properties that are new to this type (not inherited) are passed to this service.

returns Object Type Definition of the Specified Object
api CMIS-RepositoryServices-NotImplemented
since CMIS-1.1

Parameters

$objectType

String

A type definition object with the property definitions that are to change.

deleteAllVersions() 

deleteAllVersions() 

Delete an Objects Content Stream

deleteContentStream(String $objectId, mixed[] $options) 
API
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$options

mixed[]

Options

Delete an Object

deleteObject(String $objectId, mixed[] $options) 
API
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$options

mixed[]

Options

Delete an Object Tree

deleteTree(String $folderId, mixed[] $options) : Object[]
API
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$folderId

String

Folder Object ID

$options

mixed[]

Options

Returns

Object[]Array of problem objects

Deletes a type definition

deleteType(String $typeId) 
API

If there are object instances present of the type being deleted then this operation MUST fail.

api CMIS-RepositoryServices-NotImplemented
since CMIS-1.1

Parameters

$typeId

String

The typeId of an object-type specified in the repository.

getACL() 

getACL() 

getAllVersions() 

getAllVersions() 

Get an Object's Allowable Actions

getAllowableActions(String $objectId, mixed[] $options) 
API
returns mixed[]
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object Id

$options

mixed[]

Options

getAppliedPolicies() 

getAppliedPolicies() 

Get the list of documents that are checked out that the user has access to.

getCheckedOutDocs($options) 
API

.

returns Object[] list of checked out documents.
api CMIS-NavigationServices
since CMIS-1.0

Parameters

$options

Get the list of child objects contained in the specified folder.

getChildren(String $folderId, $options) 
API
returns Object[] A list of the child objects for the specified folder.
api CMIS-NavigationServices
since CMIS-1.0

Parameters

$folderId

String

the Object ID of the folder

$options

Get Content Changes

getContentChanges(mixed[] $options) 
API
returns Object[] List of Change Events
api CMIS-DiscoveryServices
since CMIS-1.0

Parameters

$options

mixed[]

Options

Get an Object's Allowable Actions

getContentStream(String $objectId, mixed[] $options) 
API
returns String
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object Id

$options

mixed[]

Options

Get the list of descendant objects contained in the specified folder.

getDescendants(String $folderId, String $depth, $options) 
API
returns Object[] A tree of the child objects for the specified folder.
api CMIS-NavigationServices
since CMIS-1.0

Parameters

$folderId

String

the Object ID of the folder

$depth

String

The number of levels of depth in the folder hierarchy from which to return results (-1 == ALL).

$options

Get the parent folder of the specified folder.

getFolderParent(String $folderId, $options) 
API
returns Object the parent folder.
api CMIS-NavigationServices
since CMIS-1.0

Parameters

$folderId

String

the Object ID of the folder

$options

Get the list of descendant folders contained in the specified folder.

getFolderTree(String $folderId, String $depth, $options) 
API
returns Object[] A tree of the child objects for the specified folder.
api CMIS-NavigationServices
since CMIS-1.0

Parameters

$folderId

String

the Object ID of the folder

$depth

String

The number of levels of depth in the folder hierarchy from which to return results (-1 == ALL).

$options

getLastRequest() 

getLastRequest() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequest()

getLastRequestBody() 

getLastRequestBody() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestBody()

getLastRequestCode() 

getLastRequestCode() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestCode()

getLastRequestContentLength() 

getLastRequestContentLength() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestContentLength()

getLastRequestContentSent() 

getLastRequestContentSent() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestContentSent()

getLastRequestContentType() 

getLastRequestContentType() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestContentType()

getLastRequestContentTypeSent() 

getLastRequestContentTypeSent() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestContentTypeSent()

getLastRequestMethod() 

getLastRequestMethod() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestMethod()

getLastRequestURL() 

getLastRequestURL() 
Inherited
inherited_from \CMISRepositoryWrapper::getLastRequestURL()

Get an Object's property and return it as an array

getMultiValuedProp(Object $obj, String $propName) 
API

This returns an array even if it is a scalar or null

todo Allow the getProperty method to query the object type information and return multivalue properties as arrays even if empty or if only a single value is present.
returns mixed[]
api CMIS-Helper
since CMIS-1.0

Parameters

$obj

Object

Object

$propName

String

Property Name

Get an Object by Object Id

getObject(String $objectId, mixed[] $options) 
API
returns Object
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$options

mixed[]

Options

Get an Object by its Path

getObjectByPath(String $path, mixed[] $options) 
API
returns Object
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$path

String

Path To Object

$options

mixed[]

Options

getObjectOfLatestVersion() 

getObjectOfLatestVersion($objectId, $major, $options) 

Parameters

$objectId

$major

$options

Get the parent folder(s) for the specified fileable object.

getObjectParents(String $objectId, $options) 
API
returns Object[] list of the parent folder(s) of the specified object.
api CMIS-NavigationServices
since CMIS-1.0

Parameters

$objectId

String

the Object ID of the Object

$options

getObjectRelationships() 

getObjectRelationships() 

Get an Object's Property Type by Object Id

getObjectTypeDefinition(String $objectId) 
API
returns Object Type Definition of the Specified Object
api CMIS-Helper
since CMIS-1.0

Parameters

$objectId

String

Object Id

Get an Object's Properties by Object Id

getProperties(String $objectId, mixed[] $options) 
API
returns Object
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object Id

$options

mixed[]

Options

getPropertiesOfLatestVersion() 

getPropertiesOfLatestVersion($objectId, $major, $options) 

Parameters

$objectId

$major

$options

Get the list of associated renditions for the specified object

getRenditions(String $objectId, mixed[] $options) 
API

Only rendition attributes are returned, not rendition stream.

returns Object[]
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object Id

$options

mixed[]

Options

Get an Object by Object Id

getRepositories() 
API
api CMIS-RepositoryServices-NotImplemented
since CMIS-1.0

Get Repository Information

getRepositoryInfo() 
API
returns Object
api CMIS-RepositoryServices
since CMIS-1.0

Get a list of object-types that are children of the specified type

getTypeChildren(String $typeId, $options) 
API

If typeId is null, then the repository MUST return all base object-types.

returns Object The list of child object-types defined for the given typeId.
api CMIS-RepositoryServices
since CMIS-1.0

Parameters

$typeId

String

The typeId of an object-type specified in the repository

$options

Gets the definition of the specified object-type.

getTypeDefinition(String $typeId, $options) 
API
returns Object Type Definition of the Specified Object
api CMIS-RepositoryServices
since CMIS-1.0

Parameters

$typeId

String

Object Type Id

$options

Get a set of object-types that are descendants of the specified type

getTypeDescendants(String $typeId, $depth, $options) 
API

If typeId is null, then the repository MUST return all types and ignore the depth parameter.

returns Object The set of descendant object-types defined for the given typeId.
api CMIS-RepositoryServices
since CMIS-1.0

Parameters

$typeId

String

The typeId of an object-type specified in the repository

$depth

the number of levels in the hierarchy to return (-1 == all)

$options

moveObject() 

moveObject($objectId, $targetFolderId, $sourceFolderId, $options) 

Parameters

$objectId

$targetFolderId

$sourceFolderId

$options

Execute a CMIS Query

query(String $statement, mixed[] $options) 
API
returns Object[] List of object propery values from query
api CMIS-DiscoveryServices
since CMIS-1.0

Parameters

$statement

String

Query Statement

$options

mixed[]

Options

removeObjectFromFolder() 

removeObjectFromFolder($objectId, $targetFolderId, $options) 

Parameters

$objectId

$targetFolderId

$options

removePolicy() 

removePolicy() 

Set an Objects Content Stream

setContentStream(String $objectId, String $content, String $content_type, mixed[] $options) 
API
returns Object
api CMIS-ObjectServices
since CMIS-1.0

Parameters

$objectId

String

Object ID

$content

String

Content to be appended

$content_type

String

Content Mime Type

$options

mixed[]

Options

updateProperties() 

updateProperties($objectId, $properties, $options) 

Parameters

$objectId

$properties

$options

Updates a type definition

updateType(String $objectType) 
API

If you add an optional property to a type in error. There is no way to remove it/correct it - without deleting the type.

returns Object The updated object-type including all property definitions.
api CMIS-RepositoryServices-NotImplemented
since CMIS-1.1

Parameters

$objectType

String

A type definition object with the property definitions that are to change.