Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Transformers;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Exceptions\TransformatorException;
use Maslosoft\Mangan\Interfaces\Transformators\TransformatorInterface;
use Symfony\Component\Yaml\Yaml;
/**
* YamlString
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class YamlString implements TransformatorInterface
{
/**
* Returns the given object as an associative array
* @param AnnotatedInterface|object $model
* @param string[] $fields Fields to transform
*
* @param int $inline The level where you switch to inline YAML
* @param int $indent The amount of spaces to use for indentation of nested nodes.
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @return array an associative array of the contents of this object
*/
public static function fromModel(AnnotatedInterface $model, $fields = [], $inline = 2, $indent = 4, $exceptionOnInvalidType = false)
{
return Yaml::dump(YamlArray::fromModel($model, $fields), $inline, $indent, $exceptionOnInvalidType);
}
/**
* Create document from array
*
* @param mixed[] $data
* @param string|object $className
* @param AnnotatedInterface $instance
*
* @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise
*
* @return AnnotatedInterface
* @throws TransformatorException
*/
public static function toModel($data, $className = null, AnnotatedInterface $instance = null, $exceptionOnInvalidType = false)
{
return YamlArray::toModel(Yaml::parse($data, $exceptionOnInvalidType), $className, $instance);
}
}
API documentation generated by ApiGen