Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.42 KB

README.md

File metadata and controls

85 lines (57 loc) · 3.42 KB
Raw

Ghost IO Unofficial PHP library

CircleCI MadeBy

This library is intended to help developer to use the Ghost.io API with their php code.

Features

  • PSR-4 autoloading compliant structure
  • Unit-Testing with PHPUnit
  • Easy to use library

Installation

We use packagist to serve this library so is easier to include to any of your projects. Make sure you have composer available in your PATH. To do this you can run the following command in the terminal:

composer require weebly/ghost-io-php

For the most recent dev version:

"require": {
  "weebly/ghost-io-php": "master@dev"
},

Install or update your composer dependencies:

composer install

As a final check you could review your vendor library to see if you have a weeblu/ghost-io-php folder created. Now you're ready to use this on you're code.

Usage

use GhostIO\GhostIO;

$ghost = new GhostIO(
	'https://your-blog.ghost.io',	// This is the base url for your blog
	'example@example.com',		// email (username) of the user that will do the API requests
	'password',			// The user password
	'ghost-frontend',		// The client id
	'the-client-secret'		// The client secret
);

$res = $ghost->getAllPosts(); // retrieve all posts from the ghost server

Available Client Methods

The following list shows what methods are available and the route that they represent on the ghost.io API:

Method API service Description 
$ghost->getAllPosts($fields = [])
 /posts Get a collection with all the posts of the blog.Some filters apply. 
$ghost->getPostById($postId)
 /posts:id This will find one specific post by the ID. 
$ghost->getPostBySlug($slug)
 /posts:slug This will find one specific post by the slug. 
$ghost->getAllTags($fields = [])
 /tags Get a collection with all the tags (categories). 
$ghost->getTagById($tagId)
 /tags:id This will find one specific tag by the ID. 
$ghost->getTagBySlug($slug)
 /tags:slug This will find one specific tag by the slug. 
$ghost->getAllUsers($fields = [])
 /users Get a collection with all the users of the blog. Some filters apply. 
$ghost->getUserById($userId)
 /users:id This will find one specific user by the ID. 
$ghost->getUserBySlug($slug)
 /users:slug This will find one specific user by the slug. 
$ghost->getUserByEmail($email)
 /users/email:email This will find one specific user by his email address.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Documentation

For more documentation, check the ghost.io API docs here: GhostIO API Docs.

Enjoy!