fuelphp / common

src/Format.php

<?php
/**
 * @package    Fuel\Common
 * @version    2.0
 * @author     Fuel Development Team
 * @license    MIT License
 * @copyright  2010 - 2015 Fuel Development Team
 * @link       http://fuelphp.com
 */

namespace Fuel\Common;

/**
 * Help convert between various formats such as XML, JSON, CSV, etc.
 *
 * @package Fuel\Common
 *
 * @since 1.0
 */
class Format
{
	/**
	 * @var  array|mixed  Input data to convert
	 */
	protected $data = array();

	/**
	 * @var  array|mixed  Configuration for this Format instance
	 */
	protected $config = array();

	/**
	 * @var  bool 	whether to ignore namespaces when parsing xml
	 */
	protected $xmlIgnoreNamespaces = true;

	/**
	 * @var  Fuel\Common\Datacontainer  Input Container
	 */
	protected $input;

	/**
	 * @var  Fuel\Common\Inflector  Inflector object
	 */
	protected $inflector;

	/**
	 * @param  mixed $data  Input data to format or convert
	 * @param  mixed $from_type  The data type of the input data
	 *
	 * @throws InvalidArgumentException if the from_type isn't a known type
	 */
	public function __construct($data = null, $from_type = null, Array $config = array(), $input = null, $inflector = null)
	{
		// If the provided data is already formatted we should probably convert it to an array
		if ($from_type !== null)
		{
			if ($from_type == 'xml:ns')
			{
				$this->xmlIgnoreNamespaces = false;
				$from_type = 'xml';
			}

			if (method_exists($this, $method = '_from'.ucfirst($from_type)))
			{
				$data = call_user_func(array($this, $method), $data);
			}
			else
			{
				throw new \InvalidArgumentException('Format class does not support conversion from "' . $from_type . '".');
			}
		}

		// store the passed data and config
		$this->data = $data;
		$this->config = $config;

		// store the injected objects
		$this->input = $input;
		$this->inflector = $inflector;
	}

	// FORMATING OUTPUT ---------------------------------------------------------

	/**
	 * To array conversion
	 *
	 * Goes through the input and makes sure everything is either a scalar value or array
	 *
	 * @param   mixed  $data
	 * @return  array
	 */
	public function toArray($data = null)
	{
		if ($data === null)
		{
			$data = $this->data;
		}

		$array = array();

		if (is_object($data) and ! $data instanceof \Iterator)
		{
			$data = get_object_vars($data);
		}

		if (empty($data))
		{
			return array();
		}

		foreach ($data as $key => $value)

The expression $data of type integer|double|string|array|boolean|resource|object<Iterator> is not guaranteed to be traversable. How about adding an additional type check?

		{
			if (is_object($value) or is_array($value))
			{
				$array[$key] = $this->toArray($value);
			}
			else
			{
				$array[$key] = $value;
			}
		}

		return $array;
	}

	/**
	 * To XML conversion
	 *
	 * @param   mixed        $data
	 * @param   null         $structure
	 * @param   null|string  $basenode
	 * @param   null|bool    whether to use CDATA in nodes
	 * @return  string
	 */
	public function toXml($data = null, $structure = null, $basenode = null, $usecdata = null)
	{
		if ($data === null)
		{
			$data = $this->data;
		}

		if ($basenode === null)
		{
			$basenode = Arr::get($this->config, 'xml.basenode', 'xml');
		}

		if ($usecdata === null)
		{
			$usecdata = Arr::get($this->config, 'xml.usecdata', false);

false is of type boolean, but the function expects a string|null.

		}

		if ($structure === null)
		{
			$structure = simplexml_load_string("<?xml version='1.0' encoding='utf-8'?><$basenode />");
		}

		// Force it to be something useful
		if ( ! is_array($data) and ! is_object($data))
		{
			$data = (array) $data;
		}

		foreach ($data as $key => $value)
		{
			// replace anything not alpha numeric
			$key = preg_replace('/[^a-z_\-0-9]/i', '', $key);

			// no numeric keys in our xml please!
			if (is_numeric($key))
			{
				// make string key...
				$key = ($this->inflector->singularize($basenode) != $basenode) ? $this->inflector->singularize($basenode) : 'item';
			}

			// if there is another array found recrusively call this function
			if (is_array($value) or is_object($value))
			{
				$node = $structure->addChild($key);

It seems like $structure is not always an object, but can also be of type null. Maybe add an additional type check?

				// recursive call if value is not empty
				if( ! empty($value))
				{
					$this->toXml($value, $node, $key, $usecdata);
				}
			}

			else
			{
				// add single node.
				$encoded = htmlspecialchars(html_entity_decode($value, ENT_QUOTES, 'UTF-8'), ENT_QUOTES, 'UTF-8');

				if ($usecdata and ($encoded !== (string) $value))
				{
					$dom = dom_import_simplexml($structure->addChild($key));
					$owner = $dom->ownerDocument;
					$dom->appendChild($owner->createCDATASection($value));
				}
				else
				{
					$structure->addChild($key, $encoded);
				}
			}
		}

		// pass back as string. or simple xml object if you want!
		return $structure->asXML();
	}

