prismic/php-sdk

PHP development kit for prismic.io

Installs: 41 186

Dependents: 5

Suggesters: 0

Stars: 52

Watchers: 21

Forks: 30

Open Issues: 7


README

alt text Code Climate Test Coverage

Getting started

Install the kit for your project

First of all, install apc to have the default build-in cache support.

Install with Composer:

$ composer require prismic/php-sdk
New projects

The recommended way to get started is with a sample project:

Usage

Include the dependency:

<?php

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

use Prismic\Api;

Then call the API:

<?php
$api = Api::get("https://your-repo.name.prismic.io/api");
$doc = $api->getByUID("get-started");

The kit is compatible and tested with PHP 5.4 and above.

More information

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.

Tests are run by running the command phpunit.

Some of the kit's tests check stuff that are built on top of APC and need APC to work from the command line. If you've installed and enabled APC, and your cache tests don't pass:

  • check if your APC is enabled for your command line, by running php -i | grep apc; if no output is displayed, then maybe the APC extension you installed and enabled is only enabled in apache but not for your command line. Check how your OS works to make that happen, and if it involves changing a php.ini file, make sure it's the right php.ini (you might have one for apache, and one for the command line)
  • if APC is enabled for the command line, and yet the tests still fail, make sure your apc.enable_cli (which you see in the output of php -i | grep apc) is 'On'. If it's not, add this at the end of your php.ini: apc.enable_cli = 1. Make sure it's the right php.ini (you might have one for apache, and one for the command line)
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.

For documentation admins: documentation is generated by running the command:

$ ./vendor/phpdocumentor/phpdocumentor/bin/phpdoc

License

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.