lib/profiles.inc
Properties
Description
This file provides functions to load and save account profiles.Functions
getAccountProfiles( string $scope, string $profile = null, ) : array
Description
Returns an array of string with all available profiles for the given account typeArguments
Name | Type | Description | Default |
---|---|---|---|
$scope | string | account type |
|
$profile | string | server profile name |
null |
Return value
Type | Description |
---|---|
array | profile names |
loadAccountProfile( string $profile, string $scope, ) : array
Description
Loads an profile of the given account typeArguments
Name | Type | Description | Default |
---|---|---|---|
$profile | string | name of the profile (without . |
|
$scope | string | account type |
Return value
Type | Description |
---|---|
array | hash array (attribute => value) |
saveAccountProfile( array $attributes, string $profile, string $scope, ) : boolean
Description
Saves an hash array (attribute => value) to an account profilefile is created, if needed
Arguments
Name | Type | Description | Default |
---|---|---|---|
$attributes | array | hash array (attribute => value) |
|
$profile | string | name of the account profile (without . |
|
$scope | string | account type |
Return value
Type | Description |
---|---|
boolean | true, if saving succeeded |
delAccountProfile( string $file, string $scope, ) : boolean
Description
Deletes an account profileArguments
Name | Type | Description | Default |
---|---|---|---|
$file | string | name of profile (Without . |
|
$scope | string | account type |
Return value
Type | Description |
---|---|
boolean | true if profile was deleted |
copyAccountProfiles( array $accountProfiles, String $scope, array $dests = array(), ) : boolean
Description
Copies account profiles to other server profiles.Arguments
Name | Type | Description | Default |
---|---|---|---|
$accountProfiles | array | account profile names |
|
$scope | String | account scope |
|
$dests | array | destinations |
array() |
Return value
Type | Description |
---|---|
boolean | operation succeeded |