Documentation

AbstractColor
in package
implements ColorInterface, ArrayAccess

AbstractYes

Abstract image 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

Interfaces

ColorInterface
Image color interface
ArrayAccess

Constants

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

Methods

__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
Method to print the color object
__unset()  : void
Magic method to unset color value
offsetExists()  : bool
ArrayAccess offsetExists
offsetGet()  : mixed
ArrayAccess offsetGet
offsetSet()  : void
ArrayAccess offsetSet
offsetUnset()  : void
ArrayAccess offsetUnset
render()  : string
Convert to readable string
toCss()  : string
Convert to a CSS-formatted string, regardless of the class's default __toString() format
channels()  : array<string|int, mixed>
Get the valid channel names for this color type, e.g. ['r', 'g', 'b', 'a']
channelsForError()  : string
Format the valid channel names for an exception message, e.g. "'r', 'g', 'b' or 'a'"

Constants

Methods

__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()

Method to print the color object

public abstract __toString() : string
Return values
string

__unset()

Magic method to unset color value

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

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 abstract render([string|null $format = null ]) : string
Parameters
$format : string|null = null
Return values
string

toCss()

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

public toCss() : string
Return values
string

channels()

Get the valid channel names for this color type, e.g. ['r', 'g', 'b', 'a']

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

Every channel name here must have matching get{Name}()/set{Name}() methods (e.g. 'gray' => getGray()/setGray()) - that convention is what offsetGet()/offsetSet() dispatch on.

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