Prismic.io PHP kit  3.0.0
Public Member Functions | List of all members
Prismic\ApiData Class Reference

Public Member Functions

 __construct (array $refs, array $bookmarks, array $types, array $tags, array $forms, Experiments $experiments, $oauth_initiate, $oauth_token)
 
 getRefs ()
 
 getBookmarks ()
 
 getTypes ()
 
 getTags ()
 
 getForms ()
 
 getExperiments ()
 
 getOauthInitiate ()
 
 getOauthToken ()
 

Detailed Description

Embodies structured data that can be wished to be used while manipulating a prismic.io API. This is not supposed to be used to call a repository's API, this is solely for manipulation purpose by the class Prismic::Api.

Constructor & Destructor Documentation

§ __construct()

Prismic\ApiData::__construct ( array  $refs,
array  $bookmarks,
array  $types,
array  $tags,
array  $forms,
Experiments  $experiments,
  $oauth_initiate,
  $oauth_token 
)

A constructor to build the object when you've retrieved all the data you need.

Parameters
array$refs
array$bookmarks
array$types
array$tags
array$forms
Experiments$experiments
string$oauth_initiate
string$oauth_token

Member Function Documentation

§ getBookmarks()

Prismic\ApiData::getBookmarks ( )

Get the bookmarks

Returns
array

§ getExperiments()

Prismic\ApiData::getExperiments ( )

Get the Experiments

Returns
Experiments

§ getForms()

Prismic\ApiData::getForms ( )

Get the forms

Returns
array

§ getOauthInitiate()

Prismic\ApiData::getOauthInitiate ( )

Get the endpoint to initiate OAuth

Returns
string

§ getOauthToken()

Prismic\ApiData::getOauthToken ( )

Get the endpoint to run OAuth

Returns
string

§ getRefs()

Prismic\ApiData::getRefs ( )

Get the refs

Returns
array

§ getTags()

Prismic\ApiData::getTags ( )

Get the tags

Returns
array

§ getTypes()

Prismic\ApiData::getTypes ( )

Get the types

Returns
array

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