\ChapterThree\AppleNewsAPI\DocumentContentInset

An Apple News Document ContentInset.

Summary

Methods
Properties
Constants
jsonSerialize()
__toString()
json()
triggerError()
getTop()
setTop()
getRight()
setRight()
getBottom()
setBottom()
getLeft()
setLeft()
No public properties found
No constants found
optional()
isSupportedUnit()
isUnitInterval()
isHexColor()
$top
$right
$bottom
$left
N/A
No private methods found
No private properties found
N/A

Properties

$top

$top : 

Type

$right

$right : 

Type

$bottom

$bottom : 

Type

$left

$left : 

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.

getTop()

getTop() 

Getter for top.

setTop()

setTop(boolean  $top) : $this

Setter for top.

Parameters

boolean $top

Top.

Returns

$this

getRight()

getRight() 

Getter for right.

setRight()

setRight(boolean  $right) : $this

Setter for right.

Parameters

boolean $right

Right.

Returns

$this

getBottom()

getBottom() 

Getter for bottom.

setBottom()

setBottom(boolean  $bottom) : $this

Setter for bottom.

Parameters

boolean $bottom

Bottom.

Returns

$this

getLeft()

getLeft() 

Getter for left.

setLeft()

setLeft(boolean  $left) : $this

Setter for left.

Parameters

boolean $left

Left.

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.