prismic/php-sdk

PHP development kit for prismic.io

Wednesday, February 14, 2018
by sre
Repository
18 Watchers
72 Stars
129,234 Installations

PHP
12 Dependents
0 Suggesters
39 Forks
9 Open issues
86 Versions
11 % Grown

The README.md

Prismic.io PHP SDK

[][github-actions-ci-href] , _(*1)

This is the official PHP SDK for Prismic.io, providing a straightforward way to connect to Prismic’s headless API. It is maintained by the community to help developers get started with Prismic in PHP., _(*2)

Offers an easy-to-use interface for basic interactions with Prismic content
Covers core features of the Prismic API

Getting started

Installation

Installation using Composer:, _(*3)

$ composer require prismic/php-sdk

Recommended PHP Extensions

We recommend installing and enabeling the APCu extension to have the built-in default cache support. Otherwise, you can implement your own cache strategy by extending the Prismic\Cache\CacheInterface interface., _(*4)

Basic Usage & API calls

If you are not using automatic autoloading, include the Composer autoload file:, _(*5)

<?php
include_once __DIR__.'/../vendor/autoload.php';

use Prismic\Api;

Then you can start making your first API calls:, _(*6)

$api = Api::get('https://your-repo-name.prismic.io/api/v2');
$document = $api->getByUID('get-started-type', 'get-started');

DOM Helper

The PHP SDK provides a set of DOM helpers to help you render your Prismic content., _(*7)

In these examples we have a document variable corresponding to the fetched Prismic document. We also have a $linkResolver variable containing the functional link resolver, read our docs to learn more about Link Resolving., _(*8)

Link

<?php
use Prismic\Dom\Link;

echo Link::asUrl($document->data->link, $linkResolver);

Rich Text

<?php
use Prismic\Dom\RichText;

echo RichText::asText($document->data->title);
echo RichText::asHtml($document->data->description, $linkResolver);

Date

<?php
use Prismic\Dom\Date;

$date = Date::asDate($document->data->date);
echo $date->format('Y-m-d H:i:s');

More information

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!, _(*9)

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering., _(*10)

Suggesting an improvement: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more., _(*11)

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented., _(*12)

For more clarity on this project, check out the detailed CONTRIBUTING.md for our guidelines., _(*13)

License

This software is licensed under the Apache 2 License, quoted below:, _(*14)

Copyright 2013-2024 Prismic <contact@prismic.io> (https://prismic.io)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

The Versions

14/02 2018

dev-master

9999999-dev

PHP development kit for prismic.io

library php-sdk

PHP development kit for prismic.io

prismic/php-sdk

The README.md

Prismic.io PHP SDK

Overview

Getting started

Installation

Recommended PHP Extensions

Basic Usage & API calls

DOM Helper

Link

Rich Text

Date

More information

Contributing

License

The Versions

dev-master

The Requires

The Development Requires

4.0.0-beta

The Requires

The Development Requires

dev-apiv2

The Requires

The Development Requires

3.4.2

The Requires

The Development Requires

dev-docs-gh-pages

The Requires

The Development Requires

dev-jbdb/api-v2

The Requires

The Development Requires

3.4.1

The Requires

The Development Requires

3.4.0

The Requires

The Development Requires

3.3.2

The Requires

The Development Requires

3.3.1

The Requires

The Development Requires

dev-sre/remove-symphony-deps

The Requires

The Development Requires

3.3.0

The Requires

The Development Requires

dev-new-slice-wip

The Requires

The Development Requires

3.2.2

The Requires

The Development Requires

3.2.1

The Requires

The Development Requires

3.2.0

The Requires

The Development Requires

dev-missing-helpers

The Requires

The Development Requires

3.1.0

The Requires

The Development Requires

dev-alw/cache

The Requires

The Development Requires

3.0.0

The Requires

The Development Requires

2.0.3

The Requires