Documentation

Hsv extends AbstractColor
in package

Pop Color HSV color class

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

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

version
2.0.0

Table of Contents

Constants

COMMA  = 'COMMA'
String formats
CSS  = 'CSS'
PERCENT  = 'PERCENT'

Properties

$a  : float|null
Alpha value
$h  : int
H value
$s  : int
S value
$v  : int
V value

Methods

__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|null
Get A value
getH()  : int
Get H value
getS()  : int
Get S value
getV()  : int
Get V 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 readable string
setA()  : self
Set A value
setH()  : self
Set H value
setS()  : self
Set S value
setV()  : self
Set V value
toArray()  : array<string|int, mixed>
Convert to array
toCss()  : string
Convert to a CSS-formatted string, regardless of the class's default __toString() format
toRgb()  : Rgb
Convert to RGB
channels()  : array<string|int, mixed>
Get the valid channel names
channelsForError()  : string
Format the valid channel names for an exception message, e.g. "'r', 'g', 'b' or 'a'"

Constants

Properties

$a

Alpha value

protected float|null $a = null

$h

H value

protected int $h = 0

$s

S value

protected int $s = 0

$v

V value

protected int $v = 0

Methods

__construct()

Constructor

public __construct(int|string $h, int|string $s, int|string $v[, float|string|null $a = null ]) : mixed

Instantiate the HSV color object

Parameters
$h : int|string
$s : int|string
$v : int|string
$a : float|string|null = null

__get()

Magic method to return the color value

public __get(string $name) : mixed
Parameters
$name : string
Tags
throws
Exception

__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
Tags
throws
Exception

__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

getA()

Get A value

public getA() : float|null
Return values
float|null

getH()

Get H value

public getH() : int
Return values
int

getS()

Get S value

public getS() : int
Return values
int

getV()

Get V value

public getV() : 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

offsetSet()

ArrayAccess offsetSet

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

offsetUnset()

ArrayAccess offsetUnset

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

render()

Convert to readable string

public render([string|null $format = null ]) : string
Parameters
$format : string|null = null
Return values
string

setA()

Set A value

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

setH()

Set H value

public setH(int|string $h) : self
Parameters
$h : int|string
Tags
throws
OutOfRangeException
Return values
self

setS()

Set S value

public setS(int|string $s) : self
Parameters
$s : int|string
Tags
throws
OutOfRangeException
Return values
self

setV()

Set V value

public setV(int|string $v) : self
Parameters
$v : int|string
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>

toCss()

Convert to a CSS-formatted string, regardless of the class's default __toString() format

public toCss() : string
Return values
string

toRgb()

Convert to RGB

public toRgb() : Rgb
Return values
Rgb

channels()

Get the valid channel names

protected channels() : array<string|int, mixed>
Return values
array<string|int, mixed>

channelsForError()

Format the valid channel names for an exception message, e.g. "'r', 'g', 'b' or 'a'"

protected channelsForError() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results