PHP Класс Scalr\Model\Entity\EventDefinition

С версии: 5.0 (08.05.2014)
Автор: Igor Vodiasov ([email protected])
Наследование: extends Scalr\Model\AbstractEntity, implements Scalr\DataType\ScopeInterface, implements Scalr\DataType\AccessPermissionsInterface
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$accountId integer The identifier of the client's account
$created DateTime Time when the record is created
$description string Description
$envId integer The identifier of the client's environment
$id integer ID
$name string Event's name

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

Метод Описание
__construct ( ) Constructor
getList ( integer $accountId, integer $envId ) : array Gets the list of the events by specified criteria
getScope ( )
getUsed ( integer $accountId = null, integer $envId = null ) : array | false Checks whether the Event exists
hasAccessPermissions ( $user, $environment = null, $modify = null )
isExist ( string $name, integer $accountId, integer $envId ) : boolean Checks whether the event with the specified name exists

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

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

Constructor
public __construct ( )

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

Gets the list of the events by specified criteria
public static getList ( integer $accountId, integer $envId ) : array
$accountId integer
$envId integer
Результат array [name => description]

getScope() публичный метод

См. также: Scalr\DataType\ScopeInterface::getScope()
public getScope ( )

getUsed() публичный метод

Checks whether the Event exists
public getUsed ( integer $accountId = null, integer $envId = null ) : array | false
$accountId integer optional Identifier of the account
$envId integer optional Identifier of the environment
Результат array | false Returns FALSE if the Event does not exist on account or Array otherwise. Array looks like ['rolesCount' => N, 'farmRolesCount' => M, 'webhooksCount' => Z, 'accountScriptsCount' => K]

hasAccessPermissions() публичный метод

См. также: Scalr\DataType\AccessPermissionsInterface::hasAccessPermissions()
public hasAccessPermissions ( $user, $environment = null, $modify = null )

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

Checks whether the event with the specified name exists
public static isExist ( string $name, integer $accountId, integer $envId ) : boolean
$name string The name of the Event
$accountId integer Identifier of the account
$envId integer Identifier of the environment
Результат boolean Returns true if the Event exists or false otherwise

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

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

The identifier of the client's account
public int $accountId
Результат integer

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

Time when the record is created
public DateTime $created
Результат DateTime

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

Description
public string $description
Результат string

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

The identifier of the client's environment
public int $envId
Результат integer

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

ID
public int $id
Результат integer

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

Event's name
public string $name
Результат string