Check the repository URL and access token you configured before running this script.
';
+ $markup[] = sprintf('
%s', $e->getMessage());
+ $markup[] = '
';
+
+ echo $this->header() . implode("\n", $markup) . $this->footer();
+ }
+ }
+}
diff --git a/samples/dom-helpers-examples.php b/samples/dom-helpers-examples.php
index 8ff1f147..032623ab 100644
--- a/samples/dom-helpers-examples.php
+++ b/samples/dom-helpers-examples.php
@@ -13,7 +13,7 @@
class ExampleLinkResolver extends LinkResolver
{
- public function resolve($link)
+ public function resolve($link) : string
{
if ($link->isBroken) {
return '/404';
diff --git a/samples/usage.php b/samples/usage.php
index 6950cb4d..aa091f3d 100644
--- a/samples/usage.php
+++ b/samples/usage.php
@@ -4,11 +4,11 @@
use Prismic\Api;
-$options = array(
+$options = [
'prismic.ref' => false,
'prismic.api' => "https://your-repository-name.prismic.io/api/v2",
'prismic.token' => "Your permanent token",
-);
+];
// retrieve the main information from the api, form and repositories ...
$api = Api::get($options['prismic.api'], $options['prismic.token']);
diff --git a/src/Prismic/Api.php b/src/Prismic/Api.php
index 14633674..7dcba937 100644
--- a/src/Prismic/Api.php
+++ b/src/Prismic/Api.php
@@ -1,26 +1,21 @@
the kit's README file)
*/
class Api
@@ -29,7 +24,7 @@ class Api
/**
* Kit version number
*/
- const VERSION = "3.0.0";
+ const VERSION = "5.0.0";
/**
* Name of the cookie that will be used to remember the preview reference
@@ -42,70 +37,112 @@ class Api
const EXPERIMENTS_COOKIE = "io.prismic.experiment";
/**
- * string the API's access token to be used with each API call
+ * The API's access token to be used with each API call
+ * @var string|null
*/
protected $accessToken;
+
/**
- * ApiData the raw data of the /api document (prefer to use this class's instance methods)
+ * An instance of ApiData containing information about types, tags and refs etc
+ * @var ApiData
*/
protected $data;
+
/**
- * CacheInterface the cache object specifying how to store the cache
+ * The cache instance
+ * @var CacheInterface
*/
private $cache;
+
/**
- * Client
+ * Guzzle HTTP Client
+ * @var ClientInterface
*/
private $httpClient;
- /**
- * Private constructor, not be used outside of this class.
- */
private function __construct(
- $data /**< string */,
- $accessToken = null /**< optional access token, if the API is private */,
- Client $httpClient = null,
- CacheInterface $cache = null)
- {
+ ApiData $data,
+ ?string $accessToken = null,
+ ?ClientInterface $httpClient = null,
+ ?CacheInterface $cache = null
+ ) {
$this->data = $data;
$this->accessToken = $accessToken;
- $this->httpClient = is_null($httpClient) ? new Client() : $httpClient;
- $this->cache = is_null($cache) ? self::defaultCache() : $cache;
+ $this->httpClient = is_null($httpClient) ? new Client() : $httpClient;
+ $this->cache = is_null($cache) ? self::defaultCache() : $cache;
+ }
+
+ /**
+ * This is the factory method with which to retrieve your API client instance
+ *
+ * If your API is set to "public" or "open", you can instantiate your Api object just like this:
+ * Api::get('https://your-repository-name.prismic.io/api/v2')
+ *
+ * @param string $action The URL of your repository API's endpoint
+ * @param string $accessToken A permanent access token to use if your repository API is set to private
+ * @param ClientInterface $httpClient Custom Guzzle http client
+ * @param CacheInterface $cache Cache implementation
+ * @param int $apiCacheTTL Max time to keep the API object in cache (in seconds)
+ * @return self
+ */
+ public static function get(
+ string $action,
+ ?string $accessToken = null,
+ ?ClientInterface $httpClient = null,
+ ?CacheInterface $cache = null,
+ int $apiCacheTTL = 5
+ ) : self {
+ $cache = is_null($cache) ? self::defaultCache() : $cache;
+ $cacheKey = $action . (empty($accessToken) ? "" : ("#" . $accessToken));
+ $apiData = $cache->get($cacheKey);
+
+ if (is_string($apiData) && ! empty($apiData)) {
+ return new self(unserialize($apiData), $accessToken, $httpClient, $cache);
+ }
+
+ $url = $accessToken ? Utils::buildUrl($action, [ 'access_token' => $accessToken]) : $action;
+ $httpClient = is_null($httpClient) ? new Client() : $httpClient;
+ try {
+ /** @var \Psr\Http\Message\ResponseInterface $response */
+ $response = $httpClient->request('GET', $url);
+ } catch (GuzzleException $guzzleException) {
+ throw Exception\RequestFailureException::fromGuzzleException($guzzleException);
+ }
+
+ $apiData = ApiData::withJsonString((string) $response->getBody());
+ $api = new self($apiData, $accessToken, $httpClient, $cache);
+ $cache->set($cacheKey, serialize($apiData), $apiCacheTTL);
+
+ return $api;
}
/**
* Returns all of the repository's references (queryable points in time)
*
- * @return array the array of references, with their IDs, labels, ...
+ * @return Ref[]
*/
- public function refs()
+ public function refs() : array
{
- $refs = $this->data->getRefs();
- $groupBy = array();
- foreach ($refs as $ref) {
- if (isset($groupBy[$ref->getLabel()])) {
- $arr = $groupBy[$ref->getLabel()];
- array_push($arr, $ref);
- $groupBy[$ref->getLabel()] = $arr;
- } else {
- $groupBy[$ref->getLabel()] = array($ref);
+ $groupBy = [];
+ foreach ($this->data->getRefs() as $ref) {
+ $label = $ref->getLabel();
+ if (! isset($groupBy[$label])) {
+ $groupBy[$label] = $ref;
}
}
- $results = array();
- foreach ($groupBy as $label => $values) {
- $results[$label] = $values[0];
- }
-
- return $results;
+ return $groupBy;
}
/**
- * @param string $label the label of the requested ref
+ * Return the ref identified by the given label
*
- * @return Ref a reference or null
+ * @param string $label The label of the requested ref
+ *
+ * @return Ref|null a reference or null
*/
- public function getRef($label) {
+ public function getRefFromLabel(string $label) :? Ref
+ {
$refs = $this->refs();
return $refs[$label];
}
@@ -116,7 +153,7 @@ public function getRef($label) {
*
* @return array the array of bookmarks
*/
- public function bookmarks()
+ public function bookmarks() : array
{
return $this->data->getBookmarks();
}
@@ -132,7 +169,7 @@ public function bookmarks()
*
* @return string|null the ID string for a given bookmark name
*/
- public function bookmark($name)
+ public function bookmark(string $name) :? string
{
$bookmarks = $this->bookmarks();
if (isset($bookmarks[$name])) {
@@ -146,11 +183,11 @@ public function bookmark($name)
* Returns the master ref repository: the ref which is to be used to query content
* that is live right now.
*
- * @return string the master ref
+ * @return Ref the master ref
*/
- public function master()
+ public function master() : Ref
{
- $masters = array_filter($this->data->getRefs(), function ($ref) {
+ $masters = array_filter($this->data->getRefs(), function (Ref $ref) {
return $ref->isMasterRef() == true;
});
@@ -158,45 +195,20 @@ public function master()
}
/**
- * Returns all forms of type Prismic::SearchForm that are available for this repository's API.
- * The intended syntax of a call is: api->forms()->everything->query(query)->ref(ref)->submit().
- * Learn more about those keywords in prismic.io's documentation on our developers' portal.
- *
- * @return all forms
+ * Returns the form of type Prismic::SearchForm based on its name.
+ * The intended syntax of a call is: api->form('everything')->query(query)->ref(ref)->submit().
+ * Learn more about those keywords in Prismic's documentation on our developers' portal.
*/
- public function forms()
+ public function form(string $formName) : SearchForm
{
$forms = $this->data->getForms();
- $rforms = new \stdClass();
- foreach ($forms as $key => $form) {
-
- $fields = array();
- foreach ($form->fields as $name => $field) {
- $maybeDefault = isset($field->default) ? $field->default : null;
- $isMultiple = isset($field->multiple) ? $field->multiple : false;
- $fields[$name] = new FieldForm($field->type, $isMultiple, $maybeDefault);
- }
+ $formObject = Form::withJsonObject($forms[$formName]);
+ $data = $formObject->defaultData();
- $f = new Form(
- isset($form->name) ? $form->name : null,
- $form->method,
- isset($form->rel) ? $form->rel : null,
- $form->enctype,
- $form->action,
- $fields
- );
-
- $data = $f->defaultData();
- $rforms->$key = new SearchForm($this, $f, $data);
- }
-
- return $rforms;
+ return new SearchForm($this->httpClient, $this->cache, $formObject, $data);
}
- /**
- * @return \Prismic\Experiments
- */
- public function getExperiments()
+ public function getExperiments() : Experiments
{
return $this->data->getExperiments();
}
@@ -204,15 +216,20 @@ public function getExperiments()
/**
* Return the URL to display a given preview
* @param string $token as received from Prismic server to identify the content to preview
- * @param Prismic::LinkResolver $linkResolver the link resolver to build URL for your site
+ * @param LinkResolver $linkResolver the link resolver to build URL for your site
* @param string $defaultUrl the URL to default to return if the preview doesn't correspond to a document
* (usually the home page of your site)
* @return string the URL you should redirect the user to preview the requested change
*/
- public function previewSession($token, $linkResolver, $defaultUrl)
+ public function previewSession(string $token, LinkResolver $linkResolver, string $defaultUrl) : string
{
- $response = $this->getHttpClient()->get($token);
- $response = json_decode($response->getBody(true));
+ try {
+ $response = $this->getHttpClient()->request('GET', $token);
+ } catch (GuzzleException $guzzleException) {
+ throw Exception\RequestFailureException::fromGuzzleException($guzzleException);
+ }
+ /** @var \Psr\Http\Message\ResponseInterface $response */
+ $response = \json_decode($response->getBody());
if (isset($response->mainDocument)) {
$documents = $this
->query(Predicates::at("document.id", $response->mainDocument), ['ref' => $token, 'lang' => '*'])
@@ -227,120 +244,52 @@ public function previewSession($token, $linkResolver, $defaultUrl)
}
/**
- * Returning the URL of the endpoint to initiate OAuth authentication.
- *
- * @return string the URL of the endpoint
+ * Return the URL of the endpoint to initiate OAuth authentication.
*/
- public function oauthInitiateEndpoint()
+ public function oauthInitiateEndpoint() : string
{
return $this->data->getOauthInitiate();
}
/**
- * Returning the URL of the endpoint to use OAuth authentication.
- *
- * @return string the URL of the endpoint
+ * Return the URL of the endpoint to use OAuth authentication.
*/
- public function oauthTokenEndpoint()
+ public function oauthTokenEndpoint() : string
{
return $this->data->getOauthToken();
}
/**
* Accessing raw data returned by the /api endpoint
- *
- * @return ApiData the raw data
*/
- public function getData()
+ public function getData() : ApiData
{
return $this->data;
}
/**
* Accessing the cache object specifying how to store the cache
- *
- * @return CacheInterface the cache object itself
*/
- public function getCache()
+ public function getCache() : CacheInterface
{
return $this->cache;
}
/**
* Accessing the underlying Guzzle HTTP client
- *
- * @return HttpAdapterInterface
*/
- public function getHttpClient()
+ public function getHttpClient() : ClientInterface
{
return $this->httpClient;
}
- /**
- * This is the endpoint to build your API, and is a static method.
- * If your API is set to "public" or "open", you can instantiate your Api object just like this:
- * Api::get('https://your-repository-name.prismic.io/api/v2')
- *
- * @param string $action the URL of your repository API's endpoint
- * @param string $accessToken a permanent access token to use to access your content, for instance if your repository API is set to private
- * @param Client $httpClient Custom Guzzle http client
- * @param CacheInterface $cache Cache implementation
- * @param int $apiCacheTTL max time to keep the API object in cache (in seconds)
- *
- * \throws RuntimeException
- *
- * @return Api the Api object, usable to perform queries
- */
- public static function get($action, $accessToken = null, $httpClient = null, CacheInterface $cache = null, $apiCacheTTL = 5)
- {
- $cache = is_null($cache) ? self::defaultCache() : $cache;
- $cacheKey = $action . (is_null($accessToken) ? "" : ("#" . $accessToken));
- $apiData = $cache->get($cacheKey);
- $api = $apiData ? new Api(unserialize($apiData), $accessToken, $httpClient, $cache) : null;
- if ($api) {
- return $api;
- } else {
- $url = $action . ($accessToken ? '?access_token=' . $accessToken : '');
- $httpClient = is_null($httpClient) ? new Client() : $httpClient;
- $response = $httpClient->get($url);
- $response = json_decode($response->getBody(true));
- $experiments = isset($response->experiments)
- ? Experiments::parse($response->experiments)
- : new Experiments(array(), array());
-
- if (!$response) {
- throw new \RuntimeException('Unable to decode the json response');
- }
-
- $apiData = new ApiData(
- array_map(
- function ($ref) {
- return Ref::parse($ref);
- },
- $response->refs
- ),
- (array)$response->bookmarks,
- (array)$response->types,
- $response->tags,
- (array)$response->forms,
- $experiments,
- $response->oauth_initiate,
- $response->oauth_token
- );
-
- $api = new Api($apiData, $accessToken, $httpClient, $cache);
- $cache->set($cacheKey, serialize($apiData), $apiCacheTTL);
-
- return $api;
- }
- }
-
/**
* Submit several requests in parallel
*
+ * @TODO Discover the use-case for this method and either refactor it or remove it
* @return array
*/
- public function submit()
+ public function submit() : array
{
$numargs = func_num_args();
if ($numargs == 1 && is_array(func_get_arg(0))) {
@@ -348,7 +297,7 @@ public function submit()
} else {
$forms = func_get_args();
}
- $responses = array();
+ $responses = [];
// Get what we can from the cache
$all_urls = [];
@@ -379,8 +328,8 @@ public function submit()
$cacheDuration = (int) $groups[1];
}
$json = json_decode($response->getBody(true));
- if (!isset($json)) {
- throw new \RuntimeException("Unable to decode json response");
+ if (! isset($json)) {
+ throw new Exception\RuntimeException("Unable to decode json response");
}
if ($cacheDuration !== null) {
$expiration = $cacheDuration;
@@ -397,10 +346,8 @@ public function submit()
/**
* If a preview cookie is set, return the ref stored in that cookie
- *
- * @return string|null
*/
- private function getPreviewRef()
+ private function getPreviewRef() :? string
{
$cookieNames = [
str_replace(['.',' '], '_', self::PREVIEW_COOKIE),
@@ -417,10 +364,8 @@ private function getPreviewRef()
/**
* If an experiment cookie is set, return the ref as determined by \Prismic\Experiments::refFromCookie
- *
- * @return string|null
*/
- private function getExperimentRef()
+ private function getExperimentRef() :? string
{
$cookieNames = [
str_replace(['.',' '], '_', self::EXPERIMENTS_COOKIE),
@@ -438,20 +383,16 @@ private function getExperimentRef()
/**
* Whether the current ref in use is a preview, i.e. the user is in preview mode
- *
- * @return bool
*/
- public function inPreview()
+ public function inPreview() : bool
{
return null !== $this->getPreviewRef();
}
/**
- * Whether the current ref in use is an experiment.
- *
- * @return bool
+ * Whether the current ref in use is an experiment
*/
- public function inExperiment()
+ public function inExperiment() : bool
{
return null !== $this->getExperimentRef() && false === $this->inPreview();
}
@@ -460,10 +401,8 @@ public function inExperiment()
* Return the ref currently in use
*
* In order of preference, returns the preview cookie, the experiments cookie or the master ref otherwise
- *
- * @return string
*/
- public function ref()
+ public function ref() : string
{
$preview = $this->getPreviewRef();
if ($preview) {
@@ -480,15 +419,16 @@ public function ref()
* Shortcut to query on the default reference.
* Use the reference from previews or experiment cookie, fallback to the master reference otherwise.
*
- * @param string|array|\Prismic\Predicate $q the query, as a string, predicate or array of predicates
- * @param array $options query options: pageSize, orderings, etc.
- *
- * @return Prismic::Response the response, including documents and pagination information
+ * @param string|array|Predicate $q the query, as a string, predicate or array of predicates
+ * @param array $options query options: pageSize, orderings, etc.
+ * @return stdClass
*/
- public function query($q, $options = array()) {
+ public function query($q, array $options = []) : stdClass
+ {
$ref = $this->ref();
- $form = $this->forms()->everything->ref($ref);
- if ($q != null && $q != "") {
+ /** @var SearchForm $form */
+ $form = $this->form('everything')->ref($ref);
+ if (! empty($q)) {
$form = $form->query($q);
}
foreach ($options as $key => $value) {
@@ -501,12 +441,13 @@ public function query($q, $options = array()) {
* Return the first document matching the query
* Use the reference from previews or experiment cookie, fallback to the master reference otherwise.
*
- * @param string|array|\Prismic\Predicate $q the query, as a string, predicate or array of predicates
- * @param array $options query options: pageSize, orderings, etc.
+ * @param string|array|Predicate $q the query, as a string, predicate or array of predicates
+ * @param array $options query options: pageSize, orderings, etc.
*
- * @return Prismic::Document the resulting document, or null
+ * @return stdClass|null the resulting document, or null
*/
- public function queryFirst($q, $options = array()) {
+ public function queryFirst($q, array $options = []) :? stdClass
+ {
$documents = $this->query($q, $options)->results;
if (count($documents) > 0) {
return $documents[0];
@@ -520,10 +461,11 @@ public function queryFirst($q, $options = array()) {
* @param string $id the requested id
* @param array $options query options: pageSize, orderings, etc.
*
- * @return Prismic::Document the resulting document (null if no match)
+ * @return stdClass|null the resulting document (null if no match)
*/
- public function getByID($id, $options = array()) {
- if(!isset($options['lang'])) $options['lang'] = '*';
+ public function getByID(string $id, array $options = []) :? stdClass
+ {
+ $options = $this->prepareDefaultQueryOptions($options);
return $this->queryFirst(Predicates::at("document.id", $id), $options);
}
@@ -533,24 +475,25 @@ public function getByID($id, $options = array()) {
* @param string $type the custom type of the requested document
* @param string $uid the requested uid
* @param array $options query options: pageSize, orderings, etc.
- *
- * @return Prismic::Document the resulting document (null if no match)
+ * @return stdClass|null the resulting document (null if no match)
*/
- public function getByUID($type, $uid, $options = array()) {
- if(!isset($options['lang'])) $options['lang'] = '*';
+ public function getByUID(string $type, string $uid, array $options = []) :? stdClass
+ {
+ $options = $this->prepareDefaultQueryOptions($options);
return $this->queryFirst(Predicates::at("my.".$type.".uid", $uid), $options);
}
/**
* Return a set of document from their ids
*
- * @param array $ids array of strings, the requested ids
- * @param array $options query options: pageSize, orderings, etc.
+ * @param array $ids array of strings, the requested ids
+ * @param array $options query options: pageSize, orderings, etc.
*
- * @return Prismic::Response the response, including documents and pagination information
+ * @return stdClass the response, including documents and pagination information
*/
- public function getByIDs($ids, $options = array()) {
- if(!isset($options['lang'])) $options['lang'] = '*';
+ public function getByIDs(array $ids, array $options = []) : stdClass
+ {
+ $options = $this->prepareDefaultQueryOptions($options);
return $this->query(Predicates::in("document.id", $ids), $options);
}
@@ -560,18 +503,17 @@ public function getByIDs($ids, $options = array()) {
* @param string $type the custom type of the requested document
* @param array $options query options: pageSize, orderings, etc.
*
- * @return Prismic::Document the resulting document (null if no match)
+ * @return stdClass|null the resulting document (null if no match)
*/
- public function getSingle($type, $options = array()) {
+ public function getSingle(string $type, array $options = []) :? stdClass
+ {
return $this->queryFirst(Predicates::at("document.type", $type), $options);
}
/**
* Use the APC cache if APC is activated on the server, otherwise fallback to the noop cache (no cache)
- *
- * @return ApcCache::NoCache
*/
- public static function defaultCache()
+ public static function defaultCache() : CacheInterface
{
if (extension_loaded('apc') && ini_get('apc.enabled')) {
return new ApcCache();
@@ -579,4 +521,17 @@ public static function defaultCache()
return new NoCache();
}
+ /**
+ * Given an options array for a query, fill the lang parameter with a default value
+ * @param array $options
+ * @return array
+ */
+ private function prepareDefaultQueryOptions(array $options) : array
+ {
+ if (! isset($options['lang'])) {
+ $options['lang'] = '*';
+ }
+
+ return $options;
+ }
}
diff --git a/src/Prismic/ApiData.php b/src/Prismic/ApiData.php
index d51bcb8a..32fcbfd6 100644
--- a/src/Prismic/ApiData.php
+++ b/src/Prismic/ApiData.php
@@ -1,28 +1,59 @@
refs = $refs;
$this->bookmarks = $bookmarks;
@@ -57,82 +88,111 @@ public function __construct(
$this->oauth_token = $oauth_token;
}
+ /**
+ * Return a new ApiData instance from the given JSON string
+ * @param string $json
+ * @return self
+ */
+ public static function withJsonString(string $json) : self
+ {
+ $data = json_decode($json);
+ if (! $data) {
+ throw new Exception\RuntimeException(sprintf(
+ 'Unable to decode JSON response: %s',
+ json_last_error_msg()
+ ), json_last_error());
+ }
+ return self::withJsonObject($data);
+ }
+
+ /**
+ * Return a new ApiData instance from the given JSON decoded object
+ * @param stdClass $json
+ * @return self
+ */
+ public static function withJsonObject(stdClass $json) : self
+ {
+ $experiments = isset($json->experiments)
+ ? Experiments::parse($json->experiments)
+ : Experiments::parse(new stdClass);
+ return new self(
+ array_map(
+ function ($ref) {
+ return Ref::parse($ref);
+ },
+ $json->refs
+ ),
+ (array)$json->bookmarks,
+ (array)$json->types,
+ $json->tags,
+ (array)$json->forms,
+ $experiments,
+ $json->oauth_initiate,
+ $json->oauth_token
+ );
+ }
+
/**
* Get the refs
- *
- * @return array
+ * @return Ref[]
*/
- public function getRefs()
+ public function getRefs() : array
{
return $this->refs;
}
/**
* Get the bookmarks
- *
- * @return array
*/
- public function getBookmarks()
+ public function getBookmarks() : array
{
return $this->bookmarks;
}
/**
* Get the types
- *
- * @return array
*/
- public function getTypes()
+ public function getTypes() : array
{
return $this->types;
}
/**
* Get the tags
- *
- * @return array
*/
- public function getTags()
+ public function getTags() : array
{
return $this->tags;
}
/**
* Get the forms
- *
- * @return array
*/
- public function getForms()
+ public function getForms() : array
{
return $this->forms;
}
/**
* Get the Experiments
- *
- * @return Experiments
*/
- public function getExperiments()
+ public function getExperiments() : Experiments
{
return $this->experiments;
}
/**
* Get the endpoint to initiate OAuth
- *
- * @return string
*/
- public function getOauthInitiate()
+ public function getOauthInitiate() : string
{
return $this->oauth_initiate;
}
/**
* Get the endpoint to run OAuth
- *
- * @return string
*/
- public function getOauthToken()
+ public function getOauthToken() : string
{
return $this->oauth_token;
}
diff --git a/src/Prismic/Cache/ApcCache.php b/src/Prismic/Cache/ApcCache.php
index 6560ff59..0333aa5c 100644
--- a/src/Prismic/Cache/ApcCache.php
+++ b/src/Prismic/Cache/ApcCache.php
@@ -28,7 +28,7 @@ public function has($key)
public function get($key)
{
$value = \apcu_fetch($key, $success);
- if (!$success) {
+ if (! $success) {
return null;
}
return $value;
diff --git a/src/Prismic/Cache/CacheInterface.php b/src/Prismic/Cache/CacheInterface.php
index 82666781..3031884a 100644
--- a/src/Prismic/Cache/CacheInterface.php
+++ b/src/Prismic/Cache/CacheInterface.php
@@ -41,7 +41,7 @@ public function get($key);
* Stores a new cache entry
*
* @param string $key the key of the cache entry
- * @param \stdClass $value the value of the entry
+ * @param mixed $value the value of the entry
* @param int $ttl the time (in seconds) until this cache entry expires
* @return void
*/
diff --git a/src/Prismic/Dom/BlockGroup.php b/src/Prismic/Dom/BlockGroup.php
index 7cf47999..ebe48830 100644
--- a/src/Prismic/Dom/BlockGroup.php
+++ b/src/Prismic/Dom/BlockGroup.php
@@ -1,4 +1,5 @@
maybeTag = $maybeTag;
$this->blocks = $blocks;
@@ -47,7 +48,7 @@ public function addBlock($block)
*
* @return string the tag to use if should be (values are either "ul", "ol" or null).
*/
- public function getTag()
+ public function getTag() :? string
{
return $this->maybeTag;
}
@@ -57,7 +58,7 @@ public function getTag()
*
* @return array the array of BlockInterface objects that are being grouped here
*/
- public function getBlocks()
+ public function getBlocks() : array
{
return $this->blocks;
}
diff --git a/src/Prismic/Dom/Date.php b/src/Prismic/Dom/Date.php
index f27091a4..40404580 100644
--- a/src/Prismic/Dom/Date.php
+++ b/src/Prismic/Dom/Date.php
@@ -1,4 +1,5 @@
getTag() && $block->type === 'o-list-item') {
$lastOne->addBlock($block);
} elseif ($block->type === 'list-item') {
- $newBlockGroup = new BlockGroup('ul', array());
+ $newBlockGroup = new BlockGroup('ul', []);
$newBlockGroup->addBlock($block);
array_push($groups, $newBlockGroup);
} else {
if ($block->type === 'o-list-item') {
- $newBlockGroup = new BlockGroup('ol', array());
+ $newBlockGroup = new BlockGroup('ol', []);
$newBlockGroup->addBlock($block);
array_push($groups, $newBlockGroup);
} else {
- $newBlockGroup = new BlockGroup(null, array());
+ $newBlockGroup = new BlockGroup(null, []);
$newBlockGroup->addBlock($block);
array_push($groups, $newBlockGroup);
}
@@ -80,7 +80,7 @@ public static function asHtml($richText, $linkResolver = null, $htmlSerializer =
} else {
$tag = null;
}
- $newBlockGroup = new BlockGroup($tag, array());
+ $newBlockGroup = new BlockGroup($tag, []);
$newBlockGroup->addBlock($block);
array_push($groups, $newBlockGroup);
}
@@ -154,15 +154,15 @@ private static function insertSpans($text, array $spans, $linkResolver = null, $
return htmlentities($text, null, 'UTF-8');
}
- $tagsStart = array();
- $tagsEnd = array();
+ $tagsStart = [];
+ $tagsEnd = [];
foreach ($spans as $span) {
- if (!array_key_exists($span->start, $tagsStart)) {
- $tagsStart[$span->start] = array();
+ if (! array_key_exists($span->start, $tagsStart)) {
+ $tagsStart[$span->start] = [];
}
- if (!array_key_exists($span->end, $tagsEnd)) {
- $tagsEnd[$span->end] = array();
+ if (! array_key_exists($span->end, $tagsEnd)) {
+ $tagsEnd[$span->end] = [];
}
array_push($tagsStart[$span->start], $span);
array_push($tagsEnd[$span->end], $span);
@@ -170,7 +170,7 @@ private static function insertSpans($text, array $spans, $linkResolver = null, $
$c = null;
$html = '';
- $stack = array();
+ $stack = [];
for ($pos = 0, $len = strlen($text) + 1; $pos < $len; $pos++) { // Looping to length + 1 to catch closing tags
if (array_key_exists($pos, $tagsEnd)) {
@@ -179,16 +179,18 @@ private static function insertSpans($text, array $spans, $linkResolver = null, $
$tag = array_pop($stack);
// Continue only if block contains content.
if ($tag && $tag['span']) {
- $innerHtml = trim(RichText::serialize($tag['span'], $tag['text'], $linkResolver, $htmlSerializer));
- if (count($stack) == 0) {
- // The tag was top level
- $html .= $innerHtml;
- } else {
- // Add the content to the parent tag
- $last = array_pop($stack);
- $last['text'] = $last['text'] . $innerHtml;
- array_push($stack, $last);
- }
+ $innerHtml = trim(
+ RichText::serialize($tag['span'], $tag['text'], $linkResolver, $htmlSerializer)
+ );
+ if (count($stack) == 0) {
+ // The tag was top level
+ $html .= $innerHtml;
+ } else {
+ // Add the content to the parent tag
+ $last = array_pop($stack);
+ $last['text'] = $last['text'] . $innerHtml;
+ array_push($stack, $last);
+ }
}
}
}
@@ -201,10 +203,10 @@ private static function insertSpans($text, array $spans, $linkResolver = null, $
usort($sspans, $spanSort);
foreach ($sspans as $span) {
// Open a tag
- array_push($stack, array(
+ array_push($stack, [
'span' => $span,
'text' => ''
- ));
+ ]);
}
}
if ($pos < strlen($text)) {
@@ -216,10 +218,10 @@ private static function insertSpans($text, array $spans, $linkResolver = null, $
// Inner text of a span
$last_idx = count($stack) - 1;
$last = $stack[$last_idx];
- $stack[$last_idx] = array(
+ $stack[$last_idx] = [
'span' => $last['span'],
'text' => $last['text'] . htmlentities($c, null, 'UTF-8')
- );
+ ];
}
}
}
@@ -238,7 +240,7 @@ private static function insertSpans($text, array $spans, $linkResolver = null, $
*
* @return string the HTML representation of the element
*/
- private static function serialize($element, $content, $linkResolver, $htmlSerializer)
+ private static function serialize($element, $content, $linkResolver, $htmlSerializer) : string
{
if ($htmlSerializer) {
$custom = $htmlSerializer($element, $content);
@@ -286,17 +288,19 @@ private static function serialize($element, $content, $linkResolver, $htmlSerial
$providerAttr = ' data-oembed-provider="' . strtolower($element->oembed->provider_name) . '"';
}
if ($element->oembed->html) {
- return (
- '
' .
- $element->oembed->html .
- '
'
+ return sprintf(
+ '
%s
',
+ $element->oembed->embed_url,
+ strtolower($element->oembed->type),
+ $providerAttr,
+ $element->oembed->html
);
}
return '';
}
// Spans
- $attributes = array();
+ $attributes = [];
switch ($element->type) {
case 'strong':
$nodeName = 'strong';
@@ -307,10 +311,10 @@ private static function serialize($element, $content, $linkResolver, $htmlSerial
case 'hyperlink':
$nodeName = 'a';
if (isset($element->data->target)) {
- $attributes = array_merge(array(
+ $attributes = array_merge([
'target' => $element->data->target,
'rel' => 'noopener',
- ), $attributes);
+ ], $attributes);
}
if ($element->data->link_type === 'Document') {
$attributes['href'] = $linkResolver ? $linkResolver($element->data) : '';
diff --git a/src/Prismic/Exception/ExceptionInterface.php b/src/Prismic/Exception/ExceptionInterface.php
new file mode 100644
index 00000000..07155a80
--- /dev/null
+++ b/src/Prismic/Exception/ExceptionInterface.php
@@ -0,0 +1,9 @@
+guzzleException = $e;
+ return $exception;
+ }
+
+ /**
+ * Factory to wrap a Guzzle Request Exception when we should have access to a request and a response
+ */
+ protected static function fromGuzzleRequestException(RequestException $e) : self
+ {
+ $response = $e->getResponse();
+ $code = $response ? $response->getStatusCode() : 0;
+ $reason = $response ? $response->getReasonPhrase() : 'No Response';
+ $request = $e->getRequest();
+ $url = $request->getUri();
+
+ $message = sprintf(
+ 'The %s request to the repository %s resulted in a %d %s error. Complete URL: %s',
+ $request->getMethod(),
+ $url->getHost(),
+ $code,
+ $reason,
+ (string) $url
+ );
+
+ $exception = new static($message, $code, $e);
+ $exception->guzzleException = $e;
+ return $exception;
+ }
+
+ public function getResponse() :? ResponseInterface
+ {
+ if (! $this->guzzleException instanceof RequestException) {
+ return null;
+ }
+ return $this->guzzleException->getResponse();
+ }
+
+ public function getRequest() :? RequestInterface
+ {
+ if (! $this->guzzleException instanceof RequestException) {
+ return null;
+ }
+ return $this->guzzleException->getRequest();
+ }
+}
diff --git a/src/Prismic/Exception/RuntimeException.php b/src/Prismic/Exception/RuntimeException.php
new file mode 100644
index 00000000..f5a99523
--- /dev/null
+++ b/src/Prismic/Exception/RuntimeException.php
@@ -0,0 +1,9 @@
+id = $id;
+ $this->googleId = $googleId;
+ $this->name = $name;
+ $this->variations = $variations;
+ }
+
+ public function getId() : string
+ {
+ return $this->id;
+ }
+
+ public function getGoogleId() :? string
+ {
+ return $this->googleId;
+ }
+
+ public function getName() : string
+ {
+ return $this->name;
+ }
+
+ /**
+ * @return Variation[]
+ */
+ public function getVariations() : array
+ {
+ return $this->variations;
+ }
+
+ public static function parse(stdClass $json) : self
+ {
+ $googleId = (isset($json->googleId) ? $json->googleId : null);
+ $vars = array_map(function ($varJson) {
+ return Variation::parse($varJson);
+ }, $json->variations);
+ return new self(
+ $json->id,
+ $googleId,
+ $json->name,
+ $vars
+ );
+ }
+}
diff --git a/src/Prismic/Experiments.php b/src/Prismic/Experiments.php
index aa2cf040..1379631c 100644
--- a/src/Prismic/Experiments.php
+++ b/src/Prismic/Experiments.php
@@ -1,55 +1,65 @@
draft = $draft;
+ $this->draft = $draft;
$this->running = $running;
}
/**
- * @return Experiment
+ * Return the current running Experiment
*/
- public function getCurrent()
+ public function getCurrent() :? Experiment
{
- if (count($this->running) > 0)
- {
+ if (count($this->running) > 0) {
return $this->running[0];
}
return null;
}
/**
- * @param string|null $cookie
- *
- * @return Ref|null
+ * Given the value of an experiment cookie, return the corresponding Ref as a string
+ * @param null|string $cookie
+ * @return null|string
*/
- public function refFromCookie($cookie)
+ public function refFromCookie(?string $cookie) :? string
{
- if ($cookie == null) return null;
+ if (empty($cookie)) {
+ return null;
+ }
$splitted = explode(" ", $cookie);
- if (count($splitted) >= 2)
- {
+ if (count($splitted) >= 2) {
$experiment = $this->findRunningById($splitted[0]);
- if ($experiment == null) return null;
+ if (! $experiment) {
+ return null;
+ }
+ /** @var Variation[] $variations */
$variations = $experiment->getVariations();
$varIndex = (int)($splitted[1]);
if ($varIndex > -1 && $varIndex < count($variations)) {
@@ -59,18 +69,12 @@ public function refFromCookie($cookie)
return null;
}
- /**
- * @return array
- */
- public function getDraft()
+ public function getDraft() : array
{
return $this->draft;
}
- /**
- * @return array
- */
- public function getRunning()
+ public function getRunning() : array
{
return $this->running;
}
@@ -78,171 +82,34 @@ public function getRunning()
/**
* Parses a given experiments. Not meant to be used except for testing.
*
- * @param $json the json bit retrieved from the API that represents experiments.
- * @return Prismic::Experiments the manipulable object for the experiments.
+ * @param stdClass $json the json bit retrieved from the API that represents experiments.
+ * @return self the manipulable object for the experiments.
*/
- public static function parse(\stdClass $json)
+ public static function parse(stdClass $json) : self
{
- return new Experiments(
- array_map(function ($exp) { return Experiment::parse($exp); }, $json->draft),
- array_map(function ($exp) { return Experiment::parse($exp); }, $json->running)
+ return new self(
+ array_map(function ($exp) {
+ return Experiment::parse($exp);
+ }, $json->draft),
+ array_map(function ($exp) {
+ return Experiment::parse($exp);
+ }, $json->running)
);
}
/**
+ * Find the running experiment with the given Google ID
* @param string $id
- *
- * @return Experiment|null
+ * @return null|Experiment
*/
- private function findRunningById($id)
+ private function findRunningById(string $id) :? Experiment
{
/** @var Experiment $exp */
- foreach ($this->running as $exp)
- {
- if ($exp->getGoogleId() == $id) {
+ foreach ($this->running as $exp) {
+ if ($exp->getGoogleId() === $id) {
return $exp;
}
}
return null;
}
}
-
-/**
- * Class Experiment
- *
- * @package Prismic
- */
-class Experiment {
-
- /** @var string */
- private $id;
- /** @var string */
- private $googleId;
- /** @var string */
- private $name;
- /** @var array */
- private $variations;
-
- /**
- * @param string $id
- * @param string $googleId
- * @param string $name
- * @param array $variations
- */
- public function __construct($id, $googleId, $name, array $variations)
- {
- $this->id = $id;
- $this->googleId = $googleId;
- $this->name = $name;
- $this->variations = $variations;
- }
-
- /**
- * @return string
- */
- public function getId() {
- return $this->id;
- }
-
- /**
- * @return string
- */
- public function getGoogleId() {
- return $this->googleId;
- }
-
- /**
- * @return string
- */
- public function getName() {
- return $this->name;
- }
-
- /**
- * @return array
- */
- public function getVariations() {
- return $this->variations;
- }
-
- /**
- * Parses a given experiment. Not meant to be used except for testing.
- *
- * @param $json the json bit retrieved from the API that represents a experiment.
- *
- * @return Prismic::Variation the manipulable object for that experiment.
- */
- public static function parse(\stdClass $json)
- {
- $googleId = (isset($json->googleId) ? $json->googleId : 0);
- $vars = array_map(function ($varJson) { return Variation::parse($varJson); }, $json->variations);
- return new Experiment(
- $json->id,
- $googleId,
- $json->name,
- $vars
- );
- }
-
-}
-
-/**
- * Class Variation
- *
- * @package Prismic
- */
-class Variation
-{
- /** @var string */
- private $id;
- /** @var string */
- private $ref;
- /** @var string */
- private $label;
-
- /**
- * @param string $id
- * @param string $ref
- * @param string $label
- */
- public function __construct($id, $ref, $label)
- {
- $this->id = $id;
- $this->ref = $ref;
- $this->label = $label;
- }
-
- /**
- * @return string
- */
- public function getId() {
- return $this->id;
- }
-
- /**
- * @return string
- */
- public function getRef() {
- return $this->ref;
- }
-
- /**
- * @return string
- */
- public function getLabel() {
- return $this->label;
- }
-
- /**
- * Parses a given variation. Not meant to be used except for testing.
- *
- * @param $json the json bit retrieved from the API that represents a variation.
- *
- * @return Prismic::Variation the manipulable object for that variation.
- */
- public static function parse(\stdClass $json)
- {
- return new Variation($json->id, $json->ref, $json->label);
- }
-
-}
diff --git a/src/Prismic/FieldForm.php b/src/Prismic/FieldForm.php
index 24ac6fc7..3be479fd 100644
--- a/src/Prismic/FieldForm.php
+++ b/src/Prismic/FieldForm.php
@@ -1,23 +1,26 @@
type = $type;
$this->multiple = $multiple;
@@ -37,30 +40,24 @@ public function __construct($type, $multiple, $defaultValue)
/**
* Returns the type of the field.
- *
- * @return string the type of the field.
*/
- public function getType()
+ public function getType() : string
{
return $this->type;
}
/**
* Returns the default value.
- *
- * @return string the default value.
*/
- public function getDefaultValue()
+ public function getDefaultValue() :? string
{
return $this->defaultValue;
}
/**
* Returns whether the parameter can be used multiple times.
- *
- * @return boolean true if the parameter can be used multiple times, false otherwise.
*/
- public function isMultiple()
+ public function isMultiple() : bool
{
return $this->multiple;
}
diff --git a/src/Prismic/Form.php b/src/Prismic/Form.php
index a1c38756..35610764 100644
--- a/src/Prismic/Form.php
+++ b/src/Prismic/Form.php
@@ -1,55 +1,81 @@
maybeName = $maybeName;
- $this->method = $method;
- $this->maybeRel = $maybeRel;
+ private function __construct(
+ ?string $name = null,
+ string $method,
+ ?string $rel = null,
+ string $enctype,
+ string $action,
+ array $fields
+ ) {
+ $this->name = $name;
+ $this->method = $method;
+ $this->rel = $rel;
$this->enctype = $enctype;
- $this->action = $action;
- $this->fields = $fields;
+ $this->action = $action;
+ $this->fields = $fields;
}
/**
@@ -57,18 +83,18 @@ public function __construct($maybeName, $method, $maybeRel, $enctype, $action, $
*
* @return array the array of arguments that will be passed
*/
- public function defaultData()
+ public function defaultData() : array
{
/**
* @var string $key
* @var FieldForm $field
*/
- $dft = array();
+ $dft = [];
foreach ($this->fields as $key => $field) {
$default = $field->getDefaultValue();
if (isset($default)) {
if ($field->isMultiple()) {
- $default = array($default);
+ $default = [$default];
}
$dft[$key] = $default;
}
@@ -77,63 +103,97 @@ public function defaultData()
return $dft;
}
+ /**
+ * Return a new instance from a JSON string
+ * @param string $json
+ * @return self
+ */
+ public static function withJsonString(string $json) : self
+ {
+ $data = \json_decode($json);
+ return self::withJsonObject($data);
+ }
+
+ /**
+ * Return a new instance from unserialized JSON
+ * @param stdClass $json
+ * @return self
+ */
+ public static function withJsonObject(stdClass $json) : self
+ {
+ $fields = [];
+ foreach ($json->fields as $name => $field) {
+ $default = isset($field->default) ? $field->default : null;
+ $multiple = isset($field->multiple) ? $field->multiple : false;
+ $fields[$name] = new FieldForm($field->type, $multiple, $default);
+ }
+
+ return new self(
+ isset($json->name) ? $json->name : null,
+ $json->method,
+ isset($json->rel) ? $json->rel : null,
+ $json->enctype,
+ $json->action,
+ $fields
+ );
+ }
+
/**
* Returns the name
- *
- * @return string the name
*/
- public function getName()
+ public function getName() :? string
{
- return $this->maybeName;
+ return $this->name;
}
/**
* Returns the method
- *
- * @return string the method
*/
- public function getMethod()
+ public function getMethod() : string
{
return $this->method;
}
/**
* Returns the rel
- *
- * @return string the rel
*/
- public function getRel()
+ public function getRel() :? string
{
- return $this->maybeRel;
+ return $this->rel;
}
/**
* Returns the enctype
- *
- * @return string the enctype
*/
- public function getEnctype()
+ public function getEnctype() : string
{
return $this->enctype;
}
/**
* Returns the action
- *
- * @return string the action
*/
- public function getAction()
+ public function getAction() : string
{
return $this->action;
}
/**
* Returns the fields
- *
- * @return string the fields
+ * @return FieldForm[]
*/
- public function getFields()
+ public function getFields() : array
{
return $this->fields;
}
+
+ /**
+ * Return a single field by name
+ */
+ public function getField(string $name) :? FieldForm
+ {
+ return isset($this->fields[$name])
+ ? $this->fields[$name]
+ : null;
+ }
}
diff --git a/src/Prismic/LinkResolver.php b/src/Prismic/LinkResolver.php
index 3ced1817..60c7e785 100644
--- a/src/Prismic/LinkResolver.php
+++ b/src/Prismic/LinkResolver.php
@@ -1,10 +1,11 @@
prismic.io's API documentation
+ * Prismic's API documentation
* to better understand the idea.
*/
abstract class LinkResolver
@@ -24,9 +25,9 @@ abstract class LinkResolver
*
* @param object $link The document link
*
- * @return string The URL of the link
+ * @return string|null The URL of the link
*/
- abstract public function resolve($link);
+ abstract public function resolve($link) :? string;
/**
* What happens when the link resolver gets called.
@@ -34,9 +35,9 @@ abstract public function resolve($link);
*
* @param object $link The document link
*
- * @return string The URL of the link
+ * @return string|null The URL of the link
*/
- public function __invoke($link)
+ public function __invoke($link) :? string
{
return $this->resolve($link);
}
diff --git a/src/Prismic/Predicate.php b/src/Prismic/Predicate.php
index a7bc83d4..8094cfc0 100644
--- a/src/Prismic/Predicate.php
+++ b/src/Prismic/Predicate.php
@@ -1,4 +1,5 @@
getTimestamp() * 1000;
}
- return new SimplePredicate("date.before", $fragment, array($before));
+ return new SimplePredicate("date.before", $fragment, [$before]);
}
/**
- * @param string $fragment
- * @param DateTime|int $after
+ * @param string $fragment
+ * @param DateTime|string $after
*
* @return SimplePredicate
*/
- public static function dateAfter($fragment, $after) {
+ public static function dateAfter(string $fragment, $after) : SimplePredicate
+ {
if ($after instanceof DateTime) {
$after = $after->getTimestamp() * 1000;
}
- return new SimplePredicate("date.after", $fragment, array($after));
+ return new SimplePredicate("date.after", $fragment, [$after]);
}
/**
- * @param string $fragment
- * @param DateTime|int $before
- * @param DateTime|int $after
+ * @param string $fragment
+ * @param DateTime|string $before
+ * @param DateTime|string $after
*
* @return SimplePredicate
*/
- public static function dateBetween($fragment, $before, $after) {
+ public static function dateBetween(string $fragment, $before, $after) : SimplePredicate
+ {
if ($before instanceof DateTime) {
$before = $before->getTimestamp() * 1000;
}
if ($after instanceof DateTime) {
$after = $after->getTimestamp() * 1000;
}
- return new SimplePredicate("date.between", $fragment, array($before, $after));
+ return new SimplePredicate("date.between", $fragment, [$before, $after]);
}
/**
* @param string $fragment
- * @param string $day
+ * @param int $day
*
* @return SimplePredicate
*/
- public static function dayOfMonth($fragment, $day) {
- return new SimplePredicate("date.day-of-month", $fragment, array($day));
+ public static function dayOfMonth(string $fragment, int $day) : SimplePredicate
+ {
+ return new SimplePredicate("date.day-of-month", $fragment, [$day]);
}
/**
* @param string $fragment
- * @param string $day
+ * @param int $day
*
* @return SimplePredicate
*/
- public static function dayOfMonthBefore($fragment, $day) {
- return new SimplePredicate("date.day-of-month-before", $fragment, array($day));
+ public static function dayOfMonthBefore(string $fragment, int $day) : SimplePredicate
+ {
+ return new SimplePredicate("date.day-of-month-before", $fragment, [$day]);
}
/**
* @param string $fragment
- * @param string $day
+ * @param int $day
*
* @return SimplePredicate
*/
- public static function dayOfMonthAfter($fragment, $day) {
- return new SimplePredicate("date.day-of-month-after", $fragment, array($day));
+ public static function dayOfMonthAfter(string $fragment, int $day) : SimplePredicate
+ {
+ return new SimplePredicate("date.day-of-month-after", $fragment, [$day]);
}
/**
- * @param string $fragment
- * @param string $day
+ * @param string $fragment
+ * @param string|int $day
*
* @return SimplePredicate
*/
- public static function dayOfWeek($fragment, $day) {
- return new SimplePredicate("date.day-of-week", $fragment, array($day));
+ public static function dayOfWeek(string $fragment, $day) : SimplePredicate
+ {
+ return new SimplePredicate("date.day-of-week", $fragment, [$day]);
}
/**
- * @param string $fragment
- * @param string $day
+ * @param string $fragment
+ * @param string|int $day
*
* @return SimplePredicate
*/
- public static function dayOfWeekBefore($fragment, $day) {
- return new SimplePredicate("date.day-of-week-before", $fragment, array($day));
+ public static function dayOfWeekBefore(string $fragment, $day) : SimplePredicate
+ {
+ return new SimplePredicate("date.day-of-week-before", $fragment, [$day]);
}
/**
- * @param string $fragment
- * @param string $day
+ * @param string $fragment
+ * @param string|int $day
*
* @return SimplePredicate
*/
- public static function dayOfWeekAfter($fragment, $day) {
- return new SimplePredicate("date.day-of-week-after", $fragment, array($day));
+ public static function dayOfWeekAfter(string $fragment, $day) : SimplePredicate
+ {
+ return new SimplePredicate("date.day-of-week-after", $fragment, [$day]);
}
/**
- * @param string $fragment
- * @param string $month
+ * @param string $fragment
+ * @param string|int $month
*
* @return SimplePredicate
*/
- public static function month($fragment, $month) {
- return new SimplePredicate("date.month", $fragment, array($month));
+ public static function month(string $fragment, $month) : SimplePredicate
+ {
+ return new SimplePredicate("date.month", $fragment, [$month]);
}
/**
- * @param string $fragment
- * @param string $month
+ * @param string $fragment
+ * @param string|int $month
*
* @return SimplePredicate
*/
- public static function monthBefore($fragment, $month) {
- return new SimplePredicate("date.month-before", $fragment, array($month));
+ public static function monthBefore(string $fragment, $month) : SimplePredicate
+ {
+ return new SimplePredicate("date.month-before", $fragment, [$month]);
}
/**
- * @param string $fragment
- * @param string $month
+ * @param string $fragment
+ * @param string|int $month
*
* @return SimplePredicate
*/
- public static function monthAfter($fragment, $month) {
- return new SimplePredicate("date.month-after", $fragment, array($month));
+ public static function monthAfter(string $fragment, $month) : SimplePredicate
+ {
+ return new SimplePredicate("date.month-after", $fragment, [$month]);
}
/**
* @param string $fragment
- * @param string $year
+ * @param int $year
*
* @return SimplePredicate
*/
- public static function year($fragment, $year) {
- return new SimplePredicate("date.year", $fragment, array($year));
+ public static function year(string $fragment, int $year) : SimplePredicate
+ {
+ return new SimplePredicate("date.year", $fragment, [$year]);
}
/**
* @param string $fragment
- * @param string $hour
+ * @param int $hour
*
* @return SimplePredicate
*/
- public static function hour($fragment, $hour) {
- return new SimplePredicate("date.hour", $fragment, array($hour));
+ public static function hour(string $fragment, int $hour) : SimplePredicate
+ {
+ return new SimplePredicate("date.hour", $fragment, [$hour]);
}
/**
* @param string $fragment
- * @param string $hour
+ * @param int $hour
*
* @return SimplePredicate
*/
- public static function hourBefore($fragment, $hour) {
- return new SimplePredicate("date.hour-before", $fragment, array($hour));
+ public static function hourBefore(string $fragment, int $hour) : SimplePredicate
+ {
+ return new SimplePredicate("date.hour-before", $fragment, [$hour]);
}
/**
* @param string $fragment
- * @param string $hour
+ * @param int $hour
*
* @return SimplePredicate
*/
- public static function hourAfter($fragment, $hour) {
- return new SimplePredicate("date.hour-after", $fragment, array($hour));
+ public static function hourAfter(string $fragment, int $hour) : SimplePredicate
+ {
+ return new SimplePredicate("date.hour-after", $fragment, [$hour]);
}
/**
* @param string $fragment
- * @param string $latitude
- * @param string $longitude
- * @param string $radius
+ * @param float $latitude
+ * @param float $longitude
+ * @param float $radius
*
* @return SimplePredicate
*/
- public static function near($fragment, $latitude, $longitude, $radius) {
- return new SimplePredicate("geopoint.near", $fragment, array($latitude, $longitude, $radius));
+ public static function near(string $fragment, float $latitude, float $longitude, float $radius) : SimplePredicate
+ {
+ return new SimplePredicate("geopoint.near", $fragment, [$latitude, $longitude, $radius]);
}
-
}
diff --git a/src/Prismic/Ref.php b/src/Prismic/Ref.php
index 39fdffbb..1b4c1b72 100644
--- a/src/Prismic/Ref.php
+++ b/src/Prismic/Ref.php
@@ -1,11 +1,14 @@
id = $id;
- $this->ref = $ref;
- $this->label = $label;
- $this->isMasterRef = $isMasterRef;
+ private function __construct(
+ string $id,
+ string $ref,
+ string $label,
+ bool $isMasterRef,
+ ?int $maybeScheduledAt = null
+ ) {
+ $this->id = $id;
+ $this->ref = $ref;
+ $this->label = $label;
+ $this->isMasterRef = $isMasterRef;
$this->maybeScheduledAt = $maybeScheduledAt;
}
/**
* Returns the ID of the ref
- *
- * @return string the ID of the ref
*/
- public function getId()
+ public function getId() : string
{
return $this->id;
}
/**
* Returns the reference of the ref
- *
- * @return string the ID of the ref
*/
- public function getRef()
+ public function getRef() : string
{
return $this->ref;
}
/**
* Returns the display label of the ref
- *
- * @return string the display label of the ref
*/
- public function getLabel()
+ public function getLabel() : string
{
return $this->label;
}
/**
* Checks if the ref is the master ref
- *
- * @return boolean true if it is the master ref, false otherwise
*/
- public function isMasterRef()
+ public function isMasterRef() : bool
{
return $this->isMasterRef;
}
/**
* Returns the time at which the ref is scheduled, if it is
- *
- * @return int|null Javacript timestamp for the scheduled release or null if not scheduled
+ * This is a 13 digit Javacript timestamp including miliseconds
*/
- public function getScheduledAt()
+ public function getScheduledAt() :? int
{
return $this->maybeScheduledAt;
}
/**
* Return the scheduled time as a unix timestamp
- *
- * @return int|null Unix timestamp for the scheduled release or null if not scheduled
*/
- public function getScheduledAtTimestamp()
+ public function getScheduledAtTimestamp() :? int
{
- if (null === $this->getScheduledAt()) {
+ if (null === $this->maybeScheduledAt) {
return null;
}
- return (int) floor($this->getScheduledAt() / 1000);
+ return (int) \floor($this->maybeScheduledAt / 1000);
}
/**
* Return the DateTime of the scheduled release if any
- *
- * @return DateTime|null The release date or null
*/
- public function getScheduledDate()
+ public function getScheduledDate() :? DateTimeImmutable
{
- if (null === $this->getScheduledAt()) {
+ if (null === $this->maybeScheduledAt) {
return null;
}
- $date = new DateTime;
- $date->setTimestamp($this->getScheduledAtTimestamp());
-
- return $date;
+ return DateTimeImmutable::createFromFormat(
+ 'U',
+ (string) $this->getScheduledAtTimestamp()
+ );
}
/**
- * Returns the ref as a displayable information: the ref's ID.
- *
- * @return string the ref's ID
+ * Returns the ref as a displayable information: the ref's ID
*/
- public function __toString()
+ public function __toString() : string
{
- return (string) $this->getRef();
+ return $this->ref;
}
/**
* Parses a ref.
- *
- * @param $json the json bit retrieved from the API that represents a ref.
- * @return Prismic::Ref the manipulable object for that ref.
+ * @throws Exception\InvalidArgumentException if the JSON object has missing properties
*/
- public static function parse($json)
+ public static function parse(stdClass $json) : self
{
+ if (! isset($json->id, $json->ref, $json->label)) {
+ throw new Exception\InvalidArgumentException(
+ 'The properties id, ref and label should exist in the JSON object for a Ref'
+ );
+ }
return new Ref(
$json->id,
$json->ref,
$json->label,
isset($json->{'isMasterRef'}) ? $json->isMasterRef : false,
- isset($json->{'scheduledAt'}) ? $json->scheduledAt : null // @todo: convert value into \DateTime ?
+ isset($json->{'scheduledAt'}) ? $json->scheduledAt : null
);
}
}
diff --git a/src/Prismic/SearchForm.php b/src/Prismic/SearchForm.php
index b3677a22..f1f0ad27 100644
--- a/src/Prismic/SearchForm.php
+++ b/src/Prismic/SearchForm.php
@@ -1,7 +1,15 @@
form('everything')->ref($ref)->submit()
*
* And here's an example of a more complex query:
- * $result = $api->form('products')->query('[[:d = any(document.tags, ["Featured"])]]')->pageSize(10)->page(2)->ref($ref)->submit()
+ * $result = $api->form('products')
+ * ->query('[[:d = any(document.tags, ["Featured"])]]')->pageSize(10)->page(2)->ref($ref)->submit()
*
* Note that setting the ref is mandatory, or your submit call will fail.
*
@@ -22,37 +31,48 @@
class SearchForm
{
/**
- * Prismic::Api the API object containing all the information to know where to query
+ * Cache Instance
+ * @var CacheInterface
*/
- private $api;
+ private $cache;
+
+ /**
+ * Http Client
+ * @var ClientInterface
+ */
+ private $client;
+
/**
- * Prismic::Form the REST form we're querying on in the API
+ * The REST form we're querying on in the API
+ * @var Form
*/
private $form;
+
/**
- * array the parameters we're getting ready to submit
+ * The parameters we're getting ready to submit
+ * @var array
*/
private $data;
/**
* Constructs a SearchForm object
- * @param Prismic::Api $api the API object containing all the information to know where to query
- * @param Prismic::Form $form the REST form we're querying on in the API
- * @param array $data the parameters we're getting ready to submit
+ * @param ClientInterface $httpClient An HTTP Client for sending Requests
+ * @param CacheInterface $cache A cache for storing responses
+ * @param Form $form the REST form we're querying on in the API
+ * @param array $data the parameters we're getting ready to submit
*/
- public function __construct(Api $api, Form $form, array $data)
+ public function __construct(ClientInterface $httpClient, CacheInterface $cache, Form $form, array $data)
{
- $this->api = $api;
- $this->form = $form;
- $this->data = $data;
+ $this->client = $httpClient;
+ $this->cache = $cache;
+ $this->form = $form;
+ $this->data = $data;
}
/**
* Get the parameters we're about to submit.
- *
- * @return array
*/
- public function getData()
+ public function getData() : array
{
return $this->data;
}
@@ -63,157 +83,172 @@ public function getData()
*
* Checks that the parameter is expected in the RESTful form before allowing to add it.
*
- * @param string $key the name of the parameter
- * @param string $value the value of the parameter
+ * @param string $key the name of the parameter
+ * @param string|int $value the value of the parameter
*
- * \throws RuntimeException
+ * @throws Exception\ExceptionInterface
*
- * @return \Prismic\SearchForm a clone of the SearchForm object with the new parameter added
+ * @return self A clone of the SearchForm object with the new parameter added
*/
- public function set($key, $value)
+ public function set(string $key, $value) : self
{
- $data = $this->data;
- if (isset($key) && isset($value)) {
- $fields = $this->form->getFields();
- /** @var FieldForm $field */
- $field = $fields[$key];
+ if (empty($key)) {
+ throw new Exception\InvalidArgumentException('Form parameter key must be a non-empty string');
+ }
+ if (! is_scalar($value)) {
+ throw new Exception\InvalidArgumentException('Form parameter value must be scalar');
+ }
+ $fields = $this->form->getFields();
+ if (! isset($fields[$key])) {
+ throw new Exception\InvalidArgumentException(sprintf(
+ 'Unknown form field parameter "%s"',
+ $key
+ ));
+ }
- if (is_int($value) && $field->getType() != "Integer") {
- throw new \RuntimeException("Cannot use a Int as value for field " . $key);
- }
+ /** @var FieldForm $field */
+ $field = $fields[$key];
- if ($field->isMultiple()) {
- $values = isset($data[$key]) ? $data[$key] : array();
- if (is_array($values)) {
- array_push($values, $value);
- } else {
- $values = array($value);
- }
- $data[$key] = $values;
- } else {
- $data[$key] = $value;
- }
+ if ($field->getType() === 'String' && ! is_string($value)) {
+ throw new Exception\InvalidArgumentException(sprintf(
+ 'The field %s expects a string parameter, received %s',
+ $key,
+ gettype($value)
+ ));
+ }
+
+ if ($field->getType() === 'Integer' && ! is_numeric($value)) {
+ throw new Exception\InvalidArgumentException(sprintf(
+ 'The field %s expects an integer parameter, received %s',
+ $key,
+ gettype($value)
+ ));
+ }
+
+
+ $data = $this->data;
+ if ($field->isMultiple()) {
+ $data[$key] = isset($data[$key]) ? $data[$key] : [];
+ $data[$key] = is_array($data[$key]) ? $data[$key] : [$data[$key]];
+ $data[$key][] = $value;
+ } else {
+ $data[$key] = $value;
}
- return new SearchForm($this->api, $this->form, $data);
+
+ return new self($this->client, $this->cache, $this->form, $data);
}
/**
- * Set the repository's ref.
+ * Set the repository ref to query at
*
- * @param string|\Prismic\Ref $ref the ref we wish to query on, or its ID.
- *
- * @return Prismic::SearchForm a clone of the SearchForm object with the new ref parameter added
+ * @param string|Ref $ref the ref we wish to query on, or its ID.
+ * @return self
*/
- public function ref($ref)
+ public function ref($ref) : self
{
- if ($ref instanceof \Prismic\Ref) {
- $ref = $ref->getRef();
+ if ($ref instanceof Ref) {
+ $ref = (string) $ref;
}
return $this->set("ref", $ref);
}
/**
* Set the after parameter: the id of the document to start the results from (excluding that document).
- *
* @param string $documentId
- *
- * @return Prismic::SearchForm a clone of the SearchForm object with the new after parameter added
+ * @return self
*/
- public function after($documentId)
+ public function after(string $documentId) : self
{
return $this->set("after", $documentId);
}
/**
- * Set the fetch parameter: restrict the fields to retrieve for a document. You can pass in parameter
- * an array of strings, or several strings.
+ * Set the fetch parameter: restrict the fields to retrieve for a document
+ *
+ * Pass multiple string arguments or an array of strings to unpack with the splat operator
*
- * @return Prismic::SearchForm a clone of the SearchForm object with the new fetch parameter added
+ * @param string[] $fields
+ * @return self
*/
- public function fetch()
+ public function fetch(string ...$fields) : self
{
- $numargs = func_num_args();
- if ($numargs == 1 && is_array(func_get_arg(0))) {
- $fields = func_get_arg(0);
- } else {
- $fields = func_get_args();
- }
- return $this->set("fetch", join(",", $fields));
+ return $this->set("fetch", implode(",", $fields));
}
/**
- * Set the fetchLinks parameter: additional fields to retrieve for DocumentLink, You can pass in parameter
- * an array of strings, or several strings.
+ * Set the fetchLinks parameter: additional fields to retrieve for DocumentLink
*
- * @return Prismic::SearchForm a clone of the SearchForm object with the new fetchLinks parameter added
+ * Pass multiple string arguments or an array of strings to unpack with the splat operator
+ *
+ * @param string[] $fields
+ * @return self
*/
- public function fetchLinks()
+ public function fetchLinks(string ...$fields) : self
{
- $numargs = func_num_args();
- if ($numargs == 1 && is_array(func_get_arg(0))) {
- $fields = func_get_arg(0);
- } else {
- $fields = func_get_args();
- }
return $this->set("fetchLinks", join(",", $fields));
}
+ /**
+ * Set the graphQuery parameter: GraphQL syntax based to select fields
+ * @param string $query
+ * @return self
+ */
+ public function graphQuery(string $query) : self
+ {
+ return $this->set("graphQuery", $query);
+ }
+
/**
* Set the language for the query documents.
- *
- * @param int $lang
- * @return Prismic::SearchForm a clone of the SearchForm object with the new lang parameter added
+ * @param string $lang
+ * @return self
*/
- public function lang($lang)
+ public function lang(string $lang) : self
{
return $this->set("lang", $lang);
}
/**
* Set the query's page size, for the pagination.
- *
- * @param int $pageSize
- * @return Prismic::SearchForm a clone of the SearchForm object with the new pageSize parameter added
+ * @param int $pageSize
+ * @return self
*/
- public function pageSize($pageSize)
+ public function pageSize(int $pageSize) : self
{
return $this->set("pageSize", $pageSize);
}
/**
- * Set the query's page, for the pagination.
- *
- * @param int $page
- *
- * @return Prismic::SearchForm a clone of the SearchForm object with the new page parameter added
+ * Set the query result page number, for the pagination.
+ * @param int $page
+ * @return self
*/
- public function page($page)
+ public function page(int $page) : self
{
return $this->set("page", $page);
}
/**
* Set the query's ordering, setting in what order the documents must be retrieved.
- *
- * @return Prismic::SearchForm a clone of the SearchForm object with the new orderings parameter added
*/
- public function orderings()
+ public function orderings(string ...$fields) : self
{
- if (func_num_args() == 0) return $this;
- $orderings = "[" . join(",", array_map(function($order) { return preg_replace('/(^\[|\]$)/', '', $order); }, func_get_args())) . "]";
+ $fields = array_filter($fields);
+ if (empty($fields)) {
+ return $this;
+ }
+ $orderings = "[" . implode(",", array_map(function ($order) {
+ return preg_replace('/(^\[|\]$)/', '', $order);
+ }, $fields)) . "]";
return $this->set("orderings", $orderings);
}
/**
* Submit the current API call, and unmarshalls the result into PHP objects.
- *
- * @return Prismic::Response the result of the call
- *
- * \throws RuntimeException
*/
- public function submit()
+ public function submit() : stdClass
{
- return $this->submit_raw();
+ return $this->submitRaw();
}
/**
@@ -222,99 +257,119 @@ public function submit()
* This uses a copy of the SearchForm with a page size of 1 (the smallest
* allowed) since all we care about is one of the returned non-result
* fields.
- *
- * @return int Total number of results
- *
- * \throws RuntimeException
*/
- public function count()
+ public function count() :? int
{
- return $this->pageSize(1)->submit_raw()->total_results_size;
+ $response = $this->pageSize(1)->submitRaw();
+ return isset($response->total_results_size)
+ ? (int) $response->total_results_size
+ : null;
}
/**
- * Set the query's predicates themselves.
- * You can pass a String representing a query as parameter, or one or multiple Predicates to build an "AND" query
- *
- * @return Prismic::SearchForm a clone of the SearchForm object with the new predicate or predicates added
+ * Set query predicates
+ * You can provide a single string, or one or multiple Predicate instances to build an "AND" query
*/
- public function query()
+ public function query(...$params) : self
{
- $numargs = func_num_args();
- if ($numargs == 0) return clone $this;
- $first = func_get_arg(0);
- if ($numargs == 1 && is_string($first)) {
- return $this->set("q", $first);
+ // Filter empty args and return early if appropriate
+ $params = array_filter($params);
+ if (empty($params)) {
+ return clone $this;
}
- if ($numargs == 1 && is_array($first)) {
- $predicates = $first;
- } else {
- $predicates = func_get_args();
+ $first = current($params);
+ // Unpack a single array argument
+ if (count($params) === 1 && is_array($first)) {
+ $params = $first;
+ }
+ $this->assertValidQueryParameters($params);
+ if (count($params) === 1 && is_string($first)) {
+ return $this->set("q", $first);
}
- $query = "[" . join("", array_map(function($predicate) { return $predicate->q(); }, $predicates)) . "]";
+ $query = "[" . implode("", array_map(function ($predicate) {
+ /** @var Predicate $predicate */
+ return $predicate->q();
+ }, $params)) . "]";
return $this->set("q", $query);
}
+ /**
+ * Assert that the parameters used for a query contain either a single string, or an array of Predicates
+ * @param array $params
+ * @throws Exception\InvalidArgumentException
+ */
+ private function assertValidQueryParameters(array $params) : void
+ {
+ if (count($params) === 1 && is_string(current($params))) {
+ return;
+ }
+ foreach ($params as $param) {
+ if (! $param instanceof Predicate) {
+ throw new Exception\InvalidArgumentException(
+ 'Query parameters should consist of a single string or multiple Predicate instances'
+ );
+ }
+ }
+ }
+
/**
* Get the URL for this form
- *
- * @return string the URL
*/
- public function url()
+ public function url() : string
{
- $url = $this->form->getAction() . '?' . http_build_query($this->data);
- $url = preg_replace('/%5B(?:[0-9]|[1-9][0-9]+)%5D=/', '=', $url);
- return $url;
+ return Utils::buildUrl($this->form->getAction(), $this->data);
}
/**
* Checks if the results for this form are already cached
- *
- * @return boolean true if the results for this form are fresh in the cache, false otherwise
*/
- public function isCached()
+ public function isCached() : bool
{
- return $this->api->getCache()->has($this->url());
+ return $this->cache->has($this->url());
}
/**
* Performs the actual submit call, without the unmarshalling.
*
- * \throws RuntimeException if the Form type is not supported
+ * @throws Exception\RuntimeException if the Form type is not supported or the Response body is invalid
+ * @throws Exception\RequestFailureException if something went wrong retrieving data from the API
*
- * @return the raw (unparsed) response.
+ * @return stdClass Unserialized JSON Response
*/
- private function submit_raw()
+ private function submitRaw() : stdClass
{
- if ($this->form->getMethod() == 'GET' &&
- $this->form->getEnctype() == 'application/x-www-form-urlencoded' &&
- $this->form->getAction()
+ if ($this->form->getMethod() !== 'GET' ||
+ $this->form->getEnctype() !== 'application/x-www-form-urlencoded' ||
+ ! $this->form->getAction()
) {
- $url = $this->url();
- $cacheKey = $this->url();
-
- $response = $this->api->getCache()->get($cacheKey);
-
- if ($response) {
- return $response;
- }
- $response = $this->api->getHttpClient()->get($url);
- $cacheControl = $response->getHeader('Cache-Control')[0];
- $cacheDuration = null;
- if (preg_match('/^max-age\s*=\s*(\d+)$/', $cacheControl, $groups) == 1) {
- $cacheDuration = (int) $groups[1];
- }
- $json = json_decode($response->getBody(true));
- if (!isset($json)) {
- throw new \RuntimeException("Unable to decode json response");
- }
- if ($cacheDuration !== null) {
- $expiration = $cacheDuration;
- $this->api->getCache()->set($cacheKey, $json, $expiration);
- }
- return $json;
+ throw new Exception\RuntimeException("Form type not supported");
}
- throw new \RuntimeException("Form type not supported");
- }
+ $url = $this->url();
+ $cacheKey = $this->url();
+
+ $cachedJson = $this->cache->get($cacheKey);
+ if ($cachedJson) {
+ return $cachedJson;
+ }
+ try {
+ /** @var \Psr\Http\Message\ResponseInterface $response */
+ $response = $this->client->request('GET', $url);
+ } catch (GuzzleException $guzzleException) {
+ throw Exception\RequestFailureException::fromGuzzleException($guzzleException);
+ }
+ $cacheControl = $response->getHeader('Cache-Control')[0];
+ $cacheDuration = null;
+ if (preg_match('/^max-age\s*=\s*(\d+)$/', $cacheControl, $groups) == 1) {
+ $cacheDuration = (int) $groups[1];
+ }
+ $json = \json_decode((string) $response->getBody());
+ if (! isset($json)) {
+ throw new Exception\RuntimeException("Unable to decode json response");
+ }
+ if ($cacheDuration !== null) {
+ $this->cache->set($cacheKey, $json, $cacheDuration);
+ }
+ return $json;
+ }
}
diff --git a/src/Prismic/SimplePredicate.php b/src/Prismic/SimplePredicate.php
index 011f280e..ca89cfb6 100644
--- a/src/Prismic/SimplePredicate.php
+++ b/src/Prismic/SimplePredicate.php
@@ -1,23 +1,26 @@
name = $name;
$this->fragment = $fragment;
@@ -27,10 +30,10 @@ public function __construct($name, $fragment, array $args = array())
/**
* @return string
*/
- public function q()
+ public function q() : string
{
$query = "[:d = " . $this->name . "(";
- if ($this->name == "similar") {
+ if ($this->name === "similar") {
$query .= "\"" . $this->fragment . "\"";
} else {
$query .= $this->fragment;
@@ -47,18 +50,18 @@ public function q()
*
* @return string
*/
- private static function serializeField($value) {
+ private static function serializeField($value) : string
+ {
if (is_string($value)) {
return "\"" . $value . "\"";
}
if (is_array($value)) {
- $str_array = array();
+ $str_array = [];
foreach ($value as $elt) {
- array_push($str_array, SimplePredicate::serializeField($elt));
+ array_push($str_array, static::serializeField($elt));
}
- return "[" . join(", ", $str_array) . "]";
+ return "[" . implode(", ", $str_array) . "]";
}
return (string)$value;
}
-
}
diff --git a/src/Prismic/Utils.php b/src/Prismic/Utils.php
new file mode 100644
index 00000000..00f2e406
--- /dev/null
+++ b/src/Prismic/Utils.php
@@ -0,0 +1,20 @@
+id = $id;
+ $this->ref = $ref;
+ $this->label = $label;
+ }
+
+ public function getId() : string
+ {
+ return $this->id;
+ }
+
+ public function getRef() : string
+ {
+ return $this->ref;
+ }
+
+ public function getLabel() : string
+ {
+ return $this->label;
+ }
+
+ public static function parse(stdClass $json) : self
+ {
+ return new Variation($json->id, $json->ref, $json->label);
+ }
+}
diff --git a/tests/Prismic/ApiDataTest.php b/tests/Prismic/ApiDataTest.php
new file mode 100644
index 00000000..319e77fe
--- /dev/null
+++ b/tests/Prismic/ApiDataTest.php
@@ -0,0 +1,60 @@
+getJsonFixture('data.json');
+ $this->data = ApiData::withJsonString($json);
+ }
+
+ public function testApiDataCanBeCreatedFromJsonString()
+ {
+ $json = $this->getJsonFixture('data.json');
+ $data = ApiData::withJsonString($json);
+ $this->assertInstanceOf(ApiData::class, $data);
+ }
+
+ /**
+ * @expectedException Prismic\Exception\RuntimeException
+ * @expectedExceptionMessage Unable to decode JSON response
+ */
+ public function testWithJsonStringThrowsExceptionForInvalidJson()
+ {
+ ApiData::withJsonString('wtf?');
+ }
+
+ public function testApiDataHasExpectedValues()
+ {
+ $this->assertCount(3, $this->data->getRefs());
+ $this->assertContainsOnlyInstancesOf(Ref::class, $this->data->getRefs());
+
+ $this->assertCount(3, $this->data->getBookmarks());
+ $this->assertContainsOnly('string', $this->data->getBookmarks());
+
+ $this->assertCount(6, $this->data->getTypes());
+ $this->assertContainsOnly('string', $this->data->getTypes());
+
+ $this->assertCount(4, $this->data->getTags());
+ $this->assertContainsOnly('string', $this->data->getTags());
+
+ $this->assertCount(2, $this->data->getForms());
+ $this->assertContainsOnlyInstancesOf(stdClass::class, $this->data->getForms());
+
+ $this->assertInstanceOf(Experiments::class, $this->data->getExperiments());
+
+ $this->assertSame('http://lesbonneschoses.prismic.io/auth', $this->data->getOauthInitiate());
+ $this->assertSame('http://lesbonneschoses.prismic.io/auth/token', $this->data->getOauthToken());
+ }
+}
diff --git a/tests/Prismic/ApiTest.php b/tests/Prismic/ApiTest.php
index ec09f0b7..aecfb370 100644
--- a/tests/Prismic/ApiTest.php
+++ b/tests/Prismic/ApiTest.php
@@ -1,45 +1,115 @@
api = $this->getMockBuilder(Prismic\Api::class)
- ->disableOriginalConstructor()
- ->setMethods(['master', 'getExperiments'])
- ->getMock();
+ unset($_COOKIE);
+
+ $this->apiData = ApiData::withJsonString($this->getJsonFixture('data.json'));
+ $this->httpClient = $this->prophesize(GuzzleClient::class);
+ $this->cache = $this->prophesize(CacheInterface::class);
+ }
+
+ protected function getApi() : Api
+ {
+ return Api::get(
+ 'https://whatever.prismic.io/api/v2',
+ 'My-Access-Token',
+ $this->httpClient->reveal(),
+ $this->cache->reveal(),
+ 99
+ );
+ }
+
+ protected function getApiWithDefaultData() : Api
+ {
+ $key = 'https://whatever.prismic.io/api/v2#My-Access-Token';
+ $cachedData = serialize($this->apiData);
+ $this->cache->get($key)->willReturn($cachedData);
+ $this->httpClient->request()->shouldNotBeCalled();
+
+ return $this->getApi();
+ }
- $master = new Prismic\Ref('Master', 'Master-Ref-String', 'Master', true, null);
+ public function testCachedApiDataWillBeUsedIfAvailable()
+ {
+ $api = $this->getApiWithDefaultData();
+ $this->assertSame(serialize($this->apiData), serialize($api->getData()));
+ }
- $this->api
- ->method('master')
- ->willReturn($master);
+ public function testGetIsCalledOnHttpClientWhenTheCacheIsEmpty()
+ {
+ $key = 'https://whatever.prismic.io/api/v2#My-Access-Token';
+ $this->cache->get($key)->willReturn(null);
+ $url = 'https://whatever.prismic.io/api/v2?access_token=My-Access-Token';
+ $response = $this->prophesize(ResponseInterface::class);
+ $response->getBody()->willReturn($this->getJsonFixture('data.json'));
+ $this->httpClient->request('GET', $url)->willReturn($response->reveal());
+
+ $this->cache->set(
+ Argument::type('string'),
+ Argument::type('string'),
+ 99
+ )->shouldBeCalled();
+
+ $api = $this->getApi();
+ $this->assertInstanceOf(ClientInterface::class, $api->getHttpClient());
+ $this->assertSame(serialize($this->apiData), serialize($api->getData()));
+ }
- $this->experiments = $this->getMockBuilder(Prismic\Experiments::class)
- ->disableOriginalConstructor()
- ->setMethods(['refFromCookie'])
- ->getMock();
+ public function testMasterRefIsReturnedWhenNeitherPreviewOrExperimentsAreActive()
+ {
+ $api = $this->getApiWithDefaultData();
+ $this->assertSame($this->expectedMasterRef, $api->ref());
+ }
- $this->api
- ->method('getExperiments')
- ->willReturn($this->experiments);
+ public function testMasterRefIsReturnedByMasterMethod()
+ {
+ $api = $this->getApiWithDefaultData();
+ $ref = $api->master();
+ $this->assertInstanceOf(Prismic\Ref::class, $ref);
+ $this->assertSame($this->expectedMasterRef, (string) $ref);
}
- public function testRef()
+ public function testInPreviewAndInExperimentIsFalseWhenNoCookiesAreSet()
{
- $this->assertSame('Master-Ref-String', $this->api->ref());
+ $api = $this->getApiWithDefaultData();
+ $this->assertFalse($api->inPreview());
+ $this->assertFalse($api->inExperiment());
}
- public function getCookieData()
+ public function getPreviewRefs()
{
return [
[
@@ -58,87 +128,117 @@ public function getCookieData()
],
[
[
- 'io.prismic.experiment' => 'experiment',
- 'other' => 'other',
+ 'io_prismic_preview' => 'preview',
],
- 'experiment'
- ],
- [
- [
- 'foo' => 'foo',
- 'other' => 'other',
- ],
- 'Master-Ref-String'
+ 'preview'
],
];
}
/**
- * @dataProvider getCookieData
+ * @dataProvider getPreviewRefs
*/
- public function testCorrectRefIsReturned($cookie, $expect)
+ public function testPreviewRefIsReturnedWhenPresentInSuperGlobal(array $cookie, string $expect)
{
- // Make sure that Prismic\Experiments::refFromCookie returns a 'valid' ref
- $this->experiments->method('refFromCookie')->willReturn('experiment');
$_COOKIE = $cookie;
- $this->assertSame($expect, $this->api->ref());
+ $api = $this->getApiWithDefaultData();
+ $this->assertSame($expect, $api->ref());
}
- public function testRefDoesNotReturnStaleExperimentRef()
+ public function testInPreviewIsTrueWhenPreviewCookieIsSet()
{
- // Make sure that Prismic\Experiments::refFromCookie returns null, i.e. no experiment running
- $this->experiments->method('refFromCookie')->willReturn(null);
$_COOKIE = [
- 'io.prismic.experiment' => 'Stale Experiment Cookie Value',
+ 'io.prismic.preview' => 'whatever',
];
- $this->assertSame('Master-Ref-String', $this->api->ref());
+ $api = $this->getApiWithDefaultData();
+ $this->assertTrue($api->inPreview());
}
- /**
- * @depends testCorrectRefIsReturned
- */
- public function testInPreviewIsTrueWhenPreviewCookieIsSet()
+ public function testRefDoesNotReturnStaleExperimentRef()
{
- $cookieValue = 'Preview Ref Cookie Value';
$_COOKIE = [
- 'io.prismic.preview' => $cookieValue,
+ 'io.prismic.experiment' => 'Stale Experiment Cookie Value',
];
- $this->assertTrue($this->api->inPreview());
+ $api = $this->getApiWithDefaultData();
+ $this->assertSame($this->expectedMasterRef, $api->ref());
}
- /**
- * @depends testCorrectRefIsReturned
- */
- public function testInExperimentIsTrueWhenExperimentCookieIsSet()
+ public function testCorrectExperimentRefIsReturnedWhenCookieIsSet()
{
- $cookieValue = 'Experiment Cookie Value';
- $this->experiments->method('refFromCookie')->willReturn('Experiment Ref');
+ $runningGoogleCookie = '_UQtin7EQAOH5M34RQq6Dg 1';
+ $expectedRef = 'VDUUmHIKAZQKk9uq'; // The ref at index 1 for the variations in this experiment
$_COOKIE = [
- 'io.prismic.experiment' => $cookieValue,
+ 'io.prismic.experiment' => $runningGoogleCookie,
];
- $this->assertTrue($this->api->inExperiment());
+ $api = $this->getApiWithDefaultData();
+ $this->assertSame($expectedRef, $api->ref());
+ $this->assertTrue($api->inExperiment());
}
/**
- * @depends testInExperimentIsTrueWhenExperimentCookieIsSet
+ * @depends testCorrectExperimentRefIsReturnedWhenCookieIsSet
*/
public function testPreviewRefTrumpsExperimentRefWhenSet()
{
- $this->experiments->method('refFromCookie')->willReturn('Experiment Ref');
+ $runningGoogleCookie = '_UQtin7EQAOH5M34RQq6Dg 1';
$_COOKIE = [
- 'io.prismic.experiment' => 'Experiment Cookie Value',
+ 'io.prismic.experiment' => $runningGoogleCookie,
'io.prismic.preview' => 'Preview Ref Cookie Value',
];
- $this->assertTrue($this->api->inPreview());
- $this->assertFalse($this->api->inExperiment());
+ $api = $this->getApiWithDefaultData();
+ $this->assertTrue($api->inPreview());
+ $this->assertFalse($api->inExperiment());
}
- public function testInPreviewAndInExperimentIsFalseWhenNoCookiesAreSet()
+ public function testBookmarkReturnsCorrectDocumentId()
{
- $_COOKIE = [];
- $this->assertFalse($this->api->inPreview());
- $this->assertFalse($this->api->inExperiment());
+ $api = $this->getApiWithDefaultData();
+ $this->assertSame('Ue0EDd_mqb8Dhk3j', $api->bookmark('about'));
+ $this->assertNull($api->bookmark('unknown-bookmark'));
}
+ public function testFormsReturnsOnlyFormInstances()
+ {
+ $api = $this->getApiWithDefaultData();
+ $everything = $api->form('everything');
+ $this->assertTrue(isset($everything));
+ $this->assertInstanceOf(SearchForm::class, $everything);
+ }
+
+ public function testRefsGroupsRefsByLabel()
+ {
+ $api = $this->getApiWithDefaultData();
+ $refs = $api->refs();
+ $this->assertArrayHasKey('Master', $refs);
+ $this->assertArrayHasKey('San Francisco Grand opening', $refs);
+ $this->assertContainsOnlyInstancesOf(Prismic\Ref::class, $refs);
+ }
+
+ public function testRefsContainsOnlyFirstEncounteredRefWithLabel()
+ {
+ $api = $this->getApiWithDefaultData();
+ $refs = $api->refs();
+ $this->assertSame('UgjWRd_mqbYHvPJa', (string) $refs['San Francisco Grand opening']);
+ }
+
+ public function testGetRefFromLabelReturnsExpectedRef()
+ {
+ $api = $this->getApiWithDefaultData();
+ $ref = $api->getRefFromLabel('San Francisco Grand opening');
+ $this->assertSame('UgjWRd_mqbYHvPJa', (string) $ref);
+ }
+
+ public function testUsefulExceptionIsThrownWhenApiCannotBeReached()
+ {
+ $client = new Client(['connect_timeout' => 0.01]);
+ try {
+ $api = Api::get('http://example.example', null, $client);
+ $this->fail('No exception was thrown');
+ } catch (Prismic\Exception\RequestFailureException $e) {
+ $this->assertContains('example.example', $e->getMessage());
+ $this->assertInstanceOf(RequestInterface::class, $e->getRequest());
+ $this->assertNull($e->getResponse());
+ }
+ }
}
diff --git a/tests/Prismic/CacheTest.php b/tests/Prismic/CacheTest.php
index b06bbade..123180b5 100644
--- a/tests/Prismic/CacheTest.php
+++ b/tests/Prismic/CacheTest.php
@@ -1,10 +1,11 @@
assertNull($this->cache->get('key1'));
$this->assertNull($this->cache->get('key2'));
}
+
+ public function testSetGetReturnsExpectedValue()
+ {
+ $data = \json_decode($this->getJsonFixture('data.json'));
+ $this->cache->set('key', $data);
+ $result = $this->cache->get('key');
+ $this->assertEquals($data, $result);
+ }
+
+ public function testLongUrlBasedCacheKeysArePersistedCorrectly()
+ {
+ $data = \json_decode($this->getJsonFixture('data.json'));
+ $url = $data->forms->everything->action;
+ $url .= '?access_token=AVeryLongAccessTokenForPermanentAccessToTheRepository&q=SomeQueryString';
+ $this->cache->set($url, $data);
+ $result = $this->cache->get($url);
+ $this->assertEquals($data, $result);
+ }
}
diff --git a/tests/Prismic/Dom/DateTest.php b/tests/Prismic/Dom/DateTest.php
index 9ac947b7..452eab8f 100644
--- a/tests/Prismic/Dom/DateTest.php
+++ b/tests/Prismic/Dom/DateTest.php
@@ -1,12 +1,14 @@
links = json_decode(file_get_contents(__DIR__.'/../../fixtures/links.json'));
+ $this->links = json_decode($this->getJsonFixture('links.json'));
$this->linkResolver = new FakeLinkResolver();
}
diff --git a/tests/Prismic/Dom/RichTextTest.php b/tests/Prismic/Dom/RichTextTest.php
index 4ac1a16a..e1a3cebf 100644
--- a/tests/Prismic/Dom/RichTextTest.php
+++ b/tests/Prismic/Dom/RichTextTest.php
@@ -1,18 +1,20 @@
richText = json_decode(file_get_contents(__DIR__.'/../../fixtures/rich-text.json'));
+ $this->richText = json_decode($this->getJsonFixture('rich-text.json'));
$this->linkResolver = new FakeLinkResolver();
}
@@ -87,7 +89,7 @@ public function testHtmlSerializer()
'' .
''
);
- $htmlSerializer = function($element, $content) {
+ $htmlSerializer = function ($element, $content) {
if ($element->type === 'heading3') {
$classes = 'custom';
if (isset($element->label)) {
diff --git a/tests/Prismic/ExperimentTest.php b/tests/Prismic/ExperimentTest.php
index 9d35ceaf..05841e0b 100644
--- a/tests/Prismic/ExperimentTest.php
+++ b/tests/Prismic/ExperimentTest.php
@@ -1,16 +1,17 @@
getJsonFixture('experiments.json'));
$this->experiments = Experiments::parse($experimentsJson);
}
@@ -39,7 +40,5 @@ public function testCookieParsing()
$this->assertNull($this->experiments->refFromCookie("_UQtin7EQAOH5M34RQq6Dg -1"), "Index overflow negative index");
$this->assertNull($this->experiments->refFromCookie("NotAGoodLookingId 0"), "Unknown Google ID");
$this->assertNull($this->experiments->refFromCookie("NotAGoodLookingId 1"), "Unknown Google ID");
-
}
-
}
diff --git a/tests/Prismic/FakeLinkResolver.php b/tests/Prismic/FakeLinkResolver.php
index 0116fab2..3ec7a4a4 100644
--- a/tests/Prismic/FakeLinkResolver.php
+++ b/tests/Prismic/FakeLinkResolver.php
@@ -1,4 +1,5 @@
isBroken) {
return 'http://host/404';
diff --git a/tests/Prismic/GuzzleClient.php b/tests/Prismic/GuzzleClient.php
new file mode 100644
index 00000000..0418d94c
--- /dev/null
+++ b/tests/Prismic/GuzzleClient.php
@@ -0,0 +1,20 @@
+assertEquals('[:d = not(document.type, "blog-post")]', $predicate->q());
}
-
public function testAnyPredicate()
{
- $p = Predicates::any("document.tags", array("Macaron", "Cupcakes"));
+ $p = Predicates::any("document.tags", ["Macaron", "Cupcakes"]);
$this->assertEquals('[:d = any(document.tags, ["Macaron", "Cupcakes"])]', $p->q());
}
@@ -56,5 +56,4 @@ public function testGeopointNear()
$p = Predicates::near("my.store.coordinates", 40.689757, -74.0451453, 15);
$this->assertEquals("[:d = geopoint.near(my.store.coordinates, 40.689757, -74.0451453, 15)]", $p->q());
}
-
}
diff --git a/tests/Prismic/RefTest.php b/tests/Prismic/RefTest.php
index 1af859cb..a77f7055 100644
--- a/tests/Prismic/RefTest.php
+++ b/tests/Prismic/RefTest.php
@@ -1,22 +1,25 @@
refs) {
- $this->refs = json_decode(file_get_contents(__DIR__.'/../fixtures/refs.json'));
+ if (! $this->refs) {
+ $this->refs = \json_decode($this->getJsonFixture('refs.json'));
}
- $out = array();
- foreach($this->refs->refs as $ref) {
- $out[] = array($ref);
+ $out = [];
+ foreach ($this->refs->refs as $ref) {
+ $out[] = [$ref];
}
return $out;
}
@@ -34,9 +37,9 @@ public function testParseRefs($json)
$this->assertInternalType('string', $ref->getLabel());
$this->assertStringMatchesFormat('%s', $ref->getLabel());
$this->assertInternalType('boolean', $ref->isMasterRef());
- if(!is_null($ref->getScheduledAt())) {
+ if (! is_null($ref->getScheduledAt())) {
$this->assertInternalType('int', $ref->getScheduledAt());
- $this->assertEquals(13, strlen($ref->getScheduledAt()), 'Expected a 13 digit number');
+ $this->assertEquals(13, strlen((string)$ref->getScheduledAt()), 'Expected a 13 digit number');
}
}
@@ -46,9 +49,13 @@ public function testParseRefs($json)
public function testGetScheduledAtTimestamp($json)
{
$ref = Ref::parse($json);
- if(!is_null($ref->getScheduledAtTimestamp())) {
+
+ if (! is_null($ref->getScheduledAtTimestamp())) {
$this->assertInternalType('int', $ref->getScheduledAtTimestamp());
- $this->assertEquals(10, strlen($ref->getScheduledAtTimestamp()), 'Expected a 10 digit number');
+ $this->assertEquals(10, strlen((string)$ref->getScheduledAtTimestamp()), 'Expected a 10 digit number');
+ } else {
+ // Squash No assertions warning in PHP Unit
+ $this->assertNull($ref->getScheduledAtTimestamp());
}
}
@@ -67,9 +74,9 @@ public function testToStringSerialisesToRef($json)
public function testGetScheduledDate($json)
{
$ref = Ref::parse($json);
- if(!is_null($ref->getScheduledAtTimestamp())) {
+ if (! is_null($ref->getScheduledAtTimestamp())) {
$date = $ref->getScheduledDate();
- $this->assertInstanceOf('DateTime', $date);
+ $this->assertInstanceOf(DateTimeImmutable::class, $date);
$this->assertSame($ref->getScheduledAtTimestamp(), $date->getTimestamp());
$this->assertNotSame($date, $ref->getScheduledDate(), 'Returned date should be a new instance every time');
} else {
@@ -77,4 +84,11 @@ public function testGetScheduledDate($json)
}
}
+ /**
+ * @expectedException Prismic\Exception\ExceptionInterface
+ */
+ public function testExceptionThrownForInvalidJsonObject()
+ {
+ Ref::parse(new stdClass);
+ }
}
diff --git a/tests/Prismic/SearchFormTest.php b/tests/Prismic/SearchFormTest.php
new file mode 100644
index 00000000..97f2c142
--- /dev/null
+++ b/tests/Prismic/SearchFormTest.php
@@ -0,0 +1,459 @@
+apiData = ApiData::withJsonString($this->getJsonFixture('data.json'));
+ $this->form = Form::withJsonObject($this->apiData->getForms()['blogs']);
+ $this->httpClient = $this->prophesize(GuzzleClient::class);
+ $this->cache = $this->prophesize(CacheInterface::class);
+ }
+
+ protected function getSearchForm() : SearchForm
+ {
+ return new SearchForm(
+ $this->httpClient->reveal(),
+ $this->cache->reveal(),
+ $this->form,
+ $this->form->defaultData()
+ );
+ }
+
+ public function testGetDataReturnsArray()
+ {
+ $form = $this->getSearchForm();
+ $this->assertInternalType('array', $form->getData());
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\InvalidArgumentException
+ * @expectedExceptionMessage Form parameter key must be a non-empty string
+ */
+ public function testSetWithAnEmptyKeyThrowsException()
+ {
+ $form = $this->getSearchForm();
+ $form->set('', 'foo');
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\InvalidArgumentException
+ * @expectedExceptionMessage Form parameter value must be scalar
+ */
+ public function testSetWithANonScalarValueThrowsException()
+ {
+ $form = $this->getSearchForm();
+ $form->set('page', ['an-array']);
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\InvalidArgumentException
+ * @expectedExceptionMessage Unknown form field parameter
+ */
+ public function testSetWithAnUnknownKeyThrowsException()
+ {
+ $form = $this->getSearchForm();
+ $form->set('whatever', 'foo');
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\InvalidArgumentException
+ * @expectedExceptionMessage expects a string parameter
+ */
+ public function testSetStringParamWithNonStringThrowsException()
+ {
+ $form = $this->getSearchForm();
+ $form->set('lang', 1);
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\InvalidArgumentException
+ * @expectedExceptionMessage expects an integer parameter
+ */
+ public function testSetIntParamWithNonNumberThrowsException()
+ {
+ $form = $this->getSearchForm();
+ $form->set('page', 'foo');
+ }
+
+ protected function assertSearchFormClone(SearchForm $a, SearchForm $b)
+ {
+ $this->assertNotSame($a, $b);
+ }
+
+ public function testSetIsSuccessfulForSingleScalarValue()
+ {
+ $form = $this->getSearchForm();
+ $data = $form->getData();
+ $this->assertEquals('1', $data['page']);
+
+ $clone = $form->set('page', 10);
+
+ $this->assertSearchFormClone($form, $clone);
+
+ $data = $clone->getData();
+ $this->assertEquals('10', $data['page']);
+ }
+
+ public function testSetAppendsForMultipleFields()
+ {
+ $form = $this->getSearchForm();
+ $data = $form->getData();
+ $this->assertCount(1, $data['q']);
+ $this->assertNotContains('some-value', $data['q']);
+ $clone = $form->set('q', 'some-value');
+ $data = $clone->getData();
+ $this->assertCount(2, $data['q']);
+ $this->assertContains('some-value', $data['q']);
+ }
+
+ public function testRefAcceptsString()
+ {
+ $form = $this->getSearchForm();
+ $clone = $form->ref('some-ref');
+ $this->assertSearchFormClone($form, $clone);
+ $data = $clone->getData();
+ $this->assertSame('some-ref', $data['ref']);
+ }
+
+ public function testRefAcceptsRef()
+ {
+ $ref = current($this->apiData->getRefs());
+ $form = $this->getSearchForm();
+ $clone = $form->ref($ref);
+ $data = $clone->getData();
+ $this->assertSame((string) $ref, $data['ref']);
+ }
+
+ private function assertScalarOptionIsSet(SearchForm $form, string $key, $expectedValue)
+ {
+ $data = $form->getData();
+ $this->assertArrayHasKey($key, $data);
+ $this->assertSame($expectedValue, $data[$key]);
+ }
+
+ private function assertScalarOptionIsNotSet(SearchForm $form, string $key)
+ {
+ $data = $form->getData();
+ $this->assertArrayNotHasKey($key, $data);
+ }
+
+ public function testAfter()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->after('Whatever'),
+ 'after',
+ 'Whatever'
+ );
+ }
+
+ public function testLang()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->lang('en-gb'),
+ 'lang',
+ 'en-gb'
+ );
+ }
+
+ public function testPageSize()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->pageSize(99),
+ 'pageSize',
+ 99
+ );
+ }
+
+ public function testPage()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->page(99),
+ 'page',
+ 99
+ );
+ }
+
+ public function testFetchWithStringArgs()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->fetch('one', 'two', 'three'),
+ 'fetch',
+ 'one,two,three'
+ );
+ }
+
+ public function testFetchWithArrayArg()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->fetch(...['one','two','three']),
+ 'fetch',
+ 'one,two,three'
+ );
+ }
+
+ public function testFetchLinksWithStringArgs()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->fetchLinks('one', 'two', 'three'),
+ 'fetchLinks',
+ 'one,two,three'
+ );
+ }
+
+ public function testGraphQueryWithStringArg()
+ {
+ $query = '{
+ blogpost {
+ title
+ }
+ }';
+
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->graphQuery($query),
+ 'graphQuery',
+ $query
+ );
+ }
+
+ public function testOrderingsWithStringArgs()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->orderings('one', 'two', 'three'),
+ 'orderings',
+ '[one,two,three]'
+ );
+ }
+
+ public function testOrderingsStripsSquareBrackets()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->orderings('[my.foo desc]', '[my.bar]'),
+ 'orderings',
+ '[my.foo desc,my.bar]'
+ );
+ }
+
+ public function testOrderingsWillAcceptUnpackedArrays()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->orderings(...['[my.a]', 'my.b', 'my.c desc']),
+ 'orderings',
+ '[my.a,my.b,my.c desc]'
+ );
+ }
+
+ public function testOrderingsFiltersEmptyValues()
+ {
+ $this->assertScalarOptionIsSet(
+ $this->getSearchForm()->orderings(...['', 'my.b', '', 'my.c desc']),
+ 'orderings',
+ '[my.b,my.c desc]'
+ );
+ }
+
+ public function testOrderingsIsNotSetWhenOnlyEmptyValuesAreProvided()
+ {
+ $this->assertScalarOptionIsNotSet(
+ $this->getSearchForm()->orderings(...['', '']),
+ 'orderings'
+ );
+ }
+
+ public function testStringQueryIsUnprocessedInQuery()
+ {
+ $form = $this->getSearchForm()->query('[:d = at(document.id, "ValidIdentifier")]');
+ $data = $form->getData();
+ $this->assertArrayHasKey('q', $data);
+ $this->assertContains('[:d = at(document.id, "ValidIdentifier")]', $data['q']);
+ }
+
+ public function testSinglePredicateArgumentInQuery()
+ {
+ $predicate = Predicates::at('document.id', 'SomeId');
+ $expect = sprintf('[%s]', $predicate->q());
+ $form = $this->getSearchForm()->query($predicate);
+ $data = $form->getData();
+ $this->assertContains($expect, $data['q']);
+ }
+
+ public function testMultiplePredicatesInQuery()
+ {
+ $predicateA = Predicates::at('document.id', 'SomeId');
+ $predicateB = Predicates::any('document.tags', 'Some Tag');
+ $expect = sprintf('[%s%s]', $predicateA->q(), $predicateB->q());
+ $form = $this->getSearchForm()->query($predicateA, $predicateB);
+ $data = $form->getData();
+ $this->assertContains($expect, $data['q']);
+ }
+
+ public function testUnpackedPredicateArrayInQuery()
+ {
+ $query = [
+ Predicates::at('document.id', 'SomeId'),
+ Predicates::any('document.tags', 'Some Tag'),
+ ];
+ $expect = sprintf('[%s%s]', $query[0]->q(), $query[1]->q());
+ $form = $this->getSearchForm()->query(...$query);
+ $data = $form->getData();
+ $this->assertContains($expect, $data['q']);
+ }
+
+ public function testRegularArrayArgumentInQuery()
+ {
+ $query = [
+ Predicates::at('document.id', 'SomeId'),
+ Predicates::any('document.tags', 'Some Tag'),
+ ];
+ $expect = sprintf('[%s%s]', $query[0]->q(), $query[1]->q());
+ $form = $this->getSearchForm()->query($query);
+ $data = $form->getData();
+ $this->assertContains($expect, $data['q']);
+ }
+
+ public function testEmptyArgumentToQueryHasNoEffect()
+ {
+ $form = $this->getSearchForm()->query('');
+ $data = $form->getData();
+ $field = $this->form->getField('q');
+ $this->assertCount(1, $data['q']);
+ $this->assertContains($field->getDefaultValue(), $data['q']);
+ }
+
+ public function testUrlRemovesPhpArrayKeys()
+ {
+ $form = $this->getSearchForm()->query('query_string');
+ $url = $form->url();
+ $query = parse_url($url, PHP_URL_QUERY);
+ $this->assertSame(2, substr_count($query, 'q='));
+ }
+
+ public function testCachedResponseWillBeReturnedInSubmit()
+ {
+ $cachedJson = \json_decode('{"some":"data"}');
+ $this->cache->get(Argument::type('string'))->willReturn($cachedJson);
+ $response = $this->getSearchForm()->submit();
+ $this->assertSame($cachedJson, $response);
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\RuntimeException
+ * @expectedExceptionMessage Form type not supported
+ */
+ public function testExceptionIsThrownForInvalidForm()
+ {
+ $formJson = '{
+ "method": "POST",
+ "enctype": "application/x-www-form-urlencoded",
+ "action": "https://whatever/api/v2/documents/search",
+ "fields": {}
+ }';
+ $form = Form::withJsonString($formJson);
+ $searchForm = new SearchForm(
+ $this->httpClient->reveal(),
+ $this->cache->reveal(),
+ $form,
+ $form->defaultData()
+ );
+ $searchForm->submit();
+ }
+
+ public function testGuzzleExceptionsAreWrappedInSubmit()
+ {
+ $guzzleException = new \GuzzleHttp\Exception\TransferException('A Guzzle Exception');
+ /** @var \Prophecy\Prophecy\ObjectProphecy $this->httpClient */
+ $this->httpClient->request('GET', Argument::type('string'))->willThrow($guzzleException);
+ $this->cache->get(Argument::type('string'))->willReturn(null);
+ $form = $this->getSearchForm();
+ try {
+ $form->submit();
+ $this->fail('No exception was thrown');
+ } catch (\Prismic\Exception\RequestFailureException $e) {
+ $this->assertSame($guzzleException, $e->getPrevious());
+ }
+ }
+
+ private function prepareResponse(?string $body = null) : Response
+ {
+ $body = $body ? $body : '{"data":"data"}';
+ $response = new Response(
+ 200,
+ ['Cache-Control' => 'max-age=999'],
+ $body
+ );
+ $this->httpClient->request('GET', Argument::type('string'))->willReturn($response);
+ return $response;
+ }
+
+ public function testResponseJsonIsReturned()
+ {
+ $this->prepareResponse();
+ $this->cache->get(Argument::type('string'))->willReturn(null);
+ $this->cache->set(
+ Argument::type('string'),
+ Argument::type(\stdClass::class),
+ 999
+ )->shouldBeCalled();
+ $form = $this->getSearchForm();
+ $response = $form->submit();
+ $this->assertInstanceOf(\stdClass::class, $response);
+ $this->assertSame('data', $response->data);
+ }
+
+ public function testCountReturnsIntWhenPresentInResponseBody()
+ {
+ $this->prepareResponse('{"total_results_size":10}');
+ $this->cache->get(Argument::type('string'))->willReturn(null);
+ $this->cache->set(
+ Argument::type('string'),
+ Argument::type(\stdClass::class),
+ 999
+ )->shouldBeCalled();
+ $form = $this->getSearchForm();
+ $this->assertSame(10, $form->count());
+ }
+
+ /**
+ * @expectedException \Prismic\Exception\RuntimeException
+ * @expectedExceptionMessage Unable to decode json response
+ */
+ public function testExceptionIsThrownForInvalidJson()
+ {
+ $this->prepareResponse('Invalid JSON String');
+ $this->cache->get(Argument::type('string'))->willReturn(null);
+ $this->cache->set()->shouldNotBeCalled();
+ $form = $this->getSearchForm();
+ $form->submit();
+ }
+}
diff --git a/tests/Prismic/TestCase.php b/tests/Prismic/TestCase.php
new file mode 100644
index 00000000..deb38cfc
--- /dev/null
+++ b/tests/Prismic/TestCase.php
@@ -0,0 +1,20 @@
+ '1234'];
+ $this->assertEquals(Utils::buildUrl('https://test.prismic.io/api/v2', $parameters), $url);
+ }
+
+ public function testBuildUrl2()
+ {
+ $url = 'https://test.prismic.io/api/v2/documents/search?integrationFieldsRef=1234&page=2&pageSize=3&graphQuery=%7B%20blogpost%20%7B%20title%20%7D%20%7D';
+ $parameters = [
+ 'page' => '2',
+ 'pageSize' => '3',
+ 'graphQuery' => '{ blogpost { title } }'
+ ];
+ $this->assertEquals(Utils::buildUrl('https://test.prismic.io/api/v2/documents/search?integrationFieldsRef=1234', $parameters), $url);
+ }
+}
diff --git a/tests/fixtures/data.json b/tests/fixtures/data.json
index 6dd93f2f..900f3003 100644
--- a/tests/fixtures/data.json
+++ b/tests/fixtures/data.json
@@ -10,6 +10,11 @@
"id": "UkL0hcuvzYUANCrr",
"ref": "UgjWRd_mqbYHvPJa",
"label": "San Francisco Grand opening"
+ },
+ {
+ "id": "SaGrandOpening2ndRef",
+ "ref": "SaGrandOpening2ndRef",
+ "label": "San Francisco Grand opening"
}
],
"bookmarks": {
@@ -39,8 +44,109 @@
"type": "String"
}
}
+ },
+ "blogs": {
+ "name": "Blog Posts",
+ "method": "GET",
+ "rel": "collection",
+ "enctype": "application/x-www-form-urlencoded",
+ "action": "https://lesbonneschoses.prismic.io/api/v2/documents/search",
+ "fields": {
+ "ref": {
+ "type": "String",
+ "multiple": false
+ },
+ "q": {
+ "default": "[[:d = any(document.type, [\"blog-post\"])]]",
+ "type": "String",
+ "multiple": true
+ },
+ "lang": {
+ "type": "String",
+ "multiple": false
+ },
+ "page": {
+ "type": "Integer",
+ "multiple": false,
+ "default": "1"
+ },
+ "pageSize": {
+ "type": "Integer",
+ "multiple": false,
+ "default": "20"
+ },
+ "after": {
+ "type": "String",
+ "multiple": false
+ },
+ "fetch": {
+ "type": "String",
+ "multiple": false
+ },
+ "fetchLinks": {
+ "type": "String",
+ "multiple": false
+ },
+ "graphQuery": {
+ "type": "String",
+ "multiple": false
+ },
+ "orderings": {
+ "type": "String",
+ "multiple": false
+ },
+ "referer": {
+ "type": "String",
+ "multiple": false
+ },
+ "access_token": {
+ "default": "a-permanent-access-token",
+ "type": "String",
+ "multiple": false
+ }
+ }
}
},
"oauth_initiate": "http://lesbonneschoses.prismic.io/auth",
- "oauth_token": "http://lesbonneschoses.prismic.io/auth/token"
+ "oauth_token": "http://lesbonneschoses.prismic.io/auth/token",
+ "experiments" : {
+ "draft": [
+ {
+ "id": "xxxxxxxxxxoGelsX",
+ "name": "Exp 2",
+ "variations": [
+ {
+ "id": "VDUBBawGAKoGelsZ",
+ "label": "Base",
+ "ref": "VDUBBawGALAGelsa"
+ },
+ {
+ "id": "VDUE-awGALAGemME",
+ "label": "var 1",
+ "ref": "VDUUmHIKAZQKk9uq"
+ }
+ ]
+ }
+ ],
+ "running": [
+ {
+ "googleId": "_UQtin7EQAOH5M34RQq6Dg",
+ "id": "VDUBBawGAKoGelsX",
+ "name": "Exp 1",
+ "variations": [
+ {
+ "id": "VDUBBawGAKoGelsZ",
+ "label": "Base",
+ "ref": "VDUBBawGALAGelsa"
+ },
+ {
+ "id": "VDUE-awGALAGemME",
+ "label": "var 1",
+ "ref": "VDUUmHIKAZQKk9uq"
+ }
+ ]
+ }
+ ]
+ }
+
}