\ChapterThree\AppleNewsAPI\Document\ComponentsHeading

An Apple News Document Heading Component.

Summary

Methods

Properties

Constants

__construct()
getText()
setText()
getFormat()
setFormat()
getTextStyle()
setTextStyle()
getInlineTextStyles()
addInlineTextStyles()
getRole()
setRole()
getIdentifier()
setIdentifier()
getLayout()
setLayout()
getStyle()
setStyle()
getAnchor()
setAnchor()
getAnimation()
setAnimation()
getBehavior()
setBehavior()
jsonSerialize()
__toString()
json()
triggerError()

No public properties found

No constants found

optional()
validateFormat()
isSupportedUnit()
isUnitInterval()
isHexColor()
validateRole()

$text
$format
$textStyle
$inlineTextStyles
$role
$identifier
$layout
$style
$anchor
$animation
$behavior

N/A

No private methods found

No private properties found

N/A

Properties

$text

$text :

Type

$format

$format :

Type

$textStyle

$textStyle :

Type

$inlineTextStyles

$inlineTextStyles :

Type

$role

$role :

Type

$identifier

$identifier :

Type

$layout

$layout :

Type

$style

$style :

Type

$anchor

$anchor :

Type

$animation

$animation :

Type

$behavior

$behavior :

Type

Methods

__construct()

__construct(mixed  $text, mixed  $identifier = NULL)

Implements __construct().

Parameters

mixed	$text	Text.
mixed	$identifier	Identifier.

getText()

getText()

Getter for text.

setText()

setText(mixed  $value) : $this

Setter for text.

Parameters

mixed

$value

Text.

Returns

$this

getFormat()

getFormat()

Getter for format.

setFormat()

setFormat(mixed  $value = 'none') : $this

Setter for format.

Parameters

mixed

$value

Format.

Returns

$this

getTextStyle()

getTextStyle() : \ChapterThree\AppleNewsAPI\Document\Styles\ComponentTextStyle|string

Getter for textStyle.

Returns

\ChapterThree\AppleNewsAPI\Document\Styles\ComponentTextStyle|string

setTextStyle()

setTextStyle(\ChapterThree\AppleNewsAPI\Document\Styles\ComponentTextStyle|string  $text_style, \ChapterThree\AppleNewsAPI\Document|NULL  $document = NULL) : $this

Setter for textStyle.

Parameters

\ChapterThree\AppleNewsAPI\Document\Styles\ComponentTextStyle\|string	$text_style	Either a ComponentTextStyle object, or a string reference to one defined in $document.
\ChapterThree\AppleNewsAPI\Document\|NULL	$document	If required by first parameter.

Returns

$this

getInlineTextStyles()

getInlineTextStyles()

Getter for inlineTextStyles.

addInlineTextStyles()

addInlineTextStyles(\ChapterThree\AppleNewsAPI\Document\Styles\InlineTextStyle  $inline_text_style) : $this

Setter for inlineTextStyles.

Parameters

\ChapterThree\AppleNewsAPI\Document\Styles\InlineTextStyle

$inline_text_style

InlineTextStyle.

Returns

$this

getRole()

getRole()

Getter for role.

setRole()

setRole(string  $value) : $this

Setter for role.

Parameters

string

$value

One of "heading" or "heading1" through "heading6", defaults to "heading".

Returns

$this

getIdentifier()

getIdentifier()

Getter for identifier.

setIdentifier()

setIdentifier(mixed  $identifier) : $this

Setter for identifier.

Parameters

mixed

$identifier

Identifier.

Returns

$this

getLayout()

getLayout() : \ChapterThree\AppleNewsAPI\Document\Layouts\ComponentLayout|string

Getter for layout.

Returns

\ChapterThree\AppleNewsAPI\Document\Layouts\ComponentLayout|string —

Layout object or string reference

setLayout()

setLayout(\ChapterThree\AppleNewsAPI\Document\Layouts\ComponentLayout|string  $layout, \ChapterThree\AppleNewsAPI\Document|NULL  $document = NULL) : $this

Setter for layout.

Parameters

\ChapterThree\AppleNewsAPI\Document\Layouts\ComponentLayout\|string	$layout	Either a ComponentLayout object, or a string reference to one defined in $document.
\ChapterThree\AppleNewsAPI\Document\|NULL	$document	If required by first parameter.

Returns

$this

getStyle()

getStyle()

Getter for style.

setStyle()

setStyle(\ChapterThree\AppleNewsAPI\Document\Styles\ComponentStyle|string  $style, \ChapterThree\AppleNewsAPI\Document|NULL  $document = NULL) : $this

Setter for style.

Parameters

\ChapterThree\AppleNewsAPI\Document\Styles\ComponentStyle\|string	$style	Either a ComponentStyle object, or a string reference to one defined in $document.
\ChapterThree\AppleNewsAPI\Document\|NULL	$document	If required by first parameter.

Returns

$this

getAnchor()

getAnchor()

Getter for anchor.

setAnchor()

setAnchor(\ChapterThree\AppleNewsAPI\Document\Anchor  $anchor) : $this

Setter for anchor.

Parameters

\ChapterThree\AppleNewsAPI\Document\Anchor

$anchor

Anchor.

Returns

$this

getAnimation()

getAnimation()

Getter for animation.

setAnimation()

setAnimation(\ChapterThree\AppleNewsAPI\Document\Animations\ComponentAnimations\ComponentAnimation  $animation) : $this

Setter for animation.

Parameters

\ChapterThree\AppleNewsAPI\Document\Animations\ComponentAnimations\ComponentAnimation

$animation

Animation.

Returns

$this

getBehavior()

getBehavior()

Getter for behavior.

setBehavior()

setBehavior(\ChapterThree\AppleNewsAPI\Document\Behaviors\Behavior  $behavior) : $this

Setter for behavior.

Parameters

\ChapterThree\AppleNewsAPI\Document\Behaviors\Behavior

$behavior

Behavior.

Returns

$this

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.

optional()

optional()

Define optional properties.

validateFormat()

validateFormat(  $value)

Validates the format attribute.

Parameters

$value

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.

validateRole()

validateRole(  $value)

Validates the role attribute.

Parameters

$value