ludofleury / php-kit

Development kit for the PHP language

PHP development kit for prismic.io

Getting started

Install the kit for your project

The best way to install the library is with the composer package manager (install it if you haven't yet)

Then run this from your project's root in order to add the dependency:

composer require prismic/php-sdk

If asked for a version, type in 'dev-master' (unless you want another version):

Please provide a version constraint for the prismic/php-sdk requirement: dev-master

Usage in your PHP code:

<?php

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

use Prismic\Api;

Get started with prismic.io

You can find out how to get started with prismic.io on our prismic.io developer's portal.

Get started using the kit

Also on our prismic.io developer's portal, on top of our full documentation, you will:

• get a thorough introduction of how to use prismic.io kits, including this one.
• see what else is available for PHP: starter projects, examples, ...

Kit's detailed documentation

You can find the documentation of the PHP kit as comments within the kit's source code. (Feel free to talk to us about generated docs for PHP.)

Thanks to PHP's syntax, this kit contains some mild differences and syntastic sugar over the section of our documentation that tells you how to use prismic.io kits in general (which you should read first). The differences are listed here: *

(Feel free to contribute differences you find.)

Changelog

Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.

Contribute to the kit

Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.

Install the kit locally

Clone this GitHub repository, then install Composer if you haven't, and run:

composer install

Test

Please write tests for any bugfix or new feature.

If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Documentation

Please document any bugfix or new feature.

If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Licence

This software is licensed under the Apache 2 license, quoted below.

Copyright 2013 Zengularity (http://www.zengularity.com).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project 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.