Skip to content
This repository was archived by the owner on Apr 3, 2025. It is now read-only.
This repository was archived by the owner on Apr 3, 2025. It is now read-only.

token, version and cv ignored for API requests #109

@Bl00D4NGEL

Description

@Bl00D4NGEL

When using the PHP Storyblok client one can pass in any of the documented parameters from the documentation. When using methods like getStories the client is calling the "Get multiple stories" endpoint described here which is expected. The documentation lists token, version and cv as possible query parameters (they're currently the first three parameters listed). Passing these parameters in however results in them being ignored/overwritten by the internal logic of the function.

This is caused by this array_merge call:

$options = array_merge($options, $this->getApiParameters());

this causes the result of $this->getApiParameters() to overwrite the values in $options which is unexpected (and probably unintended behaviour).

Switching the argument order in the array_merge call fixes this problem and makes the client respect any overwrites to token, version and/or cv.

Expected Behavior

Passing in either of token, version or cv in the $options array of for example Client::getStories() is not overwritten by internal parameters

Current Behavior

When passing in either of token, version or cv in the $options array of for example Client::getStories() the values are overwritten by internal parameters.

This happens for any function that calls the API and has the above described array_merge function parameter order.

Steps to Reproduce

$client = new Client('<your token here');
// The story "version" returned depends on whether `$_GET['_storyblok']` is set when constructing the client since it sets `Client::editModeEnabled` to it's value.
// See \Storyblok\Client::__construct and \Storyblok\Client::getVersion
// Passing in `'version' => 'draft'` here makes no difference, only manually calling `editMode` with either `true` or `false` changes the version
$stories = $client->getStories([
    'version' => 'draft',
]);

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions