Storyblok Management API PHP Client

https://github.com/storyblok/php-management-api-client
Admin
A PHP client library for integrating with Storyblok's Management API, simplifying interactions with...
Tokens:8,212
Snippets:43
Trust Score:10
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Storyblok Management API PHP Client

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Installs the Storyblok Management API PHP client library using Composer. This is the primary method for adding the library to your PHP project.

```shell
composer require storyblok/php-management-api-client
```

--------------------------------

### Initialize AssetApi Instance

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Initializes the AssetApi instance, which is used for managing assets within a Storyblok space. This setup is the first step before performing operations like getting, uploading, updating, or deleting assets.

```php
use Storyblok\ManagementApi\Endpoints\AssetApi;
use Storyblok\ManagementApi\ManagementApiClient;
$client = new ManagementApiClient($storyblokPersonalAccessToken);

$spaceId = "spaceid";
$assetApi = new AssetApi($client, $spaceId);
```

--------------------------------

### Practical Example: Upload Asset and Create Story

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

A comprehensive example that first uploads an image asset and then creates a new Storyblok story. The story includes a title, body, the uploaded image as an asset field, and is assigned tags.

```php
use Storyblok\ManagementApi\Data\Story;
use Storyblok\ManagementApi\ManagementApiClient;
use Storyblok\ManagementApi\Data\StoryComponent;
use Storyblok\ManagementApi\Endpoints\StoryApi;
use Storyblok\ManagementApi\Endpoints\AssetApi;

$client = new ManagementApiClient($storyblokPersonalAccessToken);

$spaceId = "your-space-id";
$storyApi = new StoryApi($client, $spaceId);
$assetApi = new AssetApi($client, $spaceId);

echo "UPLOADING ASSET..." . PHP_EOL;
$assetCreated = $assetApi->upload("image.png")->data();
echo "Asset created, ID: " . $assetCreated->id() . PHP_EOL;

echo "PREPARING STORY CONTENT DATA..." . PHP_EOL;
$content = new StoryComponent("article-page");
$content->set("title", "New Article");
$content->set("body", "This is the content");
$content->setAsset("image", $assetCreated);

echo "INITIALIZING STORY OBJECT..." . PHP_EOL;
$story = new Story(
    "An Article",
    "an-article-" . random_int(10000, 99999),
    $content
);
$story->setTagsFromArray(["aaa", "bbb", "CCC"]);

echo "CREATING STORY..." . PHP_EOL;
$storyCreated = $storyApi->create($story)->data();
echo "Story created, ID: " . $storyCreated->id() . PHP_EOL;
echo "             UUID: " . $storyCreated->uuid() . PHP_EOL;
echo "             SLUG: " . $storyCreated->slug() . PHP_EOL;
```

--------------------------------

### Initialize StoryApi

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows how to get an instance of the `StoryApi` class, which is necessary for performing operations on stories within a Storyblok space. It requires a `ManagementApiClient` instance and the `spaceId`.

```php
use Storyblok\ManagementApi\ManagementApiClient;
use Storyblok\ManagementApi\Endpoints\StoryApi;

$spaceId= "1234";
$client = new ManagementApiClient($storyblokPersonalAccessToken);
$storyApi = new StoryApi($client, $spaceId);
```

--------------------------------

### Get a Page of Stories

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves a paginated list of stories from a space using the `page()` method of the `StoryApi` class. By default, it fetches 25 stories per page. The example iterates through the stories and prints their IDs and names.

```php
use Storyblok\ManagementApi\Endpoints\StoryApi;

$storyApi = new StoryApi($client, $spaceId);
$stories = $storyApi->page()->data();
foreach ($stories as $story) {
    echo $story->id() . " - " . $story->name() . PHP_EOL;
}
```

--------------------------------

### Retrieve Internal Tags using ManagementApi

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

This example shows how to retrieve internal tags using the ManagementApi class. It covers initializing the client, obtaining the ManagementApi instance, making a GET request to the internal tags endpoint with query parameters, and accessing the response data.

```php
$client = new ManagementApiClient($storyblokPersonalAccessToken);

$managementApi = new ManagementApi($client);
$spaceId = "12345";
$response = new ManagementApi($client)->get(
    "spaces/{$spaceId}/internal_tags",
    [
        "by_object_type" => "asset",
        //"search" => "some"
    ]
);

echo $response->getLastCalledUrl() . PHP_EOL;
// https://mapi.storyblok.com/v1/spaces/321388/internal_tags?by_object_type=asset

echo $response->asJson();
// The returned JSON {"internal_tags":[ ... ]}

echo "Total Tags: " . $response->total() . PHP_EOL;
// Total Tags: 8

$tags = $response->data()->get("internal_tags");

foreach ($tags as $tag) {
    $name = $tag->get("name");
    $id = $tag->get("id");
    $objectType = $tag->get("object_type");
}
```

--------------------------------

### Getting the TagApi Instance

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows how to instantiate the TagApi class, which is used for managing tags within Storyblok. This involves creating a ManagementApiClient and then initializing TagApi with the client and space ID.

```php
use Storyblok\ManagementApi\Endpoints\TagApi;
use Storyblok\ManagementApi\ManagementApiClient;

$client = new ManagementApiClient($storyblokPersonalAccessToken);

$spaceId = "spaceid";
$tagApi = new TagApi($client, $spaceId);
```

--------------------------------

### Uploading an Asset

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Provides an example of uploading a file, such as an image, using the upload() method of the AssetApi. It then prints the ID and filenames of the created asset.

```php
$assetCreated = $assetApi->upload("image.png")->data();

echo "Asset created, ID: " . $assetCreated->id() . PHP_EOL;
echo "         filename: " . $assetCreated->filename() . PHP_EOL;
echo "     filename CDN: " . $assetCreated->filenameCDN() . PHP_EOL;
```

--------------------------------

### Load Personal Access Token from Environment Variable

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Provides an example of loading the Storyblok Personal Access Token from an environment variable using the `vlucas/phpdotenv` package. This is a recommended practice for securely managing credentials.

```php
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
$dotenv->load();
$storyblokPersonalAccessToken = $_ENV['SECRET_KEY'];
$client = new ManagementApiClient($storyblokPersonalAccessToken);
```

--------------------------------

### Get Specific Space Details

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows how to retrieve detailed information for a specific Storyblok space using its unique ID. This involves instantiating the `SpaceApi` and calling the `get` method with the space ID.

```php
use Storyblok\ManagementApi\Endpoints\SpaceApi;

// Initialize the client and SpaceApi (assuming $clientEU is defined)
$spaceId = "12345";
$spaceApi = new SpaceApi($clientEU);
$space = $spaceApi->get($spaceId)->data();

printf(" The name for the Space id : %s is : %s . Plan: %s - %s" ,
    $spaceId,
    $space->name(),
    $space->planLevel(),
    $space->planDescription()
);
```

--------------------------------

### Get Story by ID

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves a single story using its unique identifier. The `get()` method fetches the story, and `data()` extracts the story object.

```php
$storyId= "1234";
$story = $storyApi->get($storyId)->data();
echo $story->name() . PHP_EOL;
```

--------------------------------

### Getting the Tags List

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to retrieve a list of tags using the page() method of the TagApi. It iterates through the returned tags, printing their name, taggings count, and tag on stories.

```php
$pageNumber=1;
$itemsPerPage= 5;
$response = $tagApi->page($pageNumber, $itemsPerPage);
echo "Total Tags: " . $response->total() . PHP_EOL;
/** @var TagsData $tags */
$tags = $response->data();
foreach ($tags as $key => $tag) {
    echo $tag->name() . PHP_EOL;
    echo $tag->taggingsCount() . PHP_EOL;
    echo $tag->tagOnStories() . PHP_EOL;
    echo "---" . PHP_EOL;
}
```

--------------------------------

### Getting a Specific Asset

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows how to retrieve a single asset using its ID and access its properties such as ID, content type, content length, filename, and CDN filename.

```php
$asset = $assetApi->get($assetId)->data();
echo $asset->id() . PHP_EOL;
echo $asset->contentType() . PHP_EOL;
echo $asset->contentLength() . PHP_EOL;
echo $asset->filenameCDN() . PHP_EOL;
echo $asset->filename() . PHP_EOL;
echo "---" . PHP_EOL;
```

--------------------------------

### Get Assets List

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves a list of assets from a Storyblok space using the AssetApi. It demonstrates how to fetch assets and iterate through the response to display asset details like ID, content type, and filename.

```php
$assetApi = new AssetApi($client, $spaceId);
$assets = $assetApi->page()->data();

foreach ($assets as $key => $asset) {
    echo $asset->id() . PHP_EOL;
    echo $asset->contentType() . PHP_EOL;
    echo $asset->contentLength() . PHP_EOL;
    echo $asset->filenameCDN() . PHP_EOL;
    echo "---" . PHP_EOL;
}
```

--------------------------------

### Get Stories Response Details

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to retrieve detailed response information when fetching stories, including status code, last called URL, total items, and items per page, by calling the `page()` method without immediately accessing the data.

```php
$response = $storyApi->page();

echo "STATUS CODE : " . $response->getResponseStatusCode() . PHP_EOL;
echo "LAST URL    : " . $response->getLastCalledUrl() . PHP_EOL;
echo "TOTAL       : " . $response->total() . PHP_EOL;
echo "PAR PAGE    : " . $response->perPage() . PHP_EOL;

$stories = $response->data();
echo "Stories found with the page: " . $stories->howManyStories() . PHP_EOL;
foreach ($stories as $key => $story) {
    echo $story->id() . "  " .
    $story->getName() . PHP_EOL;
}
```

--------------------------------

### Get Current User Information

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves information about the current user associated with the provided Personal Access Token. It demonstrates how to use the UserApi to fetch user details and access them via the User object.

```php
use Storyblok\ManagementApi\Endpoints\UserApi;
use Storyblok\ManagementApi\ManagementApiClient;

$client = new ManagementApiClient(getAccessToken());

$currentUser = (new UserApi($client))->me()->data();
// "User ID"
echo $currentUser->id() . PHP_EOL;
// "User identifier"
echo $currentUser->userid() . PHP_EOL;
// "User email"
echo $currentUser->email() . PHP_EOL;
// "User has Organization"
echo ($currentUser->hasOrganization() ? " HAS ORG:" . $currentUser->orgName() : "NO ORG") . PHP_EOL;
// "User has Partner"
echo ($currentUser->hasPartner() ? " HAS PARTNER" : "NO PARTNER") . PHP_EOL;;
```

--------------------------------

### Storyblok Management API Client Overview

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Provides an overview of the Storyblok Management API Client, highlighting the use of generic `ManagementApi` for flexible interactions and specialized classes like `StoryApi`, `SpaceApi`, `AssetApi`, `TagApi`, and `UserApi` for resource-specific operations. It explains how to choose between these approaches based on project needs.

```php
use Storyblok\ManagementApi\ManagementApi;
use Storyblok\ManagementApi\Endpoints\StoryApi;
use Storyblok\ManagementApi\Endpoints\SpaceApi;
use Storyblok\ManagementApi\Endpoints\AssetApi;
use Storyblok\ManagementApi\Endpoints\TagApi;
use Storyblok\ManagementApi\Endpoints\UserApi;

// Using the generic ManagementApi
$client = new ManagementApi($accessToken);
$response = $client->get('spaces');

// Using a specialized API class (e.g., SpaceApi)
$spaceApi = new SpaceApi($client);
$spaces = $spaceApi->all();
```

--------------------------------

### Fetch All Components

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Fetches all components from a specific Storyblok space using the ComponentApi class. It demonstrates how to initialize the client, retrieve components, and iterate through them to display names and IDs.

```php
use Storyblok\ManagementApi\ManagementApiClient;
use Storyblok\ManagementApi\Api\ComponentApi;
use Psr\Log\NullLogger;

$client = new ManagementApiClient($storyblokPersonalAccessToken);

// Define your space ID
$spaceId = "YOUR_SPACE_ID";

// Initialize the Component API
$componentApi = new ComponentApi($client, $spaceId, new NullLogger());

// Retrieve all components
$componentsResponse = $componentApi->all();
$components = $componentsResponse->data();

// Loop through and print component names and IDs
foreach ($components as $component) {
    echo $component->name() . " - " . $component->id() . PHP_EOL;
}
```

--------------------------------

### Initialize ManagementApiClient

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to initialize the ManagementApiClient with a personal access token. This client is used to interact with the Storyblok Management API.

```php
<?php
require 'vendor/autoload.php';

use Storyblok\ManagementApi\ManagementApiClient;

/** @var ManagementApiClient $client */
$client = new ManagementApiClient($storyblokPersonalAccessToken);
```

--------------------------------

### Create Story with Nested Components

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates creating a Storyblok story with nested components. It shows how to instantiate components, set their fields and assets, nest them within other components, and finally create and publish the story using the Management API client.

```php
$client = new ManagementApiClient("yourpersonalaccesstoken");
$spaceId = "yourspaceid";
$storyApi = new StoryApi($client, $spaceId);

// Setting up the hero-section
$heroSection = new StoryComponent("hero-section");
$heroSection->set("headline", "Hello World");
// We are going to setup an external image as background
$heroSection->setAsset("background_image", Asset::emptyAsset()->setExternalUrl("https://images.pexels.com/photos/18853169/pexels-photo-18853169/free-photo-of-tower-old-north-church-mirroring-in-puddle.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2"));
$heroSection->setAsset("background_video", Asset::emptyAsset());
$heroSection->set("text_color", "light");
$heroSection->set("vertical_alignment", "center");
$heroSection->set("horizontal_alignment", "center");

// Setting up the Button
$button = new StoryComponent("button");
$button->set("label", "Click here");
$button->set("style", "default");
$button->set("background_color", "primary");
$button->set("text_color", "light");
$button->set("size", "small");
$button->set("border_radius", "small");


// Setting up the Image Text Section
$imageTextSection = new StoryComponent("image-text-section");
$imageTextSection->set("headline", "Hello World");
$imageTextSection->setAsset("image", Asset::emptyAsset());
// Adding the Button to the Image Text Section (field name `button`)
$imageTextSection->addBlock("button", $button);

// Let's create the content type `default-page`
$page = new StoryComponent("default-page");
// Adding the Hero Section and the Image Text Section to the `body` field
$page->addBlock("body", $heroSection);
$page->addBlock("body", $imageTextSection);

$random = random_int(1_000_000, 9_999_999);
$story = new Story(
    "Landing " . $random,
    "landing-" . $random,
    $page
);

$storyCreated = $storyApi->create($story)->data();
echo "Story created with ID   : " . $storyCreated->id();
echo PHP_EOL;
$storyCreated->dump();
echo PHP_EOL;
// If we want to publish the story immediately ...
$storyPublished = $storyApi->publish($storyCreated->id())->data();
echo "Story published with ID : " . $storyPublished->id();
echo PHP_EOL;
echo "Story published at      : " . $storyPublished->publishedAt();
echo PHP_EOL;

```

--------------------------------

### Update Space Settings

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to update space settings, including domain, preview URLs, and languages, using the `update()` method of the `SpaceApi` class. It first retrieves existing space data and then applies changes using a `Space` object.

```php
$spaceId="your-space-id";
$spaceApi = new SpaceApi($client);

// Getting a space
$space = $spaceApi->get($spaceId)->data();
echo "Current domain: " . $space->get("domain") . PHP_EOL;
echo "Current token: " . $space->get("first_token") . PHP_EOL;
/** @var StoryblokData $environments */
$environments = $space->get("environments");
/** @var StoryblokData $languages */
$languages = $space->get("languages");

// Now, let's start collecting data you want to change
$editSpace = new Space("Your new space name");
$editSpace->set("id", $spaceId);
// you can set the domain for preview URL
$editSpace->set("domain", "https://your-preview-domain/");
// you can add new preview URLs (for example the localhost)
if ($environments->count() === 0 ) {
    $editSpace->set("environments.0.name", "Demo Local Development");
    $editSpace->set("environments.0.location", "https://localhost:3000/");
}
// You can add languages programmatically
if ($languages->count() === 0 ) {
    $editSpace->set("languages.0.code", "it");
    $editSpace->set("languages.0.name", "Italian");
    $editSpace->set("languages.1.code", "de");
    $editSpace->set("languages.1.name", "German");
}

try {
    $spaceApi->update($spaceId, $editSpace);
} catch (Exception $e) {
    echo $e->getMessage();
}
```

--------------------------------

### Create Resource with Storyblok Management API

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates creating a new internal tag using the ManagementApi's post method. It includes defining tag details, sending the POST request, and handling the response to check for success or errors.

```php
// Define the tag details
$tag = [
    "name" => "new tag",
    "object_type" => "asset"
];

// Send the POST request to create the tag
$response = $managementApi()->post(
    "spaces/{$spaceId}/internal_tags",
    ["internal_tag" => $tag]
);

// Show the URL of the response
echo $response->getLastCalledUrl() . PHP_EOL;

if ($response->isOk()) {
    // Parse the created tag data
    $createdTag = $response->data()->get("internal_tag");
    echo "Tag created with id: " . $createdTag->get("id") . PHP_EOL;
    echo $createdTag->toJson();
} else {
    // Handle errors
    echo $response->getErrorMessage();
}
```

--------------------------------

### Handling Spaces with SpaceApi

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to use the `SpaceApi` class to manage spaces within Storyblok. This includes importing the necessary classes, retrieving all spaces, and iterating through them to access individual space details.

```php
use Storyblok\ManagementApi\Endpoints\SpaceApi;
use Storyblok\ManagementApi\Data\Space;

// Initialize the client (assuming $accessToken is defined)
$client = new ManagementApiClient($accessToken);
$spaceApi = new SpaceApi($client);

// Retrieve all spaces
$response = $spaceApi->all();
$spaces = $response->data();

// Loop through spaces
$spaces->forEach( function (Space $space) {
    printf("SPACE : %s (%s) - %s - created at: %s as %s" ,
        $space->id(),
        $space->region(),
        $space->name(),
        $space->createdAt(),
        $space->planDescription()
    );
    echo PHP_EOL;
});
```

--------------------------------

### Create a Single Story

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Creates a new story with a specified name, slug, and content. It utilizes the `Story` and `StoryComponent` classes for data structuring and includes error handling for the creation process.

```php
use Storyblok\ManagementApi\Data\Story;
use Storyblok\ManagementApi\Data\StoryComponent;

$content = new StoryComponent("article-page");
$content->set("title", "My New Article");
$content->set("body", "This is the content");
// $content->setAsset("image", $assetCreated);

$story = new Story(
    name: "A Story",
    slug: "a-story",
    content: $content
);
try{
    $storyCreated = $storyApi->create($story)->data();
    echo "Created Story: " . $storyCreated->id() . " - " . $storyCreated->name() . PHP_EOL;
} catch (ClientException $e) {
    echo "Error while creating story: " . PHP_EOL;
    echo $e->getResponse()->getContent(false);
    echo PHP_EOL;
    echo $e->getMessage();
}
echo PHP_EOL;
```

--------------------------------

### Workflow API - Creating a Custom Workflow

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows how to create a new custom workflow using the `WorkflowApi` class. It involves creating a `WorkflowData` object, setting its name, and then calling the `create` method.

```php
use Storyblok\ManagementApi\Endpoints\WorkflowApi;
use Storyblok\ManagementApi\Data\WorkflowData;

$workflowApi = new WorkflowApi($client, $spaceId);
$workflowData = new WorkflowData();
$workflowData->setName("Name");
$response = $workflowApi->create($workflowData);

```

--------------------------------

### Workflow Stage API - Retrieving Workflow Stages

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to retrieve a list of workflow stages using the `WorkflowStageApi` class. It iterates through the stages and prints their names and IDs.

```php
use Storyblok\ManagementApi\Endpoints\WorkflowStageApi;

$response = $workflowStageApi->list();
/** @var WorkflowsData $workflows */
$workflowStages = $response->data();
foreach ($workflowStages as $key => $workflowStage) {
    echo "Workflow Stage: " . $workflowStage->name() . " - ";
    echo $workflowStage->id() . PHP_EOL;
}

```

--------------------------------

### Import ManagementApiClient Class

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows the necessary `use` statement to import the ManagementApiClient class for use in your PHP code.

```php
use Storyblok\ManagementApi\ManagementApiClient;
```

--------------------------------

### Create New Component

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Programmatically creates a new component in a Storyblok space. This involves defining component properties, setting fields, and handling potential exceptions during the creation process.

```php
// Define a new component
$component = new Component("my-component-1234567");
$component->setDisplayName("My Component");
$component->setRoot(); // Mark as a root component
$component->setPreviewField("title");

// Add fields
$component->setField("title", ["type" => "text"]);
$component->setField("headline", ["type" => "text"]);
$component->setField("image", ["type" => "asset"]);

try {
    // Create the component in Storyblok
    $componentResponse = $componentApi->create($component);
    $newComponent = $componentResponse->data();

    // Output the new component's ID
    echo "Component created with ID: " . $newComponent->id() . PHP_EOL;

    // Dump full component details (for debugging)
    $newComponent->dump();
} catch (Exception $e) {
    echo "Error creating component: " . $e->getMessage();
}
```

