PHP Класс Scalr_Scripting_GlobalVariables

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$configurationVars array Array of predefined constants, which change default UI behavior This data should be synchronized with /core/variablefield.js
$configurationVarsDefaults array Default values for UI config vars
$doNotValidateNameCaseSensitivity boolean This flag was developed for old API. If it's true and CaseSensitivity validation was failed, we log message to SystemLog instead of Exception. If should be removed in next major version of Scalr.

Открытые методы

Метод Описание
__construct ( integer $accountId, integer $envId, string $scope = ScopeInterface::SCOPE_SCALR )
_getValues ( integer $roleId, integer $farmId, integer $farmRoleId, string $serverId = '' ) : array
getErrorMessage ( ) : string Return first error message from set of validation errors
getUiDefaults ( ) : array Return default configuration vars for UI as name => value
getValues ( $roleId, $farmId, $farmRoleId, $serverId = '' )
listServerGlobalVariables ( DBServer $dbServer, $includeSystem = false, AbstractServerEvent $event = null )
listVariables ( $roleId, $farmId, $farmRoleId, $serverId = '' )
setValues ( array | ArrayObject $variables, integer $roleId, integer $farmId, integer $farmRoleId, string $serverId = '', boolean $throwException = true, boolean $skipValidation = false ) : array | boolean
validateValues ( array | ArrayObject $variables, integer $roleId, integer $farmId, integer $farmRoleId, string $serverId = "" ) : array | boolean Validate values

Защищенные методы

Метод Описание
setError ( string $name, string $property, string $msg ) Set error (errors are saved to this->errors)

Приватные методы

Метод Описание
errorHandler ( integer $errno, string $errstr ) Callback function for set_error_handler

Описание методов

__construct() публичный Метод

public __construct ( integer $accountId, integer $envId, string $scope = ScopeInterface::SCOPE_SCALR )
$accountId integer
$envId integer
$scope string

_getValues() публичный Метод

public _getValues ( integer $roleId, integer $farmId, integer $farmRoleId, string $serverId = '' ) : array
$roleId integer
$farmId integer
$farmRoleId integer
$serverId string
Результат array Array of variables [name of variable => data]

getErrorMessage() публичный Метод

Return first error message from set of validation errors
public getErrorMessage ( ) : string
Результат string

getUiDefaults() публичный Метод

Return default configuration vars for UI as name => value
public getUiDefaults ( ) : array
Результат array

getValues() публичный Метод

public getValues ( $roleId, $farmId, $farmRoleId, $serverId = '' )

listServerGlobalVariables() публичный статический Метод

public static listServerGlobalVariables ( DBServer $dbServer, $includeSystem = false, AbstractServerEvent $event = null )
$dbServer DBServer
$event AbstractServerEvent

listVariables() публичный Метод

public listVariables ( $roleId, $farmId, $farmRoleId, $serverId = '' )

setError() защищенный Метод

Set error (errors are saved to this->errors)
protected setError ( string $name, string $property, string $msg )
$name string Name of variable
$property string Property of variable
$msg string Error message

setValues() публичный Метод

public setValues ( array | ArrayObject $variables, integer $roleId, integer $farmId, integer $farmRoleId, string $serverId = '', boolean $throwException = true, boolean $skipValidation = false ) : array | boolean
$variables array | ArrayObject
$roleId integer optional
$farmId integer optional
$farmRoleId integer optional
$serverId string optional
$throwException boolean optional
$skipValidation boolean optional
Результат array | boolean

validateValues() публичный Метод

Validate values
public validateValues ( array | ArrayObject $variables, integer $roleId, integer $farmId, integer $farmRoleId, string $serverId = "" ) : array | boolean
$variables array | ArrayObject
$roleId integer
$farmId integer
$farmRoleId integer
$serverId string
Результат array | boolean Returns true if no errors or array of errors [name of variable => [name of property => [errors]]

Описание свойств

$configurationVars публичное свойство

Array of predefined constants, which change default UI behavior This data should be synchronized with /core/variablefield.js
public array $configurationVars
Результат array

$configurationVarsDefaults публичное свойство

Default values for UI config vars
public array $configurationVarsDefaults
Результат array

$doNotValidateNameCaseSensitivity публичное свойство

This flag was developed for old API. If it's true and CaseSensitivity validation was failed, we log message to SystemLog instead of Exception. If should be removed in next major version of Scalr.
public bool $doNotValidateNameCaseSensitivity
Результат boolean