Documentation

Rgb
in package
implements ArrayAccess, ColorInterface

Pop CSS RGB color class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2021 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
1.1.0

Interfaces, Classes and Traits

ArrayAccess
ColorInterface
Pop CSS color interface

Table of Contents

$a  : int
Alpha value
$b  : int
B value
$g  : int
G value
$r  : int
R value
__construct()  : mixed
Constructor
__get()  : mixed
Magic method to return the color value
__isset()  : bool
Magic method to return whether the color value exists
__set()  : void
Magic method to set the color value
__toString()  : string
Return CSS-formatted string
__unset()  : void
Magic method to unset color value
getA()  : float
Get A value
getB()  : int
Get B value
getG()  : int
Get G value
getR()  : int
Get R value
hasA()  : bool
Determine if the color object has an alpha value
hasAlpha()  : bool
Determine if the color object has an alpha value (alias)
offsetExists()  : bool
ArrayAccess offsetExists
offsetGet()  : mixed
ArrayAccess offsetGet
offsetSet()  : void
ArrayAccess offsetSet
offsetUnset()  : void
ArrayAccess offsetUnset
render()  : string
Convert to CSS-formatted string
setA()  : self
Set A value
setB()  : self
Set B value
setG()  : self
Set G value
setR()  : self
Set R value
toArray()  : array<string|int, mixed>
Convert to array
toHex()  : Hex
Convert to hex
toHsl()  : Hsl
Convert to HSL

Properties

$a

Alpha value

protected int $a = null

$b

B value

protected int $b = 0

$g

G value

protected int $g = 0

$r

R value

protected int $r = 0

Methods

__construct()

Constructor

public __construct(int $r, int $g, int $b[, float $a = null ]) : mixed

Instantiate the CSS RGB color object

Parameters
$r : int
$g : int
$b : int
$a : float = null
Return values
mixed

__get()

Magic method to return the color value

public __get(string $name) : mixed
Parameters
$name : string
Return values
mixed

__isset()

Magic method to return whether the color value exists

public __isset(string $name) : bool
Parameters
$name : string
Return values
bool

__set()

Magic method to set the color value

public __set(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed
Return values
void

__toString()

Return CSS-formatted string

public __toString() : string
Return values
string

__unset()

Magic method to unset color value

public __unset(string $name) : void
Parameters
$name : string
Tags
throws
Exception
Return values
void

getA()

Get A value

public getA() : float
Return values
float

getB()

Get B value

public getB() : int
Return values
int

getG()

Get G value

public getG() : int
Return values
int

getR()

Get R value

public getR() : int
Return values
int

hasA()

Determine if the color object has an alpha value

public hasA() : bool
Return values
bool

hasAlpha()

Determine if the color object has an alpha value (alias)

public hasAlpha() : bool
Return values
bool

offsetExists()

ArrayAccess offsetExists

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

ArrayAccess offsetGet

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Tags
throws
Exception
Return values
mixed

offsetSet()

ArrayAccess offsetSet

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed
Tags
throws
Exception
Return values
void

offsetUnset()

ArrayAccess offsetUnset

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed
Tags
throws
Exception
Return values
void

render()

Convert to CSS-formatted string

public render() : string
Return values
string

setA()

Set A value

public setA(float $a) : self
Parameters
$a : float
Tags
throws
OutOfRangeException
Return values
self

setB()

Set B value

public setB(int $b) : self
Parameters
$b : int
Tags
throws
OutOfRangeException
Return values
self

setG()

Set G value

public setG(int $g) : self
Parameters
$g : int
Tags
throws
OutOfRangeException
Return values
self

setR()

Set R value

public setR(int $r) : self
Parameters
$r : int
Tags
throws
OutOfRangeException
Return values
self

toArray()

Convert to array

public toArray([bool $assoc = true ]) : array<string|int, mixed>
Parameters
$assoc : bool = true
Return values
array<string|int, mixed>

toHex()

Convert to hex

public toHex() : Hex
Return values
Hex

toHsl()

Convert to HSL

public toHsl() : Hsl
Return values
Hsl

Search results