\ChapterThree\AppleNewsAPI\Document\StylesStrokeStyle

An Apple News Document StrokeStyle.

Summary

Methods
Properties
Constants
jsonSerialize()
__toString()
json()
triggerError()
getColor()
setColor()
getWidth()
setWidth()
getStyle()
setStyle()
No public properties found
No constants found
optional()
isSupportedUnit()
isUnitInterval()
isHexColor()
validateColor()
validateWidth()
validateStyle()
$color
$width
$style
N/A
No private methods found
No private properties found
N/A

Properties

$color

$color : 

Type

$width

$width : 

Type

$style

$style : 

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.

getColor()

getColor() 

Getter for color.

setColor()

setColor(string  $value) : $this

Setter for color.

Parameters

string $value

Color.

Returns

$this

getWidth()

getWidth() 

Getter for width.

setWidth()

setWidth(string|integer  $value) : $this

Setter for width.

Parameters

string|integer $value

Width.

Returns

$this

getStyle()

getStyle() 

Getter for style.

setStyle()

setStyle(string  $value) : $this

Setter for style.

Parameters

string $value

Style.

Returns

$this

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.

validateColor()

validateColor(  $value) 

Validates the color attribute.

Parameters

$value

validateWidth()

validateWidth(  $value) 

Validates the width attribute.

Parameters

$value

validateStyle()

validateStyle(  $value) 

Validates the style attribute.

Parameters

$value