format()
format(string|array $data) : string|boolean
Takes the given data and formats it.
Parameters
| string|array | $data |
Returns
string|boolean —(JSON string | false)
JSON data formatter
<?php
/**
* CodeIgniter
*
* An open source application development framework for PHP
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014-2019 British Columbia Institute of Technology
* Copyright (c) 2019 CodeIgniter Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
* @author CodeIgniter Dev Team
* @copyright 2019 CodeIgniter Foundation
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*/
namespace CodeIgniter\Format;
use CodeIgniter\Format\Exceptions\FormatException;
/**
* JSON data formatter
*/
class JSONFormatter implements FormatterInterface
{
/**
* Takes the given data and formats it.
*
* @param $data
*
* @return string|boolean (JSON string | false)
*/
public function format($data)
{
$options = JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES;
$options = ENVIRONMENT === 'production' ? $options : $options | JSON_PRETTY_PRINT;
$result = json_encode($data, $options, 512);
if (json_last_error() !== JSON_ERROR_NONE)
{
throw FormatException::forInvalidJSON(json_last_error_msg());
}
return $result;
}
//--------------------------------------------------------------------
}