DomainApi Class Reference

Collaboration diagram for DomainApi:

Public Member Functions
	__construct (Dir &$domain=null)
	getUserMode ()
	bookDocument ($config)
	unbookDocument ($config)
	revertDocument ($config)
	insertUserDocument ($config)
	removeUserDocument ($config)
	insertSharedDocument ($config)
	removeSharedDocument ($config)
	getAvailableFamilies ()
	clearUserDocuments ()
	clearSharedDocuments ()
	getUserDocuments ($config, $callback=null)
	getSharedDocuments ($config, $callback=null)
	getReservedDocumentIds ()
	sync ()
	view ()

Static Public Member Functions
static	getDomains ()

Detailed Description

Definition at line 17 of file Class.DomainApi.php.

Constructor & Destructor Documentation

__construct

(

Dir &

$domain = null

)

Definition at line 24 of file Class.DomainApi.php.

Member Function Documentation

bookDocument

(

$config

)

book document into user space

Returns

Fdl_Document

Definition at line 69 of file Class.DomainApi.php.

clearSharedDocuments

(

)

delete all documents from user folder

Returns

void

Definition at line 297 of file Class.DomainApi.php.

clearUserDocuments

(

)

delete all documents from user folder

Returns

void

Definition at line 281 of file Class.DomainApi.php.

getAvailableFamilies

(

)

return families restriction

Returns

DocumentList of families

Definition at line 247 of file Class.DomainApi.php.

static getDomains ( )

static

List all domain availables by current user

Returns

object document List

Definition at line 36 of file Class.DomainApi.php.

Here is the call graph for this function:

getReservedDocumentIds

(

)

get document locked by user

Returns

DocumentList

Definition at line 428 of file Class.DomainApi.php.

getSharedDocuments	(		$config,
			$callback = null
	)

get share folder documents

Parameters

function

$callback

filter on documents

Returns

DocumentList

Definition at line 347 of file Class.DomainApi.php.

getUserDocuments	(		$config,
			$callback = null
	)

get user folder documents

Parameters

function

$callback

filter on documents

Returns

DocumentList

Definition at line 314 of file Class.DomainApi.php.

getUserMode

(

)

user mode

Returns

stdClass ->userMode : advanced or standard

Definition at line 52 of file Class.DomainApi.php.

insertSharedDocument

(

$config

)

put document into user space read only

Returns

Fdl_Document

Definition at line 205 of file Class.DomainApi.php.

insertUserDocument

(

$config

)

put document into user space read only

Returns

Fdl_Document

Definition at line 163 of file Class.DomainApi.php.

removeSharedDocument

(

$config

)

remove document from user space read only

Returns

Fdl_Document

Definition at line 226 of file Class.DomainApi.php.

removeUserDocument

(

$config

)

remove document from user space read only

Returns

Fdl_Document

Definition at line 184 of file Class.DomainApi.php.

revertDocument

(

$config

)

revert document

Returns

Fdl_Document

Definition at line 112 of file Class.DomainApi.php.

sync

(

)

return object sync

Returns

DomainSyncApi

Definition at line 447 of file Class.DomainApi.php.

unbookDocument

(

$config

)

unbook document into user space

Returns

Fdl_Document

Definition at line 92 of file Class.DomainApi.php.

view

(

)

return object sync

Returns

DomainViewApi

Definition at line 457 of file Class.DomainApi.php.

---

The documentation for this class was generated from the following file:

• Class.DomainApi.php