Prismic.io PHP kit  3.0.0
Public Member Functions | Static Public Member Functions | List of all members
Prismic\Fragment\SliceZone Class Reference
Inheritance diagram for Prismic\Fragment\SliceZone:
Prismic\Fragment\FragmentInterface

Public Member Functions

 __construct ($slices)
 
 asHtml ($linkResolver=null)
 
 asText ()
 
 getSlices ()
 

Static Public Member Functions

static parse ($json)
 

Detailed Description

This class embodies a Slice Zone.

Constructor & Destructor Documentation

§ __construct()

Prismic\Fragment\SliceZone::__construct (   $slices)

Constructs a SliceZone fragment.

Parameters
string$slicesthe array of associative arrays of subfragments

Member Function Documentation

§ asHtml()

Prismic\Fragment\SliceZone::asHtml (   $linkResolver = null)

Builds a HTML version of the SliceZone fragment.

Parameters
\Prismic\LinkResolver$linkResolverthe link resolver
Returns
string the HTML version of the SliceZone fragment

Implements Prismic\Fragment\FragmentInterface.

§ asText()

Prismic\Fragment\SliceZone::asText ( )

Builds a text version of the SliceZone fragment.

Returns
string the text version of the SliceZone fragment

Implements Prismic\Fragment\FragmentInterface.

§ getSlices()

Prismic\Fragment\SliceZone::getSlices ( )

Returns an array version of this group fragment, on which you can do all you can do on an array: loop, access a certain index...

Each item is a Slice.

Returns
array the array to loop on / access items / etc.

§ parse()

static Prismic\Fragment\SliceZone::parse (   $json)
static

Parses a given SliceZone fragment. Not meant to be used except for testing.

Parameters
\stdClass$jsonthe json bit retrieved from the API that represents a SliceZone fragment.
Returns
the manipulable object for that SliceZone fragment.

The documentation for this class was generated from the following file: