Apple News API PHP Client

Chapter extends Container
in package

Chapter container component.

The chapter component organizes article content into chapters, similar to sections but intended for longer-form content like books or multi-part articles.

Tags
see
https://developer.apple.com/documentation/apple_news/chapter

Table of Contents

Properties

$anchor  : string|null
$animation  : array<string, mixed>|null
$behavior  : array<string, mixed>|null
$components  : array<string|int, Component>
$conditional  : array<string, mixed>|null
$contentDisplay  : string|array<string, mixed>|null
$hidden  : bool
$identifier  : string|null
$layout  : string|null
$scene  : array<string, mixed>|null
The scene for this chapter's header area.
$style  : string|null

Methods

addComponent()  : self
Add a child component to this container.
getRole()  : string
Get the role name for the component (e.g., 'body', 'photo', 'heading1').
jsonSerialize()  : array<string, mixed>
Implementation of JsonSerializable.
setAnchor()  : static
Set the anchor configuration.
setAnimation()  : static
Set component animation using an array.
setAnimationObject()  : static
Set the component animation using a typed Animation object.
setBehavior()  : static
Set the component behavior using an array.
setBehaviorObject()  : static
Set the component behavior using a typed Behavior object.
setConditional()  : static
Set conditional properties for the component.
setContentDisplay()  : $this
Set the content display mode using a string or array.
setContentDisplayObject()  : $this
Set the content display mode using a typed ContentDisplay object.
setHidden()  : static
Set whether the component is hidden.
setIdentifier()  : static
Set a unique identifier for this component.
setLayout()  : static
Set the layout name or inline layout.
setScene()  : $this
Set the scene for animated header effects using an array.
setSceneObject()  : $this
Set the scene for animated header effects using a typed Scene object.
setStyle()  : static
Set the style name.
getBaseProperties()  : array<string, mixed>
Get the base properties common to all components for JSON serialization.

Properties

$anchor

protected string|null $anchor = null

Anchor configuration for pinning components.

$animation

protected array<string, mixed>|null $animation = null

Animation settings for the component.

$behavior

protected array<string, mixed>|null $behavior = null

Behavior settings (e.g., Parallax).

$conditional

protected array<string, mixed>|null $conditional = null

Conditional properties based on orientation/device.

$contentDisplay

protected string|array<string, mixed>|null $contentDisplay = null

Layout mode for child components.

$hidden

protected bool $hidden = false

Whether the component is hidden by default.

$identifier

protected string|null $identifier = null

A unique identifier for this component instance.

$layout

protected string|null $layout = null

Reference to a named layout defined in Article.

$scene

The scene for this chapter's header area.

protected array<string, mixed>|null $scene = null

$style

protected string|null $style = null

Reference to a named style defined in Article.

Methods

addComponent()

Add a child component to this container.

public addComponent(Component $component) : self
Parameters
$component : Component
Return values
self

getRole()

Get the role name for the component (e.g., 'body', 'photo', 'heading1').

public getRole() : string
Return values
string

jsonSerialize()

Implementation of JsonSerializable.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

setAnchor()

Set the anchor configuration.

public setAnchor(string $anchor) : static
Parameters
$anchor : string

The anchor configuration.

Return values
static

setAnimationObject()

Set the component animation using a typed Animation object.

public setAnimationObject(AnimationInterface $animation) : static

This method provides type-safe animation configuration:

$photo->setAnimationObject(FadeInAnimation::fromTransparent());
$body->setAnimationObject(MoveInAnimation::fromLeft());
Parameters
$animation : AnimationInterface

The animation object.

Return values
static

setBehaviorObject()

Set the component behavior using a typed Behavior object.

public setBehaviorObject(BehaviorInterface $behavior) : static

This method provides type-safe behavior configuration:

$photo->setBehaviorObject(Parallax::withFactor(0.8));
$photo->setBehaviorObject(new Springy());
Parameters
$behavior : BehaviorInterface

The behavior object.

Return values
static

setContentDisplay()

Set the content display mode using a string or array.

public setContentDisplay(string|array<string, mixed> $contentDisplay) : $this
Parameters
$contentDisplay : string|array<string, mixed>

The display mode or configuration.

Return values
$this

setContentDisplayObject()

Set the content display mode using a typed ContentDisplay object.

public setContentDisplayObject(ContentDisplayInterface $contentDisplay) : $this

This method provides type-safe content display configuration:

$container->setContentDisplayObject(new HorizontalStackDisplay());
$container->setContentDisplayObject(CollectionDisplay::grid(20, 20));
Parameters
$contentDisplay : ContentDisplayInterface

The content display object.

Return values
$this

setHidden()

Set whether the component is hidden.

public setHidden(bool $hidden) : static
Parameters
$hidden : bool

Whether to hide the component.

Return values
static

setIdentifier()

Set a unique identifier for this component.

public setIdentifier(string $identifier) : static
Parameters
$identifier : string

The unique identifier.

Return values
static

setLayout()

Set the layout name or inline layout.

public setLayout(string $layout) : static
Parameters
$layout : string

Reference to a name in componentLayouts.

Return values
static

setScene()

Set the scene for animated header effects using an array.

public setScene(array<string, mixed> $scene) : $this
Parameters
$scene : array<string, mixed>

The scene configuration.

Return values
$this

setSceneObject()

Set the scene for animated header effects using a typed Scene object.

public setSceneObject(SceneInterface $scene) : $this

This method provides type-safe scene configuration:

$chapter->setSceneObject(FadingStickyHeader::fadeToBlack());
$chapter->setSceneObject(new ParallaxScaleHeader());
Parameters
$scene : SceneInterface

The scene object.

Return values
$this

setStyle()

Set the style name.

public setStyle(string $style) : static
Parameters
$style : string

Reference to a name in componentStyles.

Return values
static

getBaseProperties()

Get the base properties common to all components for JSON serialization.

protected getBaseProperties() : array<string, mixed>
Return values
array<string, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results