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

An Apple News Document DropCapStyle.

Summary

Methods
Properties
Constants
jsonSerialize()
__toString()
json()
triggerError()
__construct()
getNumberOfLines()
setNumberOfLines()
getNumberOfCharacters()
setNumberOfCharacters()
getFontName()
setFontName()
getTextColor()
setTextColor()
getBackgroundColor()
setBackgroundColor()
getPadding()
setPadding()
No public properties found
No constants found
optional()
isSupportedUnit()
isUnitInterval()
isHexColor()
validateTextColor()
validateBackgroundColor()
$numberOfLines
$numberOfCharacters
$fontName
$textColor
$backgroundColor
$padding
N/A
No private methods found
No private properties found
N/A

Properties

$numberOfLines

$numberOfLines :

Type

$numberOfCharacters

$numberOfCharacters :

Type

$fontName

$fontName :

Type

$textColor

$textColor :

Type

$backgroundColor

$backgroundColor :

Type

$padding

$padding :

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.

__construct()

__construct(integer  $number_of_lines)

Implements __construct().

Parameters

integer $number_of_lines

Text.

getNumberOfLines()

getNumberOfLines()

Getter for numberOfLines.

setNumberOfLines()

setNumberOfLines(integer  $value) : $this

Setter for numberOfLines.

Parameters

integer $value

NumberOfLines.

Returns

$this

getNumberOfCharacters()

getNumberOfCharacters()

Getter for numberOfCharacters.

setNumberOfCharacters()

setNumberOfCharacters(integer  $value) : $this

Setter for numberOfCharacters.

Parameters

integer $value

NumberOfCharacters.

Returns

$this

getFontName()

getFontName()

Getter for fontName.

setFontName()

setFontName(string  $value) : $this

Setter for fontName.

Parameters

string $value

FontName.

Returns

$this

getTextColor()

getTextColor()

Getter for textColor.

setTextColor()

setTextColor(string  $value) : $this

Setter for textColor.

Parameters

string $value

TextColor.

Returns

$this

getBackgroundColor()

getBackgroundColor()

Getter for backgroundColor.

setBackgroundColor()

setBackgroundColor(string  $value) : $this

Setter for backgroundColor.

Parameters

string $value

BackgroundColor.

Returns

$this

getPadding()

getPadding()

Getter for padding.

setPadding()

setPadding(integer  $value) : $this

Setter for padding.

Parameters

integer $value

Padding.

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.

validateTextColor()

validateTextColor(  $value)

Validates the textColor attribute.

Parameters

$value

validateBackgroundColor()

validateBackgroundColor(  $value)

Validates the backgroundColor attribute.

Parameters

$value