chapter-three/apple-news-api v0.3.8
\
ChapterThree
AppleNewsAPI
Document
Animations
ComponentAnimations
Scenes
Behaviors
Components
Advertisements
Layouts
Styles
Fills
Gradients
PublisherAPI

\ChapterThree\AppleNewsAPI\DocumentMetadata

An Apple News Document.

Summary

Methods
Properties
Constants
jsonSerialize()
__toString()
json()
triggerError()
getDatePublished()
setDatePublished()
getDateCreated()
setDateCreated()
getDateModified()
setDateModified()
getAuthors()
addAuthor()
getGeneratorName()
setGeneratorName()
getGeneratorVersion()
setGeneratorVersion()
getGeneratorIdentifier()
setGeneratorIdentifier()
getCanonicalURL()
setCanonicalURL()
getThumbnailURL()
setThumbnailURL()
getKeywords()
addKeyword()
getExcerpt()
setExcerpt()
getCampaignData()
setCampaignData()
getTransparentToolbar()
setTransparentToolbar()
No public properties found
No constants found
optional()
isSupportedUnit()
isUnitInterval()
isHexColor()
validateKeywords()
$datePublished
$dateCreated
$dateModified
$authors
$generatorName
$generatorVersion
$generatorIdentifier
$canonicalURL
$thumbnailURL
$keywords
$excerpt
$campaignData
$transparentToolbar
N/A
No private methods found
No private properties found
N/A

Properties

$datePublished

$datePublished :

Type

$dateCreated

$dateCreated :

Type

$dateModified

$dateModified :

Type

$authors

$authors :

Type

$generatorName

$generatorName :

Type

$generatorVersion

$generatorVersion :

Type

$generatorIdentifier

$generatorIdentifier :

Type

$canonicalURL

$canonicalURL :

Type

$thumbnailURL

$thumbnailURL :

Type

$keywords

$keywords :

Type

$excerpt

$excerpt :

Type

$campaignData

$campaignData :

Type

$transparentToolbar

$transparentToolbar :

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.

getDatePublished()

getDatePublished()

Getter for datePublished.

setDatePublished()

setDatePublished(string  $value) : $this

Setter for datePublished.

Parameters

string $value

DatePublished.

Returns

$this

getDateCreated()

getDateCreated()

Getter for dateCreated.

setDateCreated()

setDateCreated(string  $value) : $this

Setter for dateCreated.

Parameters

string $value

DateCreated.

Returns

$this

getDateModified()

getDateModified()

Getter for dateModified.

setDateModified()

setDateModified(string  $value) : $this

Setter for dateModified.

Parameters

string $value

DateModified.

Returns

$this

getAuthors()

getAuthors()

Getter for authors.

addAuthor()

addAuthor(string  $value) : $this

Setter for authors.

Parameters

string $value

Author.

Returns

$this

getGeneratorName()

getGeneratorName()

Getter for generatorName.

setGeneratorName()

setGeneratorName(string  $value) : $this

Setter for generatorName.

Parameters

string $value

GeneratorName.

Returns

$this

getGeneratorVersion()

getGeneratorVersion()

Getter for generatorVersion.

setGeneratorVersion()

setGeneratorVersion(string  $value) : $this

Setter for generatorVersion.

Parameters

string $value

GeneratorVersion.

Returns

$this

getGeneratorIdentifier()

getGeneratorIdentifier()

Getter for generatorIdentifier.

setGeneratorIdentifier()

setGeneratorIdentifier(string  $value) : $this

Setter for generatorIdentifier.

Parameters

string $value

GeneratorIdentifier.

Returns

$this

getCanonicalURL()

getCanonicalURL()

Getter for canonicalURL.

setCanonicalURL()

setCanonicalURL(string  $value) : $this

Setter for canonicalURL.

Parameters

string $value

CanonicalURL.

Returns

$this

getThumbnailURL()

getThumbnailURL()

Getter for thumbnailURL.

setThumbnailURL()

setThumbnailURL(string  $value) : $this

Setter for thumbnailURL.

Parameters

string $value

ThumbnailURL.

Returns

$this

getKeywords()

getKeywords()

Getter for keywords.

addKeyword()

addKeyword(string  $value) : $this

Setter for keywords.

Parameters

string $value

Keyword.

Returns

$this

getExcerpt()

getExcerpt()

Getter for excerpt.

setExcerpt()

setExcerpt(string  $value) : $this

Setter for excerpt.

Parameters

string $value

Excerpt.

Returns

$this

getCampaignData()

getCampaignData()

Getter for campaignData.

setCampaignData()

setCampaignData(array  $value) : $this

Setter for campaignData.

Parameters

array $value

CampaignData.

Returns

$this

getTransparentToolbar()

getTransparentToolbar()

Getter for transparentToolbar.

setTransparentToolbar()

setTransparentToolbar(boolean  $value) : $this

Setter for transparentToolbar.

Parameters

boolean $value

TransparentToolbar.

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.

validateKeywords()

validateKeywords(  $value)

Validates the keywords attribute.

Parameters

$value