ExportAccounts Class Reference

Collaboration diagram for ExportAccounts:

Public Member Functions
	setSearchAccount (\SearchAccount $s)
	export ()
	setExportSchemaDirectory ($exportSchemaDirectory)
	setSessionKey ($sessionKey)
	abortSession ()
	isAborted ()
	getSessionMessage ()
	setExportCryptedPassword ($exportCryptedPassword)
	setExportGroupParent ($exportGroupParent)
	setExportDocument ($exportDocument)
	setExportRoleParent ($exportRoleParent)

Data Fields
const	ABORTORDER = "::ABORT::"
const	XSDDIR = "XSD"

Protected Member Functions
	setSessionMessage ($text)
	getDepthLevel ($groupIdentifier, $tree)
	clearInfo ()
	initXml ()
	memoDocumentInfo (\Account $user)
	addDocumentNodes ()
	writeCommonSchema ()
	addUserAccount (\Account $user)
	addGroupAccount (\Account $group)
	addRoleAccount (\Account $role)

Static Protected Member Functions
static	xpathLiteral ($str)

Protected Attributes
	$search = null
	$xml
	$sessionKey = ''
	$exportCryptedPassword = false
	$exportGroupParent = false
	$exportRoleParent = false
	$exportDocument = false
	$exportSchemaDirectory = ""
	$aborted = false
	$documentInfo = array()

Detailed Description

Definition at line 9 of file ExportAccounts.php.

Member Function Documentation

abortSession

(

)

Abort current export session

Definition at line 150 of file ExportAccounts.php.

addDocumentNodes ( )

protected

Add document node for each recorded account

Exceptions

\Dcp\Exception

Definition at line 350 of file ExportAccounts.php.

Here is the call graph for this function:

addGroupAccount ( \Account  $group )

protected

Add group node info

Parameters

\Account

$group

Definition at line 654 of file ExportAccounts.php.

Here is the call graph for this function:

addRoleAccount ( \Account  $role )

protected

Add role node info

Parameters

\Account

$role

Definition at line 675 of file ExportAccounts.php.

Here is the call graph for this function:

addUserAccount ( \Account  $user )

protected

Add User node info

Parameters

\Account

$user

Exceptions

\Dcp\Db\Exception

Definition at line 608 of file ExportAccounts.php.

Here is the call graph for this function:

clearInfo ( )

protected

Remove empty tags

Definition at line 277 of file ExportAccounts.php.

export

(

)

Return account exportation based on SearchAccount object

Returns

string the XML result

Exceptions

Exception

Definition at line 71 of file ExportAccounts.php.

Here is the call graph for this function:

getDepthLevel (   $groupIdentifier,   $tree  )

protected

Definition at line 264 of file ExportAccounts.php.

getSessionMessage

(

)

Definition at line 177 of file ExportAccounts.php.

initXml ( )

protected

Definition at line 319 of file ExportAccounts.php.

isAborted

(

)

Returns

boolean

Definition at line 160 of file ExportAccounts.php.

memoDocumentInfo ( \Account  $user )

protected

Record document to add These record are processed in one time at the end of export

See Also

addDocumentNodes

Parameters

\Account

$user

Definition at line 342 of file ExportAccounts.php.

setExportCryptedPassword

(

$exportCryptedPassword

)

Set to true to export crypted password (default is false)

Parameters

bool

$exportCryptedPassword

Definition at line 291 of file ExportAccounts.php.

setExportDocument

(

$exportDocument

)

Set to true to export document information about account (default is false)

Parameters

bool

$exportDocument

Definition at line 307 of file ExportAccounts.php.

setExportGroupParent

(

$exportGroupParent

)

Set to true to export parent group definition for user accounts (default is false)

Parameters

bool

$exportGroupParent

Definition at line 299 of file ExportAccounts.php.

setExportRoleParent

(

$exportRoleParent

)

Set to true to export relative roles for group and user accounts (default is false)

Parameters

bool

$exportRoleParent

Definition at line 315 of file ExportAccounts.php.

setExportSchemaDirectory

(

$exportSchemaDirectory

)

Parameters

string

$exportSchemaDirectory

Exceptions

Exception

Definition at line 126 of file ExportAccounts.php.

setSearchAccount

(

\SearchAccount

$s

)

Define accounts to exports

Parameters

\SearchAccount

$s

Definition at line 62 of file ExportAccounts.php.

Here is the call graph for this function:

setSessionKey

(

$sessionKey

)

Parameters

string

$sessionKey

Definition at line 143 of file ExportAccounts.php.

setSessionMessage (   $text )

protected

Definition at line 164 of file ExportAccounts.php.

writeCommonSchema ( )

protected

Definition at line 405 of file ExportAccounts.php.

static xpathLiteral (   $str )

staticprotected

Convert a string to an XPath literal

If the string contains an apostrophe, then a concat() is used to construct the string literal expression.

If no apostrophe is found, then quote the string with apostrophes.

Parameters

$str

Returns

string

Definition at line 701 of file ExportAccounts.php.

Field Documentation

$aborted = false

protected

Definition at line 53 of file ExportAccounts.php.

$documentInfo = array()

protected

Definition at line 55 of file ExportAccounts.php.

$exportCryptedPassword = false

protected

Definition at line 41 of file ExportAccounts.php.

$exportDocument = false

protected

Definition at line 51 of file ExportAccounts.php.

$exportGroupParent = false

protected

Definition at line 49 of file ExportAccounts.php.

$exportRoleParent = false

protected

Definition at line 50 of file ExportAccounts.php.

$exportSchemaDirectory = ""

protected

Definition at line 52 of file ExportAccounts.php.

$search = null

protected

Definition at line 14 of file ExportAccounts.php.

$sessionKey = ''

protected

Definition at line 40 of file ExportAccounts.php.

$xml

protected

Definition at line 34 of file ExportAccounts.php.

const ABORTORDER = "::ABORT::"

Definition at line 47 of file ExportAccounts.php.

const XSDDIR = "XSD"

Definition at line 48 of file ExportAccounts.php.

---

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

• ExportAccounts.php