SceneAttachment
in package
Uses
UserAssignable
A SceneAttachment is a registered Attachment class to keep track of (a) generally all available attachments, and (b) which scene contains which attachment.
Tags
Table of Contents
- $class : string
- $title : string
- $userAssignable : bool
- $scenes : Collection|null
- __construct() : mixed
- SceneAttachment constructor.
- getClass() : string
- getScenes() : Collection
- getTitle() : string
- isUserAssignable() : bool
- setUserAssignable() : mixed
- Changes whether the template should be able to get manually assigned to a template or not.
Properties
$class
protected
string
$class
Tags
$title
protected
string
$title
Tags
$userAssignable
protected
bool
$userAssignable
= true
Tags
$scenes
private
Collection|null
$scenes
Tags
Methods
__construct()
SceneAttachment constructor.
public
__construct(string $class, string $title[, bool $userAssignable = true ]) : mixed
Parameters
- $class : string
-
A class inheriting from AttachmentInterface.
- $title : string
- $userAssignable : bool = true
Tags
Return values
mixed —getClass()
public
getClass() : string
Return values
string —getScenes()
public
getScenes() : Collection
Return values
Collection —getTitle()
public
getTitle() : string
Return values
string —isUserAssignable()
public
isUserAssignable() : bool
Return values
bool —setUserAssignable()
Changes whether the template should be able to get manually assigned to a template or not.
public
setUserAssignable([bool $flag = true ]) : mixed
Parameters
- $flag : bool = true