chapter-three/apple-news-api v0.3.8
\
ChapterThree
AppleNewsAPI
Document
Animations
ComponentAnimations
Scenes
Behaviors
Components
Advertisements
Layouts
Styles
Fills
Gradients
PublisherAPI

\ChapterThree\AppleNewsAPI\Document\StylesComponentStyle

An Apple News Document ComponentStyle.

Summary

Methods
Properties
Constants
jsonSerialize()
__toString()
json()
triggerError()
getBackgroundColor()
setBackgroundColor()
getOpacity()
setOpacity()
getFill()
setFill()
getBorder()
setBorder()
No public properties found
No constants found
optional()
isSupportedUnit()
isUnitInterval()
isHexColor()
validateBackgroundColor()
validateOpacity()
$backgroundColor
$fill
$opacity
$border
N/A
No private methods found
No private properties found
N/A

Properties

$backgroundColor

$backgroundColor :

Type

$fill

$fill :

Type

$opacity

$opacity :

Type

$border

$border :

Type

Methods

jsonSerialize()

jsonSerialize()

Implements JsonSerializable::jsonSerialize().

__toString()

__toString()

Implements __toString().

json()

json() : boolean|string

Generates json representation.

Returns

boolean|string —

JSON string, or FALSE on error.

triggerError()

triggerError(string  $message, integer  $message_type = E_USER_NOTICE)

Error handler.

Parameters

string $message

Message.
integer $message_type

Matching E_USER_ERROR|E_USER_WARNING|E_USER_NOTICE|E_USER_DEPRECATED.

getBackgroundColor()

getBackgroundColor()

Getter for backgroundColor.

setBackgroundColor()

setBackgroundColor(string  $value = 'transparent') : $this

Setter for backgroundColor.

Parameters

string $value

BackgroundColor.

Returns

$this

getOpacity()

getOpacity()

Getter for opacity.

setOpacity()

setOpacity(float  $value = 1) : $this

Setter for opacity.

Parameters

float $value

Opacity.

Returns

$this

getFill()

getFill()

Getter for fill.

getBorder()

getBorder()

Getter for border.

optional()

optional()

Define optional properties.

isSupportedUnit()

isSupportedUnit(mixed  $value) : boolean

Helper function to determine if a value is suffixed by a supported unit.

Parameters

mixed $value

Value.

Returns

boolean —

Result.

isUnitInterval()

isUnitInterval(float|integer  $value) : boolean

Helper function to determine if a value is a unit interval.

A unit interval is the closed interval [0,1], that is, the set of all real numbers that are greater than or equal to 0 and less than or equal to 1.

Parameters

float|integer $value

Value.

Returns

boolean —

Result.

isHexColor()

isHexColor(string  $value) : boolean

Helper to validate color hex code.

Valid codes are hexadecimal numbers of length 3, 6 or 8 (with opacity), prefixed with "#".

Parameters

string $value

Value.

Returns

boolean —

Result.

validateBackgroundColor()

validateBackgroundColor(  $value)

Validates the backgroundColor attribute.

Parameters

$value

validateOpacity()

validateOpacity(  $value)

Validates the opacity attribute.

Parameters

$value