gsa/ckan-php-client

A PHP client for the CKAN data catalog, used by https://github.com/GSA/ckan-php-manager

ckan-php-client

Tiny CKAN API client written in PHP

Requirements

• PHP 5.6+ : http://php.net

Installation

The recommended way to install is through composer.

And run these two commands to install it:

$ curl -sS https://getcomposer.org/installer | php -- --install-dir=bin

Create a composer.json file for your project:

{
    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/GSA/ckan-php-client.git"
        }
    ],
    "require": {
        "gsa/ckan-php-client": "0.*"
    },
}

Install dependencies:

$ composer install

Now you can add the autoloader, and you will have access to the library:

<?php
require 'vendor/autoload.php';

Usage

<?php

use CKAN\CkanClient;

$apiUrl = 'http://catalog.data.gov/api/3';          // CKAN API URL
$apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';   // CKAN API KEY, if needed / or null

$Ckan = new CkanClient($apiUrl, $apiKey);

$ckanResults = $Ckan->package_search('organization:irs-gov');
$ckanResults = json_decode($ckanResults, true);

Sample

Check GSA/ckan-php-manager script as an example

CKAN API DOCs

http://docs.ckan.org/en/latest/api/index.html

ckan-php-client's Issues

function timer() undefined

timer() exists, but only as part of GSA/ckan-php-manager

Retrieve organization's datasets when using organization_show

Hello,

I am not sure if this is the correct way to suggest this. When making the request to organization_show endpoint (http://docs.ckan.org/en/latest/api/index.html#ckan.logic.action.get.organization_show) is it also possible to request the datasets from the organization if you send true in the parameter "include_datasets". This is really useful because it is the only way to access the private datasets of an organization.

I already created a forked version with this feature so I could use it, but it would be nice if everybody had access to this feature as well.

/**
     * Returns organization with matching id or name
     *
     * @param string $id (id/name)
     *
     * @return mixed
     * @link http://docs.ckan.org/en/latest/api/index.html#ckan.logic.action.get.organization_show
     */
    public function organization_show($id, $include_datasets)
    {
        $solr_request = [
            'id' => $id,
            'include_datasets' => $include_datasets
        ];
        $data = json_encode($solr_request, JSON_PRETTY_PRINT);

        return $this->make_request(
            'POST',
            'action/organization_show',
            $data
        );
    }

Typo in installation instructions

When setting up ckan-php-client on my project, after creating composer.json file and running:

php composer.phar update

i get:

[Seld\JsonLint\ParsingException] "./composer.json" does not contain valid JSON Parse error on line 10: ...": "dev-dev" },} --------------------^ Expected: 'STRING' - It appears you have an extra trailing comma

After removing the colon i run update again and get:

Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.
Problem 1

• The requested package rei/ckan-php-client could not be found in any version, there may be a typo in the package name.
  Potential causes:
• A typo in the package name
• The package is not available in a stable-enough version according to your minimum-stability setting
  see https://groups.google.com/d/topic/composer-dev/_g3ASeIFlrc/discussion for more details.
  Read http://getcomposer.org/doc/articles/troubleshooting.md for further common problems.

readme.md adjustment

To remove a comma from composer.json:

{
    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/GSA/ckan-php-client.git"
        }
    ],
    "require": {
        "gsa/ckan-php-client": "0.*"
    }
}

to add a slash at $apiUrl:

<?php

use CKAN\CkanClient;

$apiUrl = 'http://catalog.data.gov/api/3/';          // CKAN API URL
$apiKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';   // CKAN API KEY, if needed / or null

$Ckan = new CkanClient($apiUrl, $apiKey);

$ckanResults = $Ckan->package_search('organization:irs-gov');
$ckanResults = json_decode($ckanResults, true);

sintax error in "composer.json"

There is a commma left after the "require" closing bracket.