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\LayoutsComponentLayout

An Apple News Document ComponentLayout.

Summary

Methods
Properties
Constants
jsonSerialize()
__toString()
json()
triggerError()
getColumnStart()
setColumnStart()
getColumnSpan()
setColumnSpan()
getMargin()
setMargin()
getContentInset()
setContentInset()
getIgnoreDocumentMargin()
setIgnoreDocumentMargin()
getIgnoreDocumentGutter()
setIgnoreDocumentGutter()
getMinimumHeight()
setMinimumHeight()
getMaximumContentWidth()
setMaximumContentWidth()
getHorizontalContentAlignment()
setHorizontalContentAlignment()
No public properties found
No constants found
optional()
isSupportedUnit()
isUnitInterval()
isHexColor()
validateIgnoreDocumentMargin()
validateIgnoreDocumentGutter()
validateMinimumHeight()
validateMaximumContentWidth()
validateHorizontalContentAlignment()
$columnStart
$columnSpan
$margin
$contentInset
$ignoreDocumentMargin
$ignoreDocumentGutter
$minimumHeight
$maximumContentWidth
$horizontalContentAlignment
N/A
No private methods found
No private properties found
N/A

Properties

$columnStart

$columnStart :

Type

$columnSpan

$columnSpan :

Type

$margin

$margin :

Type

$contentInset

$contentInset :

Type

$ignoreDocumentMargin

$ignoreDocumentMargin :

Type

$ignoreDocumentGutter

$ignoreDocumentGutter :

Type

$minimumHeight

$minimumHeight :

Type

$maximumContentWidth

$maximumContentWidth :

Type

$horizontalContentAlignment

$horizontalContentAlignment :

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.

getColumnStart()

getColumnStart()

Getter for columnStart.

setColumnStart()

setColumnStart(integer  $value) : $this

Setter for columnStart.

Parameters

integer $value

ColumnStart.

Returns

$this

getColumnSpan()

getColumnSpan()

Getter for columnSpan.

setColumnSpan()

setColumnSpan(integer  $value) : $this

Setter for columnSpan.

Parameters

integer $value

ColumnSpan.

Returns

$this

getMargin()

getMargin()

Getter for margin.

getContentInset()

getContentInset()

Getter for contentInset.

getIgnoreDocumentMargin()

getIgnoreDocumentMargin()

Getter for ignoreDocumentMargin.

setIgnoreDocumentMargin()

setIgnoreDocumentMargin(float  $value = TRUE) : $this

Setter for ignoreDocumentMargin.

Parameters

float $value

IgnoreDocumentMargin.

Returns

$this

getIgnoreDocumentGutter()

getIgnoreDocumentGutter()

Getter for ignoreDocumentGutter.

setIgnoreDocumentGutter()

setIgnoreDocumentGutter(float  $value = TRUE) : $this

Setter for ignoreDocumentGutter.

Parameters

float $value

IgnoreDocumentGutter.

Returns

$this

getMinimumHeight()

getMinimumHeight()

Getter for minimumHeight.

setMinimumHeight()

setMinimumHeight(integer|string  $value) : $this

Setter for minimumHeight.

Parameters

integer|string $value

MinimumHeight.

Returns

$this

getMaximumContentWidth()

getMaximumContentWidth()

Getter for maximumContentWidth.

setMaximumContentWidth()

setMaximumContentWidth(integer|string  $value) : $this

Setter for maximumContentWidth.

Parameters

integer|string $value

maximumContentWidth.

Returns

$this

getHorizontalContentAlignment()

getHorizontalContentAlignment()

Getter for horizontalContentAlignment.

setHorizontalContentAlignment()

setHorizontalContentAlignment(string  $value = 'center') : $this

Setter for horizontalContentAlignment.

Parameters

string $value

horizontalContentAlignment.

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.

validateIgnoreDocumentMargin()

validateIgnoreDocumentMargin(  $value)

Validates the ignoreDocumentMargin attribute.

Parameters

$value

validateIgnoreDocumentGutter()

validateIgnoreDocumentGutter(  $value)

Validates the ignoreDocumentGutter attribute.

Parameters

$value

validateMinimumHeight()

validateMinimumHeight(  $value)

Validates the minimumHeight attribute.

Parameters

$value

validateMaximumContentWidth()

validateMaximumContentWidth(  $value)

Validates the maximumContentWidth attribute.

Parameters

$value

validateHorizontalContentAlignment()

validateHorizontalContentAlignment(  $value)

Validates the horizontalContentAlignment attribute.

Parameters

$value