Apple News API PHP Client

Condition

in package

• Application

implements JsonSerializable

Condition object for conditional component properties.

Tags

see

https://developer.apple.com/documentation/apple_news/condition

Table of Contents

Interfaces

JsonSerializable

Constants

COLOR_SCHEME_ANY  = 'any'

Valid preferred color scheme values.

COLOR_SCHEME_DARK  = 'dark'

COLOR_SCHEME_LIGHT  = 'light'

PLATFORM_ANY  = 'any'

Valid platform values.

PLATFORM_IOS  = 'ios'

PLATFORM_MACOS  = 'macos'

SIZE_CLASS_ANY  = 'any'

Valid size class values.

SIZE_CLASS_COMPACT  = 'compact'

SIZE_CLASS_REGULAR  = 'regular'

SUBSCRIPTION_BUNDLE  = 'bundle'

Valid subscription status values.

SUBSCRIPTION_SUBSCRIBED  = 'subscribed'

VIEW_ARTICLE  = 'article'

Valid view location values.

VIEW_ISSUE  = 'issue'

VIEW_ISSUE_TABLE_OF_CONTENTS  = 'issue_table_of_contents'

Properties

$horizontalSizeClass  : string|null

The horizontal size class.

$maxColumns  : int|null

The maximum number of columns.

$maxContentSizeCategory  : string|null

The maximum content size category.

$maxSpecifiedWidth  : int|null

The maximum specified width.

$maxViewportAspectRatio  : float|null

The maximum viewport aspect ratio.

$maxViewportWidth  : int|null

The maximum viewport width in points.

$minColumns  : int|null

The minimum number of columns.

$minContentSizeCategory  : string|null

The minimum content size category.

$minSpecifiedWidth  : int|null

The minimum specified width.

$minViewportAspectRatio  : float|null

The minimum viewport aspect ratio.

$minViewportWidth  : int|null

The minimum viewport width in points.

$platform  : string|null

The platform to match.

$preferredColorScheme  : string|null

The preferred color scheme.

$subscriptionStatus  : array<int, string>|null

The subscription status.

$verticalSizeClass  : string|null

The vertical size class.

$viewLocation  : string|null

The view location.

Methods

compactWidth()  : self

Create a condition for compact horizontal size class.

darkMode()  : self

Create a condition for dark mode.

iOS()  : self

Create a condition for iOS platform only.

jsonSerialize()  : array<string, mixed>

{@inheritdoc}

lightMode()  : self

Create a condition for light mode.

macOS()  : self

Create a condition for macOS platform only.

regularWidth()  : self

Create a condition for regular horizontal size class.

setHorizontalSizeClass()  : $this

Set the horizontal size class.

setMaxColumns()  : $this

Set the maximum columns.

setMaxContentSizeCategory()  : $this

Set the maximum content size category.

setMaxSpecifiedWidth()  : $this

Set the maximum specified width.

setMaxViewportAspectRatio()  : $this

Set the maximum viewport aspect ratio.

setMaxViewportWidth()  : $this

Set the maximum viewport width.

setMinColumns()  : $this

Set the minimum columns.

setMinContentSizeCategory()  : $this

Set the minimum content size category.

setMinSpecifiedWidth()  : $this

Set the minimum specified width.

setMinViewportAspectRatio()  : $this

Set the minimum viewport aspect ratio.

setMinViewportWidth()  : $this

Set the minimum viewport width.

setPlatform()  : $this

Set the platform.

setPreferredColorScheme()  : $this

Set the preferred color scheme.

setSubscriptionStatus()  : $this

Set the subscription status.

setVerticalSizeClass()  : $this

Set the vertical size class.

setViewLocation()  : $this

Set the view location.

viewportWidth()  : self

Create a condition for a viewport width range.