--------------------------------

### Filtering Assets with AssetsParams

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to filter assets using the AssetsParams class, including filtering by folder and searching by filename. It also shows how to use PaginationParams to retrieve a specific page of results.

```php
use Storyblok\ManagementApi\QueryParameters\{AssetsParams,PaginationParams};

$assetApi = new AssetApi($client, $spaceId);
$assets = $assetApi->page(
    new AssetsParams(
        inFolder: -1,
        search: "something"
    ),
    new PaginationParams(1,1000)
)->data();
```

--------------------------------

### Workflow API - Retrieving Workflows

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to retrieve a list of workflows using the `WorkflowApi` class. It iterates through the retrieved workflows, printing their names, associated content types, and default status.

```php
use Storyblok\ManagementApi\Endpoints\WorkflowApi;

$workflowApi = new WorkflowApi($client, $spaceId);
$response = $workflowApi->list();
/** @var WorkflowsData $workflows */
$workflows = $response->data();

foreach ($workflows as $key => $workflow) {
    echo $workflow->name() . PHP_EOL;
    echo print_r($workflow->contentTypes(), true) . PHP_EOL;
    echo $workflow->isDefault() . PHP_EOL;
    echo "---" . PHP_EOL;
}

```

--------------------------------

### Trigger Space Backup

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Initiates a backup for a specific Storyblok space using the `backup()` method of the `SpaceApi` class. It checks the response to confirm if the backup was successful or to retrieve any error messages.

```php
// Create a backup for a space
try {
    $response = $spaceApi->backup($spaceID);
    if ($response->isOk()) {
        echo "BACKUP DONE!";
    } else {
        echo $response->getErrorMessage() . PHP_EOL;
    }
} catch (Exception $e) {
    echo "Error, " . $e;
}
```

--------------------------------

### Creating a New Tag

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Illustrates how to create a new tag with a given name using the create() method of the TagApi. It checks if the creation was successful and prints the name of the created tag or an error message.

```php
$assetName = "tag-" . random_int(100, 999);
$response = $tagApi->create($assetName);
if ($response->isOk()) {
    $tagCreated = $response->data();
    $name = $tagCreated->name();
		echo "TAG Created: " . $name . PHP_EOL;

} else {
    echo $response->getErrorMessage();
}
```

--------------------------------

### Publish a Story

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Publishes an existing story identified by its ID. This action makes the story live according to its publishing settings.

```php
$storyApi->publish($storyId);
```

--------------------------------

### Retrieve Component Folders

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves component folders from a previously fetched component response. This method is used to access the folder structure associated with components in a Storyblok space.

```php
$folders = $componentsResponse->dataFolders();
```

--------------------------------

### Create Stories in Bulk from CSV

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Efficiently creates multiple stories by processing data from a CSV file. It uses `SplFileObject` for reading the CSV and the `StoryBulkApi::createStories` method, which handles rate limiting and retries.

```csv
myslug-001;My Story 1 BULK;page
myslug-002;My Story 2 BULK;page
myslug-003;My Story 3 BULK;page
```

```php
use Storyblok\ManagementApi\Data\Story;
use Storyblok\ManagementApi\Data\StoryComponent;
use Storyblok\ManagementApi\Endpoints\StoryBulkApi;
use Storyblok\ManagementApi\ManagementApiClient;

$client = new ManagementApiClient($storyblokPersonalAccessToken);
$storyBulkApi = new StoryBulkApi($client, $spaceId);
$file = new SplFileObject("stories.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl(separator: ";");
$stories = [];
foreach ($file as $row) {
    list($slug, $name, $contentType) = $row;
    $story = new Story(
        $name,
        $slug,
        new StoryComponent($contentType)
    );
    $stories[] = $story;
}
$createdStories = iterator_to_array($storyBulkApi->createStories($stories));
```

--------------------------------

### Filter Stories by Headline (like)

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves all stories where the 'headline' field matches the provided pattern. This uses the `StoryBulkApi` and `QueryFilters` for advanced filtering.

