https://github.com/pointybeard/helpers-functions-json

A collection of functions for working with JSON files and strings
https://github.com/pointybeard/helpers-functions-json

Last synced: 9 days ago
JSON representation

A collection of functions for working with JSON files and strings

• Host: GitHub
• URL: https://github.com/pointybeard/helpers-functions-json
• Owner: pointybeard
• License: other
• Created: 2019-06-08T11:22:03.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-08T11:22:29.000Z (over 5 years ago)
• Last Synced: 2024-10-12T06:21:06.780Z (about 1 month ago)
• Language: PHP
• Size: 3.91 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# PHP Helpers: JSON Functions

-   Version: v1.0.0

-   Date: June 08 2019

-   [Release notes](https://github.com/pointybeard/helpers-functions-json/blob/master/CHANGELOG.md)

-   [GitHub repository](https://github.com/pointybeard/helpers-functions-json)

A collection of functions for working with JSON files and strings

## Installation

This library is installed via [Composer](http://getcomposer.org/). To install, use `composer require pointybeard/helpers-functions-json` or add `"pointybeard/helpers-functions-json": "~1.0.0"` to your `composer.json` file.

And run composer to update your dependencies:

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

    $ php composer.phar update

### Requirements

This library makes use of the [PHP Helpers: Flags Functions](https://github.com/pointybeard/helpers-functions-falgs) (`pointybeard/helpers-functions-flags`). It is installed automatically via composer.

To include all the [PHP Helpers](https://github.com/pointybeard/helpers) packages on your project, use `composer require pointybeard/helpers`.

## Usage

This library is a collection convenience function for common tasks relating to working with JSON strings and documents. They are included by the vendor autoloader automatically. The functions have a namespace of `pointybeard\Helpers\Functions\Json`

The following functions are provided:

-   `json_validate`

-   `json_validate_file`

-   `json_decode_file`

Example usage:

```php

//   class stdClass#3 (1) {

//     public $name =>

//     string(11) "Sarah Smith"

//   }

// }

/* Example 5: Validate file containing invalid JSON **/

file_put_contents($tmp, '{"person": {"name": {"name": "Broken JSON}');

$isValid = Json\json_validate_file($tmp, $code, $message);

var_dump($isValid, $code, $message);

// bool(false)

// int(3)

// string(53) "Control character error, possibly incorrectly encoded"

/* Example 6: Attempt to decode file containing invalid JSON **/

try {

    var_dump(Json\json_decode_file($tmp));

} catch (JsonException $ex) {

    echo $ex->getMessage().PHP_EOL;

}

// Control character error, possibly incorrectly encoded

/** Example 7: Attempt to validate non-existent JSON file **/

$isValid = Json\json_validate_file('nonexistent/file.json', $code, $message);

var_dump($isValid, $code, $message);

// bool(false)

// NULL

// string(42) "File nonexistent/file.json is not readable"

/* Example 8: Attempt to decode non-existent JSON file **/

Json\json_decode_file('nonexistent/file.json');

// Fatal error: Uncaught JsonException: The file nonexistent/file.json is not readable in /path/to/helpers-functions-json/src/Json/Json.php on line 82

```

## Support

If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/pointybeard/helpers-functions-json/issues),

or better yet, fork the library and submit a pull request.

## Contributing

We encourage you to contribute to this project. Please check out the [Contributing documentation](https://github.com/pointybeard/helpers-functions-json/blob/master/CONTRIBUTING.md) for guidelines about how to get involved.

## License

"PHP Helpers: JSON Functions" is released under the [MIT License](http://www.opensource.org/licenses/MIT).