library json

sgmendez/json

A PHP library for manipulate JSON data

, _(*1)

# Introduction

This PHP library create a wrapper for json_encode and json_decode PHP functions that normalize use across de PHP versions and throw exceptions when encoding or decoding fail., _(*2)

# Requirements

This library require PHP 5.3.3 or higher, _(*3)

# Installation

You can use Composer to use this library in your application., _(*4)

If you don't have Composer yet, download it following the instructions on http://getcomposer.org/ or just run the following command:, _(*5)

curl -s http://getcomposer.org/installer | php

And then execute this command to add libary to your project:, _(*6)

$ composer require sgmendez/json

Or require sgmendez/json into your composer.json file:, _(*7)

json
{
    "require": {
        "sgmendez/json": "*"
    }
}

# Tests

You can run the PHPUnit tests, in directory test execute:, _(*8)

$ php phpunit.phar .

In this directory there are a copy of phpunit.phar for execution test, _(*9)

# Examples

Encode JSON data:, _(*10)

php
use Sgmendez\Json\Json;

$json = new Json();

try
{
    $arrayData = array('foo' => 'Foo', 'bar' => 'Bar');
    $jsonData = $json->encode($arrayData);
} 
catch (Exception $ex) 
{
    echo '[EXCEPTION] MSG: '.$ex->getMessage().' | FILE: '.$ex->getFile().': '.$ex->getLine()."\n";
}

Decode JSON string (by default, return array data):, _(*11)

php
use Sgmendez\Json\Json;

$json = new Json();

try
{
    $jsonData = '{"foo":"Foo","bar":"Bar"}';
    $dataArray = $json->decode($jsonData);
} 
catch (Exception $ex) 
{
    echo '[EXCEPTION] MSG: '.$ex->getMessage() .
         ' | FILE: '.$ex->getFile().': '.$ex->getLine()."\n";
}

Decode JSON file (by default, return array data):, _(*12)

php
use Sgmendez\Json\Json;

$json = new Json();

try
{
    $dataArray = $json->decodeFile('/path/to/file.json');
} 
catch (Exception $ex) 
{
    echo '[EXCEPTION] MSG: '.$ex->getMessage() .
         ' | FILE: '.$ex->getFile().': '.$ex->getLine()."\n";
}

If you need to check if is valid json data, you can to use checkValidJsonData() method., _(*13)

# License

Licensed under the BSD License:, _(*14)

http://opensource.org/licenses/bsd-license.php, _(*15)