\ChapterThree\AppleNewsAPI\Document\ComponentsImage

An Apple News Document Image.

Summary

Methods

Properties

Constants

__construct()
getRole()
getIdentifier()
setIdentifier()
getLayout()
setLayout()
getStyle()
setStyle()
getAnchor()
setAnchor()
getAnimation()
setAnimation()
getBehavior()
setBehavior()
jsonSerialize()
__toString()
json()
triggerError()
getUrl()
setUrl()
getCaption()
setCaption()
getAccessibilityCaption()
setAccessibilityCaption()
getExplicitContent()
setExplicitContent()

No public properties found

No constants found

optional()
setRole()
isSupportedUnit()
isUnitInterval()
isHexColor()

$role
$identifier
$layout
$style
$anchor
$animation
$behavior
$URL
$caption
$accessibilityCaption
$explicitContent

N/A

No private methods found

No private properties found

N/A

abstract

File: src/Document/Components/Image.php
Package: Default
Class hierarchy: \ChapterThree\AppleNewsAPI\Document\Base

\ChapterThree\AppleNewsAPI\Document\Components\Component

\ChapterThree\AppleNewsAPI\Document\Components\Image

Properties

$role

$role :

Type

$identifier

$identifier :

Type

$layout

$layout :

Type

$style

$style :

Type

$anchor

$anchor :

Type

$animation

$animation :

Type

$behavior

$behavior :

Type

$URL

$URL :

Type

$caption

$caption :

Type

$accessibilityCaption

$accessibilityCaption :

Type

$explicitContent

$explicitContent :

Type

Methods

__construct()

__construct(mixed  $role, string  $url, mixed  $identifier = NULL)

Implements __construct().

Parameters

mixed	$role	Role.
string	$url	Image URL.
mixed	$identifier	Identifier.

getRole()

getRole()

Getter for role.

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.

getUrl()

getUrl()

Getter for url.

setUrl()

setUrl(mixed  $value) : $this

Setter for url.

Parameters

mixed

$value

Url.

Returns

$this

getCaption()

getCaption()

Getter for caption.

setCaption()

setCaption(string  $value) : $this

Setter for caption.

Parameters

string

$value

Caption.

Returns

$this

getAccessibilityCaption()

getAccessibilityCaption()

Getter for accessibilityCaption.

setAccessibilityCaption()

setAccessibilityCaption(string  $value) : $this

Setter for accessibilityCaption.

Parameters

string

$value

AccessibilityCaption.

Returns

$this

getExplicitContent()

getExplicitContent()

Getter for explicitContent.

setExplicitContent()

setExplicitContent(boolean  $value = false) : $this

Setter for explicitContent.

Parameters

boolean

$value

ExplicitContent.

Returns

$this

optional()

optional()

Define optional properties.

setRole()

setRole(mixed  $role) : $this

Setter for role.

Concrete classes are expected to set this explicitly.

Parameters

mixed

$role

Role.

Returns

$this

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.