	/**
	 * To CSV conversion
	 *
	 * @param   mixed   $data
	 * @param   mixed   $delimiter
	 * @return  string
	 */
	public function toCsv($data = null, $delimiter = null)
	{
		// csv format settings
		$newline = Arr::get($this->config, 'csv.newline', "\n");
		$delimiter or $delimiter = Arr::get($this->config, 'csv.delimiter', ',');
		$enclosure = Arr::get($this->config, 'csv.enclosure', '"');
		$escape = Arr::get($this->config, 'csv.escape', '\\');

		// escape function
		$escaper = function($items) use($enclosure, $escape) {
			return array_map(function($item) use($enclosure, $escape){
				return str_replace($enclosure, $escape.$enclosure, $item);
			}, $items);
		};

		if ($data === null)
		{
			$data = $this->data;
		}

		if (is_object($data) and ! $data instanceof \Iterator)
		{
			$data = $this->toArray($data);
		}

		// Multi-dimensional array
		if (is_array($data) and Arr::isMulti($data))
		{
			$data = array_values($data);

			if (Arr::isAssoc($data[0]))
			{
				$headings = array_keys($data[0]);
			}
			else
			{
				$headings = array_shift($data);
			}
		}
		// Single array
		else
		{
			$headings = array_keys((array) $data);
			$data = array($data);
		}

		$output = $enclosure.implode($enclosure.$delimiter.$enclosure, $escaper($headings)).$enclosure.$newline;

		foreach ($data as $row)
		{
			$output .= $enclosure.implode($enclosure.$delimiter.$enclosure, $escaper((array) $row)).$enclosure.$newline;
		}

		return rtrim($output, $newline);
	}

	/**
	 * To JSON conversion
	 *
	 * @param   mixed  $data
	 * @param   bool   wether to make the json pretty
	 * @return  string
	 */
	public function toJson($data = null, $pretty = false)
	{
		if ($data === null)
		{
			$data = $this->data;
		}

		// To allow exporting ArrayAccess objects like Orm\Model instances they need to be
		// converted to an array first
		$data = (is_array($data) or is_object($data)) ? $this->toArray($data) : $data;

		// Return the result in the requested format
		if ($pretty)
		{
			return $this->prettyJson($data);
		}
		else
		{
			$result = json_encode($data, Arr::get($this->config, 'json.encode.options', JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP));
			return json_last_error() === JSON_ERROR_NONE ? $result : false;
		}
	}

	/**
	 * To JSONP conversion
	 *
	 * @param   mixed   $data
	 * @param   bool    $pretty    wether to make the json pretty
	 * @param   string  $callback  JSONP callback
	 * @return  string  formatted JSONP
	 */
	public function toJsonp($data = null, $pretty = false, $callback = null)
	{
		if ( ! $callback and $this->input)
		{
			$callback = $this->input->getParam('callback');
			if ( ! $callback)
			{
				$callback = 'response';
			}
		}

		return $callback.'('.(string) $this->toJson($data, $pretty).')';
	}

	/**
	 * Serialize
	 *
	 * @param   mixed  $data
	 * @return  string
	 */
	public function toSerialized($data = null)
	{
		if ($data === null)
		{
			$data = $this->data;
		}

		return serialize($data);
	}

	/**
	 * Return as a string representing the PHP structure
	 *
	 * @param   mixed  $data
	 * @return  string
	 */
	public function toPhp($data = null)
	{
		if ($data === null)
		{
			$data = $this->data;
		}

		return var_export($data, true);
	}

	/**
	 * Convert to YAML
	 *
	 * @param   mixed   $data
	 * @throws RuntimeException if the Symfony/YAML composer package is not installed
	 * @return  string
	 */
	public function toYaml($data = null)
	{
		if ($data == null)
		{
			$data = $this->data;
		}

		if ( ! class_exists('Symfony\Component\Yaml\Yaml'))
		{
			// @codeCoverageIgnoreStart
			throw new \RuntimeException('You need to install the "symfony/yaml" composer package to use Format::toYaml()');
			// @codeCoverageIgnoreEnd
		}

		$parser = new \Symfony\Component\Yaml\Yaml();
		return $parser::dump($data);
	}

