• Accueil
• Scalr
• Model
• Entity
• Role

PHP Class Scalr\Model\Entity\Role

Afficher le fichier Open project: scalr/scalr Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$accountId	integer	It is set when the Role is from account scope
$added	DateTime	The timestamp when the Role was added
$addedByEmail	integer	The email address of the User who added the Role
$addedByUserId	integer	The identifier of the User who added the Role
$behaviors	string	The list of the supported behaviors
$catId	integer	Identifier of the category
$description	string	The description
$envId	integer	It is set when the Role is from environment scope
$generation	integer	The generation
$id	integer	The identifier of the Role
$isDeprecated	boolean	Whether the role is deprecated
$isDevelopment	boolean	Whether it is development Role
$isQuickStart	boolean	Whether it is QuickStart Role
$isScalarized	boolean	Whether it is Scalarized Role
$lastUsed	DateTime	The timestamp when the Role was used last time
$name	string	The name of the role
$origin	string
$osId	string	The identifier of the OS

Protected Properties

Свойство	Type	Description
$behaviorsOverlaps	array	Rules of behavior compatibility Implies that the DB behaviors is mutually exclusive
$dbBehaviors	array	List of DB behaviors It is used to generate mutually exclusive rules of behavior compatibility

Méthodes publiques

Méthode	Description
__construct ( )	Constructor
fetchImagesArray ( ) : array	Gets the list of the Images which correspond to the Role
getAllowedEnvironments ( ) : array	Return array of environments where this role is allowed explicitly.
getBehaviors ( ) : string[]	Gets role behaviors list
getBehaviorsConflicts ( array $behaviors ) : array	Checks given set of behaviors on compatibility
getDbMsrBehavior ( ) : boolean | string	If role has any database behavior, it will return behavior's name
getFarmsCount ( integer $accountId = null, integer $envId = null ) : integer	Gets the number of Farms which are using this Role
getImage ( $platform, $cloudLocation ) : RoleImage	Finds out the Image that corresponds to the Role by the specified criteria
getImages ( array $criteria = null, array $group = null, array $order = null, integer $limit = null, integer $offset = null, boolean $countRecords = null ) : EntityIterator	Gets Images which are associated with the Role
getOs ( ) : Os	Gets the Os entity which corresponds to the Role
getScope ( )
getScripts ( ) : array	Get scripts of the Role TODO refactor this method to new Entities
getServersCount ( string $accountId = null, string $envId = null ) : integer	Get the number of Servers which are using this Role
hasAccessPermissions ( $user, $environment = null, $modify = null )
hasBehavior ( string $behavior ) : boolean	Check if role has behavior
hasDbBehavior ( ) : boolean	Check if Role has database behavior
isNameUsed ( string $name, integer $accountId, integer $envId, integer $ignoreRoleId = null ) : boolean	Check if given name is used on scalr, account or environment scopes
isUsed ( ) : boolean	Checks whether the Role is already used in some Farm
isValidName ( string $name ) : boolean	Validates the name
save ( )
setBehaviors ( array | JsonData $behaviors )	Sets role behaviors
setImage ( string $platform, string $cloudLocation, string $imageId, integer $userId, string $userEmail )	Add, replace or remove image in role
setScripts ( array $scripts )	Set scripts of the Role TODO refactor this method to new Entities

Method Details

Property Details