PHP Класс DBFarmRole

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

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

Свойство Тип Описание
$Alias NOTE: Settings constants moved to Entity\FarmRoleSetting
$CloudLocation NOTE: Settings constants moved to Entity\FarmRoleSetting
$FarmID NOTE: Settings constants moved to Entity\FarmRoleSetting
$ID NOTE: Settings constants moved to Entity\FarmRoleSetting
$LaunchIndex NOTE: Settings constants moved to Entity\FarmRoleSetting
$Platform NOTE: Settings constants moved to Entity\FarmRoleSetting
$RoleID NOTE: Settings constants moved to Entity\FarmRoleSetting

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

Метод Описание
ClearSettings ( $filter = "" )
GetAllSettings ( ) : unknown_type Returns all role settings
GetFarmObject ( ) : DBFarm Returns DBFarm Object
GetPendingInstancesCount ( )
GetRoleID ( ) : string Returns role prototype
GetRoleObject ( ) : DBRole
GetRunningInstancesCount ( )
GetServersByFilter ( $filter_args = [], $ufilter_args = [] )
GetServiceConfiguration2 ( $behavior )
GetSetting ( string $name ) : mixed Get Role setting by name
GetSettingsByFilter ( $filter = "" )
GetSuspendedInstancesCount ( )
Load ( $farmid, $roleid, $cloudLocation ) : DBFarmRole Load DBInstance by database id
LoadByID ( $id ) : DBFarmRole Returns DBFarmRole object by id
Save ( )
SetScripts ( array $scripts, array $params = [] )
SetServiceConfiguration ( $behavior, $config )
SetSetting ( string $name, string | null $value, string $type = null ) : void Set farm role setting
__construct ( $farm_roleid ) : void Constructor
__sleep ( )
__wakeup ( )
applyDefinition ( $definition, $reset = false )
applyGlobalVarsToValue ( $value ) : string Apply FarmRole global variables to a value
getChefSettings ( )
getDefinition ( )
getFarmStatus ( ) : integer | null Gets the status of the farm which corresponds to the farm role
getInstanceType ( ) : mixed Returns instance type id
getReplacementRoles ( $includeSelf = false )
getStorage ( ) : Scalr\Farm\Role\FarmRoleStorage
isCloudstack ( )
isOpenstack ( )

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

Метод Описание
Unbind ( )

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

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

public ClearSettings ( $filter = "" )

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

Returns all role settings
public GetAllSettings ( ) : unknown_type
Результат unknown_type

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

Returns DBFarm Object
public GetFarmObject ( ) : DBFarm
Результат DBFarm

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

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

Returns role prototype
public GetRoleID ( ) : string
Результат string

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

public GetRoleObject ( ) : DBRole
Результат DBRole

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

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

public GetServersByFilter ( $filter_args = [], $ufilter_args = [] )

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

public GetServiceConfiguration2 ( $behavior )

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

Get Role setting by name
public GetSetting ( string $name ) : mixed
$name string
Результат mixed

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

public GetSettingsByFilter ( $filter = "" )

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

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

Load DBInstance by database id
public static Load ( $farmid, $roleid, $cloudLocation ) : DBFarmRole
Результат DBFarmRole

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

Returns DBFarmRole object by id
public static LoadByID ( $id ) : DBFarmRole
$id
Результат DBFarmRole

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

public Save ( )

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

public SetScripts ( array $scripts, array $params = [] )
$scripts array
$params array

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

public SetServiceConfiguration ( $behavior, $config )

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

Set farm role setting
public SetSetting ( string $name, string | null $value, string $type = null ) : void
$name string The name of the setting
$value string | null The value of the setting
$type string optional
Результат void

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

Constructor
public __construct ( $farm_roleid ) : void
Результат void

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

public __sleep ( )

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

public __wakeup ( )

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

public applyDefinition ( $definition, $reset = false )

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

Apply FarmRole global variables to a value
public applyGlobalVarsToValue ( $value ) : string
Результат string

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

public getChefSettings ( )

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

public getDefinition ( )

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

Gets the status of the farm which corresponds to the farm role
public getFarmStatus ( ) : integer | null
Результат integer | null Returns the status of the farm which corresponds to the farm role. It returns NULL if farm does not exist.

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

Returns instance type id
public getInstanceType ( ) : mixed
Результат mixed

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

public getReplacementRoles ( $includeSelf = false )

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

public getStorage ( ) : Scalr\Farm\Role\FarmRoleStorage
Результат Scalr\Farm\Role\FarmRoleStorage

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

public isCloudstack ( )

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

public isOpenstack ( )

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

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $Alias

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $CloudLocation

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $FarmID

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $ID

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $LaunchIndex

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $Platform

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

NOTE: Settings constants moved to Entity\FarmRoleSetting
public $RoleID