ApiData
in package
Table of Contents
- $bookmarks : array<string|int, mixed>
- An array of the available bookmarks
- $experiments : Experiments
- List of both drafts and running experiments from Prismic
- $forms : array<string|int, mixed>
- An array of the available forms
- $languages : array<string|int, mixed>
- List of configured languages
- $oauth_initiate : string
- The URL of the endpoint to initiate the OAuth authentication
- $oauth_token : string
- The URL of the endpoint to authenticate through OAuth
- $refs : array<string|int, mixed>
- An array of the usable refs for this API
- $tags : array<string|int, mixed>
- An array of the available tags
- $types : array<string|int, mixed>
- An array of the available types
- getBookmarks() : array<string|int, mixed>
- Get the bookmarks
- getExperiments() : Experiments
- Get the Experiments
- getForms() : array<string|int, mixed>
- Get the forms
- getLanguages() : array<string|int, mixed>
- getOauthInitiate() : string
- Get the endpoint to initiate OAuth
- getOauthToken() : string
- Get the endpoint to run OAuth
- getRefs() : array<string|int, Ref>
- Get the refs
- getTags() : array<string|int, mixed>
- Get the tags
- getTypes() : array<string|int, mixed>
- Get the types
- withJsonObject() : self
- Return a new ApiData instance from the given JSON decoded object
- withJsonString() : static
- Return a new ApiData instance from the given JSON string
- __construct() : mixed
- A constructor to build the object when you've retrieved all the data you need.
Properties
$bookmarks
An array of the available bookmarks
private
array<string|int, mixed>
$bookmarks
$experiments
List of both drafts and running experiments from Prismic
private
Experiments
$experiments
$forms
An array of the available forms
private
array<string|int, mixed>
$forms
$languages
List of configured languages
private
array<string|int, mixed>
$languages
$oauth_initiate
The URL of the endpoint to initiate the OAuth authentication
private
string
$oauth_initiate
$oauth_token
The URL of the endpoint to authenticate through OAuth
private
string
$oauth_token
$refs
An array of the usable refs for this API
private
array<string|int, mixed>
$refs
$tags
An array of the available tags
private
array<string|int, mixed>
$tags
$types
An array of the available types
private
array<string|int, mixed>
$types
Methods
getBookmarks()
Get the bookmarks
public
getBookmarks() : array<string|int, mixed>
Return values
array<string|int, mixed> —getExperiments()
Get the Experiments
public
getExperiments() : Experiments
Return values
Experiments —getForms()
Get the forms
public
getForms() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLanguages()
public
getLanguages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOauthInitiate()
Get the endpoint to initiate OAuth
public
getOauthInitiate() : string
Return values
string —getOauthToken()
Get the endpoint to run OAuth
public
getOauthToken() : string
Return values
string —getRefs()
Get the refs
public
getRefs() : array<string|int, Ref>
Return values
array<string|int, Ref> —getTags()
Get the tags
public
getTags() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTypes()
Get the types
public
getTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —withJsonObject()
Return a new ApiData instance from the given JSON decoded object
public
static withJsonObject(stdClass $json) : self
Parameters
- $json : stdClass
Return values
self —withJsonString()
Return a new ApiData instance from the given JSON string
public
static withJsonString(string $json) : static
Parameters
- $json : string
Return values
static —__construct()
A constructor to build the object when you've retrieved all the data you need.
private
__construct(array<string|int, mixed> $refs, array<string|int, mixed> $bookmarks, array<string|int, mixed> $types, array<string|int, mixed> $languages, array<string|int, mixed> $tags, array<string|int, mixed> $forms, Experiments $experiments, string $oauth_initiate, string $oauth_token) : mixed
Parameters
- $refs : array<string|int, mixed>
- $bookmarks : array<string|int, mixed>
- $types : array<string|int, mixed>
- $languages : array<string|int, mixed>
- $tags : array<string|int, mixed>
- $forms : array<string|int, mixed>
- $experiments : Experiments
- $oauth_initiate : string
- $oauth_token : string