Download the PHP package netglue/prismic-doctype-client without Composer
On this page you can find all versions of the php package netglue/prismic-doctype-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download netglue/prismic-doctype-client
More information about netglue/prismic-doctype-client
Files in netglue/prismic-doctype-client
Package prismic-doctype-client
Short Description Prismic Custom Type API Client
License MIT
Homepage https://github.com/netglue/prismic-doctype-client
Informations about the package prismic-doctype-client
Prismic Document Type API Client
Introduction
This library provides an API client so that you can read and write your document type definitions using the Prismic Custom Types API.
Currently, you can list, read, insert and update document types, and do the same for 'Shared Slices'
The client requires that you make use of (And similarly, it returns instances of) the shipped Definition
or SharedSlice
value objects.
Typically, you wouldn't interact with the client directly, but as part of a build process that takes care of all that stuff for you. This client is quite fresh, but it's primary use will soon be part of netglue/prismic-cli
, so that it will become trivial to synchronise your local development document definitions with those in your production Prismic repository (and vice-versa).
It's worth noting that document types and slices are not validated in any way. That's up to you, but, you should get descriptive exceptions when your JSON doesn't validate on the remote server.
Installation
The only supported installation method is via composer:
Configuration
The client has been designed to work with whatever PSR-18 HTTP Client and PSR-7 and PSR-17 implementations that you like to use. Once you have got hold of an API token for the custom types API, you can create a client with:
Usage
CRUD for Document Types
CRUD for Shared Slices
Limitations/Roadmap
Authentication
Currently, authentication is only possible with a permanent access token that you create/retrieve from the Prismic repository settings. Session based tokens are not supported.
Contributing
Please feel free to get involved with development. The project uses PHPUnit for tests, Psalm for static analysis and Infection for mutation testing. CI should have your back if you want to submit a feature or fix ;)
License
MIT Licensed.
Changelog
See CHANGELOG.md
.
All versions of prismic-doctype-client with dependencies
ext-json Version *
php-http/discovery Version ^1.14.1
psr/http-client Version ^1.0
psr/http-client-implementation Version *
psr/http-factory Version ^1.0
psr/http-message Version ^1.0 || ^2.0
webmozart/assert Version ^1.10