	/**
	 * Import XML data
	 *
	 * @param   string  $string
	 * @return  array
	 */
	protected function _fromXml($string, $recursive = false)
	{
		// If it forged with 'xml:ns'
		if ( ! $this->xmlIgnoreNamespaces)
		{
			static $escape_keys = array();

			if ( ! $recursive)
			{
				$escape_keys = array('_xmlns' => 'xmlns');
			}

			if ( ! $recursive and strpos($string, 'xmlns') !== false and preg_match_all('/(\<.+?\>)/s', $string, $matches))
			{
				foreach ($matches[1] as $tag)
				{
					$escaped_tag = $tag;

$escaped_tag is not used, you could remove the assignment.

					strpos($tag, 'xmlns=') !== false and $escaped_tag = str_replace('xmlns=', '_xmlns=', $tag);

					if (preg_match_all('/[\s\<\/]([^\/\s\'"]*?:\S*?)[=\/\>\s]/s', $escaped_tag, $xmlns))
					{
						foreach ($xmlns[1] as $ns)
						{
							$escaped = Arr::search($escape_keys, $ns);
							$escaped or $escape_keys[$escaped = str_replace(':', '_', $ns)] = $ns;
							$string = str_replace($tag, $escaped_tag = str_replace($ns, $escaped, $escaped_tag), $string);
							$tag = $escaped_tag;
						}
					}
				}
			}
		}

		$_arr = is_string($string) ? simplexml_load_string($string, 'SimpleXMLElement', LIBXML_NOCDATA) : $string;
		$arr = array();

		// Convert all objects SimpleXMLElement to array recursively
		foreach ((array)$_arr as $key => $val)
		{
			if ( ! $this->xmlIgnoreNamespaces)
			{
				$key = Arr::get($escape_keys, $key, $key);

The variable $escape_keys does not seem to be defined for all execution paths leading up to this point.

			}
			$arr[$key] = (is_array($val) or is_object($val)) ? $this->_fromXml($val, true) : $val;

$val is of type array|object, but the function expects a string.

		}

		return $arr;
	}

	/**
	 * Import YAML data
	 *
	 * @param   string  $string

There is no parameter named $string. Was it maybe removed?

	 * @return  array
	 */
	protected function _fromYaml($data)
	{
		if ( ! class_exists('Symfony\Component\Yaml\Yaml'))
		{
			// @codeCoverageIgnoreStart
			throw new \RuntimeException('You need to install the "symfony/yaml" composer package to use Format::fromYaml()');
			// @codeCoverageIgnoreEnd
		}

		$parser = new \Symfony\Component\Yaml\Yaml();
		return $parser::parse($data);
	}

	/**
	 * Import CSV data
	 *
	 * @param   string  $string
	 * @return  array
	 */
	protected function _fromCsv($string)
	{
		$data = array();

		$rows = preg_split('/(?<='.preg_quote(Arr::get($this->config, 'csv.enclosure', '"')).')'.Arr::get($this->config, 'csv.regex_newline', '\n').'/', trim($string));

		// csv config
		$delimiter = Arr::get($this->config, 'csv.delimiter', ',');
		$enclosure = Arr::get($this->config, 'csv.enclosure', '"');
		$escape = Arr::get($this->config, 'csv.escape', '\\');

		// Get the headings
		$headings = str_replace($escape.$enclosure, $enclosure, str_getcsv(array_shift($rows), $delimiter, $enclosure, $escape));

		foreach ($rows as $row)
		{
			$data_fields = str_replace($escape.$enclosure, $enclosure, str_getcsv($row, $delimiter, $enclosure, $escape));

			if (count($data_fields) == count($headings))
			{
				$data[] = array_combine($headings, $data_fields);
			}

		}

		return $data;
	}

	/**
	 * Import JSON data
	 *
	 * @param   string  $string
	 * @return  mixed
	 */
	private function _fromJson($string)
	{
		return json_decode(trim($string));
	}

	/**
	 * Import Serialized data
	 *
	 * @param   string  $string
	 * @return  mixed
	 */
	private function _fromSerialized($string)
	{
		return unserialize(trim($string));
	}

	/**
	 * Makes json pretty the json output.
	 * Borrowed from http://www.php.net/manual/en/function.json-encode.php#80339
	 *
	 * @param   string  $json  json encoded array

There is no parameter named $json. Was it maybe removed?

	 * @return  string|false  pretty json output or false when the input was not valid
	 */
	protected function prettyJson($data)
	{
		$json = json_encode($data, Arr::get($this->config, 'json.encode.options', JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP));

		if (json_last_error() !== JSON_ERROR_NONE)
		{
			return false;
		}

		$tab = "\t";
		$newline = "\n";
		$new_json = "";
		$indent_level = 0;
		$in_string = false;
		$len = strlen($json);

		for ($c = 0; $c < $len; $c++)
		{
			$char = $json[$c];
			switch($char)
			{
				case '{':
				case '[':

This code seems to be duplicated across your project.

					if ( ! $in_string)
					{
						$new_json .= $char.$newline.str_repeat($tab, $indent_level+1);
						$indent_level++;
					}
					else
					{
						$new_json .= $char;
					}
					break;
				case '}':
				case ']':

This code seems to be duplicated across your project.

					if ( ! $in_string)
					{
						$indent_level--;
						$new_json .= $newline.str_repeat($tab, $indent_level).$char;
					}
					else
					{
						$new_json .= $char;
					}
					break;
				case ',':

This code seems to be duplicated across your project.

					if ( ! $in_string)
					{
						$new_json .= ','.$newline.str_repeat($tab, $indent_level);
					}
					else
					{
						$new_json .= $char;
					}
					break;
				case ':':
					if ( ! $in_string)
					{
						$new_json .= ': ';
					}
					else
					{
						$new_json .= $char;
					}
					break;
				case '"':
					if ($c > 0 and $json[$c-1] !== '\\')
					{
						$in_string = ! $in_string;
					}
				default:
					$new_json .= $char;
					break;
			}
		}

		return $new_json;
	}
}