DealStageColorScheme extends PhaseColorScheme
Table of Contents
Constants
- FAILURE_COLOR = '#FF5752'
- PROCESS_COLOR = '#39A8EF'
- PROCESS_COLORS = array('#39A8EF', '#2FC6F6', '#55D0E0', '#47E4C2', '#FFA900')
- SUCCESS_COLOR = '#7BD500'
Methods
- __construct() : mixed
- addElement() : void
- Add element
- externalize() : array<string|int, mixed>
- Get external representation of this object
- fillDefaultColors() : array<string|int, mixed>
- getByCategory() : DealStageColorScheme
- Get scheme by category
- getByName() : mixed
- getCategoryId() : int
- Get Deal category ID
- getCurrent() : DealStageColorScheme
- Get current scheme (for default category)
- getDefaultColor() : string
- Get default color for element.
- getDefaultColorBySemantics() : string
- Get default element color by semantic ID.
- getDefaultColorByStage() : string
- Get default element color by semantic ID.
- getElementByName() : PhaseColorSchemeElement|null
- Get scheme element by name.
- getElementNames() : array<string|int, mixed>
- Get Element Names
- getName() : mixed
- getStageNames() : array<string|int, mixed>
- Get Stage Names for specified category.
- internalize() : void
- Setup this object from external representation.
- isPersistent() : bool
- load() : bool
- Try to load scheme from options
- remove() : void
- Remove scheme from options
- removeByCategory() : bool
- Remove scheme by category.
- reset() : mixed
- Reset scheme.
- resolveCategoryByName() : mixed
- save() : void
- Save scheme to options
- setupByDefault() : void
- Setup scheme by default
Constants
FAILURE_COLOR
public
mixed
FAILURE_COLOR
= '#FF5752'
PROCESS_COLOR
public
mixed
PROCESS_COLOR
= '#39A8EF'
PROCESS_COLORS
public
mixed
PROCESS_COLORS
= array('#39A8EF', '#2FC6F6', '#55D0E0', '#47E4C2', '#FFA900')
SUCCESS_COLOR
public
mixed
SUCCESS_COLOR
= '#7BD500'
Methods
__construct()
public
__construct([int $categoryID = 0 ]) : mixed
Parameters
- $categoryID : int = 0
-
Deal category ID.
Tags
addElement()
Add element
public
addElement(PhaseColorSchemeElement $element) : void
Parameters
- $element : PhaseColorSchemeElement
externalize()
Get external representation of this object
public
externalize() : array<string|int, mixed>
Return values
array<string|int, mixed>fillDefaultColors()
public
static fillDefaultColors(array<string|int, mixed> $stages) : array<string|int, mixed>
Parameters
- $stages : array<string|int, mixed>
Return values
array<string|int, mixed>getByCategory()
Get scheme by category
public
static getByCategory([int $categoryID = 0 ]) : DealStageColorScheme
Parameters
- $categoryID : int = 0
-
Deal category ID.
Tags
Return values
DealStageColorSchemegetByName()
public
static getByName(mixed $name) : mixed
Parameters
- $name : mixed
getCategoryId()
Get Deal category ID
public
getCategoryId() : int
Return values
intgetCurrent()
Get current scheme (for default category)
public
static getCurrent() : DealStageColorScheme
Tags
Return values
DealStageColorSchemegetDefaultColor()
Get default color for element.
public
getDefaultColor(string $name[, int $index = -1 ]) : string
Parameters
- $name : string
-
Element Name.
- $index : int = -1
-
Element Index.
Return values
stringgetDefaultColorBySemantics()
Get default element color by semantic ID.
public
static getDefaultColorBySemantics(int $semanticID[, array<string|int, mixed> $options = null ]) : string
Parameters
- $semanticID : int
-
Semantic ID.
- $options : array<string|int, mixed> = null
-
.
Return values
stringgetDefaultColorByStage()
Get default element color by semantic ID.
public
static getDefaultColorByStage(string $stageID[, int $categoryID = 0 ][, int $index = -1 ]) : string
Parameters
- $stageID : string
-
Deal stage ID.
- $categoryID : int = 0
-
Deal category ID.
- $index : int = -1
-
Deal Stage Index.
Return values
stringgetElementByName()
Get scheme element by name.
public
getElementByName(string $name) : PhaseColorSchemeElement|null
Parameters
- $name : string
-
Item Name.
Return values
PhaseColorSchemeElement|nullgetElementNames()
Get Element Names
public
getElementNames() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
public
static getName(mixed $categoryID) : mixed
Parameters
- $categoryID : mixed
getStageNames()
Get Stage Names for specified category.
public
static getStageNames(int $categoryID) : array<string|int, mixed>
Parameters
- $categoryID : int
-
Deal Category ID.
Return values
array<string|int, mixed>internalize()
Setup this object from external representation.
public
internalize(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
-
External params.
isPersistent()
public
isPersistent() : bool
Return values
boolload()
Try to load scheme from options
public
load() : bool
Tags
Return values
boolremove()
Remove scheme from options
public
remove() : void
removeByCategory()
Remove scheme by category.
public
static removeByCategory(int $categoryID) : bool
Parameters
- $categoryID : int
-
Deal category ID.
Tags
Return values
boolreset()
Reset scheme.
public
reset() : mixed
resolveCategoryByName()
public
static resolveCategoryByName(mixed $name) : mixed
Parameters
- $name : mixed
save()
Save scheme to options
public
save() : void
setupByDefault()
Setup scheme by default
public
setupByDefault() : void