Documentation

SceneTemplate
in package
Uses UserAssignable

Class SceneTemplates.

Tags
Entity
Table

("scene_templates")

Table of Contents

$class  : string
$module  : string
$userAssignable  : bool
$owningScenes  : Collection
$owningViewpoints  : Collection
__construct()  : mixed
SceneTemplates constructor.
getClass()  : string
getModule()  : string
getOwningScenes()  : Collection
getOwningViewpoints()  : Collection
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
Id

@Column(type="string", length=255, unique=True, name="class")

$module

protected string $module
Tags
Column

(type="string", length=255, name="module")

$userAssignable

protected bool $userAssignable = true
Tags
Column

(type="boolean", options={"default"=true})

$owningScenes

private Collection $owningScenes
Tags
OneToMany

(targetEntity="Scene", mappedBy="template")

$owningViewpoints

private Collection $owningViewpoints
Tags
OneToMany

(targetEntity="Viewpoint", mappedBy="template", fetch="EXTRA_LAZY")

Methods

__construct()

SceneTemplates constructor.

public __construct(string $class, string $module[, bool $userAssignable = true ]) : mixed
Parameters
$class : string

FQCN of the scene handling class.

$module : string

Module from where the class is from.

$userAssignable : bool = true

Set to false to flag the scene as not-assignable for the user.

Tags
throws
ArgumentException
throws
ClassNotFoundException
Return values
mixed —

getClass()

public getClass() : string
Return values
string —

The class name of the template.

getModule()

public getModule() : string
Return values
string —

getOwningScenes()

public getOwningScenes() : Collection
Return values
Collection —

getOwningViewpoints()

public getOwningViewpoints() : Collection
Return values
Collection —

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
Return values
mixed —

Search results