```php
use Storyblok\ManagementApi\Endpoints\StoryBulkApi;
use Storyblok\ManagementApi\QueryParameters\Filters\Filter;
use Storyblok\ManagementApi\QueryParameters\Filters\QueryFilters;

$storyBulkApi = new StoryBulkApi($client, $spaceId);
$stories = $storyBulkApi->all(
    filters: (new QueryFilters())->add(
        new Filter(
            "headline",
            "like",
            "%mars%"
        )
    )
);
foreach ($stories as $story) {
    echo $story->name() . PHP_EOL;
}
```

--------------------------------

### Filter Stories by Component and Pagination

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Illustrates how to filter stories based on a component type (e.g., 'hero-section') and apply custom pagination parameters (page number and stories per page) using `StoriesParams` and `PaginationParams` with the `page()` method.

```php
use Storyblok\ManagementApi\Endpoints\StoryApi;

$storyApi = new StoryApi($client, $spaceId);
$stories = $storyApi->page(
    new StoriesParams(containComponent: "hero-section"),
    page: new PaginationParams(2, 10)
)->data();
echo "Stories found: " . $stories->count();
echo " STORY : " . $stories->get("0.name") . PHP_EOL;
```

--------------------------------

### Create Workflow Stage

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

This snippet demonstrates how to create a new custom workflow stage in Storyblok. It first retrieves a workflow ID and then uses the WorkflowStageApi to create the stage with a specified name.

```php
$workflowApi = new WorkflowApi($client, $spaceId);
$response = $workflowApi->list();
$workflowId = $response->data()->get("0.id");

use Storyblok\ManagementApi\Data\WorkflowStageData;

$workflowStageApi = $client->workflowStageApi($spaceId);
$workflowStageData = new WorkflowStageData();
$workflowStageData->setName("Name");
$workflowStageData->setWorkflowId($workflowId);
$response = $workflowStageApi->create($workflowStageData);
```

--------------------------------

### Set ManagementApiClient Region

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Illustrates how to initialize the ManagementApiClient with a specific region using the Region enum. This is useful for targeting different Storyblok data centers.

```php
use \Storyblok\ManagementApi\Data\Enum\Region;

$client = new ManagementApiClient($storyblokPersonalAccessToken, Region::US);
```

--------------------------------

### Deleting an Asset

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Demonstrates how to delete an asset by providing its ID to the delete() method of the AssetApi. It confirms the deletion by printing the ID of the deleted asset.

```php
$assetApi = new AssetApi($client, $spaceId);
echo "DELETING " . $assetId . PHP_EOL;
$deletedAsset = $assetApi->delete($assetId)-data();
echo "DELETED ASSET, ID : " . $deletedAsset->id() . PHP_EOL;
```

--------------------------------

### Edit Resource with Storyblok Management API

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Shows how to update an existing resource, like an internal tag, using the ManagementApi's put method. It involves modifying resource data and sending an update request to the appropriate endpoint with the resource's ID.

```php
$tag["name"] = $tag["name"] . "-UPDATED";
$response = $managementApi()->put(
    "spaces/{$spaceId}/internal_tags/{$id}",
    ["internal_tag" => $tag]
);
if ($response->isOk()) {
    echo "Updated Response : <" . $response->getResponseBody() . ">" . PHP_EOL;
    echo "Tag updated via id: " . $id . PHP_EOL;
} else {

    echo $response->getErrorMessage() . PHP_EOL;
}
```

--------------------------------

### Filter Stories by Content Type (in)

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Retrieves all stories that have a specific content type, in this case, 'article-page'. This demonstrates filtering using the 'component' field.

```php
$stories = $storyApi->all(
    filters: (new QueryFilters())->add(
        new Filter(
            "component",
            "in",
            "article-page"
        )
    )
);
foreach ($stories as $story) {
    echo $story->name() . PHP_EOL;
}
```

--------------------------------

### Delete Resource with Storyblok Management API

Source: https://github.com/storyblok/php-management-api-client/blob/main/README.md

Explains how to delete a resource, such as an internal tag, using the ManagementApi's delete method. It requires specifying the endpoint and the resource's ID to remove the resource.

```php
$response = $managementApi()->delete(
    "spaces/{$spaceId}/internal_tags/{$id}"
);
if ($response->isOk()) {
    echo "Response from a delete is empty: <" . $response->getResponseBody() . ">" . PHP_EOL;
    echo "Tag deleted via id: " . $id . PHP_EOL;
} else {
    echo $response->getErrorMessage() . PHP_EOL;
}
```
Tokens:
Raw