exportAccounts.php File Reference

Go to the source code of this file.

Variables
	$usage = new ApiUsage()
	$filename
	$schemaDirectory
	$memberAccount = null
	$memberOf
	$exportPassword = $usage->addEmptyParameter("crypt-password", "add crypt password")
	$exportRole = $usage->addEmptyParameter("roles", "export associated roles")
	$exportGroup = $usage->addEmptyParameter("groups", "export parent groups")
	$exportDocument = $usage->addEmptyParameter("document", "export specific document information")
	$type
	$filterLogin = $usage->addOptionalParameter("login-filter", "filter login contains")
	$export = new \Dcp\Core\ExportAccounts()
	$search = new SearchAccount()

Variable Documentation

$export = new \Dcp\Core\ExportAccounts()

Definition at line 74 of file exportAccounts.php.

$exportDocument = $usage->addEmptyParameter("document", "export specific document information")

Definition at line 54 of file exportAccounts.php.

$exportGroup = $usage->addEmptyParameter("groups", "export parent groups")

Definition at line 53 of file exportAccounts.php.

$exportPassword = $usage->addEmptyParameter("crypt-password", "add crypt password")

Definition at line 51 of file exportAccounts.php.

$exportRole = $usage->addEmptyParameter("roles", "export associated roles")

Definition at line 52 of file exportAccounts.php.

$filename

Initial value:

= $usage->addRequiredParameter("file", "the output file (use - for stdout)", function ($values, $argName, ApiUsage $apiusage)
{
    if ($values === ApiUsage::GET_USAGE) {
        return "";
    }
    if ($values !== "-" && is_file($values) && !is_writable($values)) {
        $apiusage->exitError(sprintf("Error: file output \"%s\" not writable.", $values));
    }
    return '';
})

PhpUnusedParameterInspection

Definition at line 11 of file exportAccounts.php.

$filterLogin = $usage->addOptionalParameter("login-filter", "filter login contains")

Definition at line 71 of file exportAccounts.php.

Account $memberAccount = null

Definition at line 35 of file exportAccounts.php.

$memberOf

Initial value:

= $usage->addOptionalParameter("memberOf", "Restrict to account which are member of this group or role reference", function ($values, $argName, ApiUsage $apiusage) use (&$memberAccount)
{
    if ($values) {
        if ($values === ApiUsage::GET_USAGE) {
            return "";
        }
        $memberAccount = new Account();
        if (!$memberAccount->setLoginName($values)) {
            $apiusage->exitError(sprintf("Error: member reference \"%s\" unknow.", $values));
        }
    }
    return '';
})

PhpUnusedParameterInspection

Definition at line 37 of file exportAccounts.php.

$schemaDirectory

Initial value:

= $usage->addOptionalParameter("schema-directory", "directory where produce xsd for documents", function ($values, $argName, ApiUsage $apiusage)
{
    if ($values === ApiUsage::GET_USAGE) {
        return "";
    }
    if ($values !== "-" && is_dir($values) && !is_writable($values)) {
        $apiusage->exitError(sprintf("Error: directory output \"%s\" not writable.", $values));
    }
    return '';
})

PhpUnusedParameterInspection

Definition at line 22 of file exportAccounts.php.

$search = new SearchAccount()

Definition at line 75 of file exportAccounts.php.

$type

Initial value:

= $usage->addOptionalParameter("type", "restricted to account type", function ($values, $argName, ApiUsage $apiusage)
{
    $opt = array(
        "user",
        "role",
        "group"
    );
    if ($values === ApiUsage::GET_USAGE) return sprintf(" [%s] ", implode('|', $opt));
    
    $error = $apiusage->matchValues($values, $opt);
    if ($error) {
        $apiusage->exitError(sprintf("Error: wrong value for argument 'type' : %s", $error));
    }
    return '';
})

PhpUnusedParameterInspection

Definition at line 56 of file exportAccounts.php.

$usage = new ApiUsage()

Definition at line 8 of file exportAccounts.php.