\ChapterThree\AppleNewsAPI\Document\Styles\Fills\GradientsLinearGradientFill

An Apple News Document LinearGradientFill.

Summary

Methods

Properties

Constants

__construct()
getColorStops()
setColorStops()
getType()
setType()
getAttachment()
setAttachment()
jsonSerialize()
__toString()
json()
triggerError()
getAngle()
setAngle()

No public properties found

No constants found

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

$colorStops
$type
$attachment
$angle

N/A

No private methods found

No private properties found

N/A

Properties

$colorStops

$colorStops :

Type

$type

$type :

Type

$attachment

$attachment :

Type

$angle

$angle :

Type

Methods

__construct()

__construct(array|\ChapterThree\AppleNewsAPI\Document\Styles\Fills\Gradients\ColorStop  $colorStops)

Implements __construct().

Parameters

array|\ChapterThree\AppleNewsAPI\Document\Styles\Fills\Gradients\ColorStop

$colorStops

URL.

getColorStops()

getColorStops()

Getter for url.

setColorStops()

setColorStops(array|\ChapterThree\AppleNewsAPI\Document\Styles\Fills\Gradients\ColorStop  $items) : $this

Setter for url.

Parameters

array|\ChapterThree\AppleNewsAPI\Document\Styles\Fills\Gradients\ColorStop

$items

An array of color stops. Each stop sets a color and percentage.

Returns

$this

getType()

getType()

Getter for type.

setType()

setType(boolean  $value) : $this

Setter for type.

Parameters

boolean

$value

Type.

Returns

$this

getAttachment()

getAttachment()

Getter for attachment.

setAttachment()

setAttachment(boolean  $value) : $this

Setter for attachment.

Parameters

boolean

$value

Attachment.

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.

getAngle()

getAngle()

Getter for angle.

setAngle()

setAngle(float  $value) : $this

Setter for angle.

Parameters

float

$value

The angle of the gradient fill, in degrees Use the angle to set the direction of the gradient. For example, a value of 180 defines a gradient that changes color from top to bottom. An angle of 90 defines a gradient that changes color from left to right.

If angle is omitted, an angle of 180 (top to bottom) is used.

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.