1. class
  2. NoreSources
  3. \
  4. Data
  5. \
  6. Serialization
  7. \
  8. YamlSerializer

YamlSerializer

class YamlSerializer implements DataUnserializerInterface, DataSerializerInterface, DataFileSerializerInterface, DataFileUnerializerInterface (View source)

YAML content and file (de)serialization.

Require the yaml extension

Traits

MediaTypeListTrait
DataFileSerializerTrait
DataFileUnserializerTrait
DataFileUnserializer base on DataUnserializer implementation
DataFileExtensionTrait
DataFileMediaTypeNormalizerTrait

Methods

buildMediaTypeList()

No description

getMediaTypes()

No description

from MediaTypeListTrait
matchMediaType(MediaTypeInterface $mediaType)

No description

getSerializableFileMediaTypes()

No description

from DataFileSerializerTrait
canSerializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

No description

from DataFileSerializerTrait
serializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

No description

from DataFileSerializerTrait
getMediaTypeFactoryFlags()

No description

from DataFileMediaTypeNormalizerTrait
getUnserializableFileMediaTypes()

No description

from DataFileUnserializerTrait
boolean
canUnserializeFromFile(string $filename, MediaTypeInterface $mediaType = null)

Indicates if the given file can be unserialized

unserializeFromFile($filename, MediaTypeInterface $mediaType = null)

No description

from DataFileUnserializerTrait
setFileExtensions($array = array())

No description

from DataFileExtensionTrait
matchExtension($filename)

No description

from DataFileExtensionTrait
__construct()

No description

static 
prerequisites()

No description

MediaTypeInterface[]
getSerializableDataMediaTypes()

Get the list of content type supported by the serializer interface.

boolean
canSerializeData(mixed $data, MediaTypeInterface $mediaType = null)

Indicate if the given data can be unserialized to the given media type

MediaTypeInterface[]
getUnserializableDataMediaTypes()

No description

mixed
unserializeData(string $data, MediaTypeInterface $mediaType = null)

No description

string
serializeData(mixed $data, MediaTypeInterface $mediaType = null)

Serialize data to a given media type

TRUE
canUnserializeData(mixed $data, MediaTypeInterface $mediaType = null)

No description

Details

at line 137
protected buildMediaTypeList()

in MediaTypeListTrait at line 21
protected getMediaTypes()

at line 124
protected matchMediaType(MediaTypeInterface $mediaType)

Parameters

MediaTypeInterface $mediaType

in DataFileSerializerTrait at line 18
getSerializableFileMediaTypes()

in DataFileSerializerTrait at line 23
canSerializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

Parameters

$filename
$data
MediaTypeInterface $mediaType

in DataFileSerializerTrait at line 37
serializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

Parameters

$filename
$data
MediaTypeInterface $mediaType

in DataFileMediaTypeNormalizerTrait at line 44
protected getMediaTypeFactoryFlags()

in DataFileUnserializerTrait at line 27
getUnserializableFileMediaTypes()

at line 67
boolean canUnserializeFromFile(string $filename, MediaTypeInterface $mediaType = null)

Indicates if the given file can be unserialized

Since their is no reliable method to gen the correct media type of a YAML file, only the file extension is checked.

Parameters

string $filename Input file path
MediaTypeInterface $mediaType File content type

Return Value

boolean TRUE if instance can unserialize file type

in DataFileUnserializerTrait at line 64
unserializeFromFile($filename, MediaTypeInterface $mediaType = null)

Parameters

$filename
MediaTypeInterface $mediaType

in DataFileExtensionTrait at line 14
protected setFileExtensions($array = array())

Parameters

$array

in DataFileExtensionTrait at line 19
protected matchExtension($filename)

Parameters

$filename

at line 34
__construct()

at line 42
static prerequisites()

at line 47
MediaTypeInterface[] getSerializableDataMediaTypes()

Get the list of content type supported by the serializer interface.

Return Value

MediaTypeInterface[]

at line 52
boolean canSerializeData(mixed $data, MediaTypeInterface $mediaType = null)

Indicate if the given data can be unserialized to the given media type

Parameters

mixed $data Data to serialize
MediaTypeInterface $mediaType Data output format

Return Value

boolean TRUE if the instance can serialize $data to $mediaType format

at line 89
MediaTypeInterface[] getUnserializableDataMediaTypes()

Return Value

MediaTypeInterface[]

at line 94
mixed unserializeData(string $data, MediaTypeInterface $mediaType = null)

Parameters

string $data
MediaTypeInterface $mediaType Serialized content type

Return Value

mixed

at line 100
string serializeData(mixed $data, MediaTypeInterface $mediaType = null)

Serialize data to a given media type

Parameters

mixed $data Data to serialize
MediaTypeInterface $mediaType Serialization content type

Return Value

string

at line 114
TRUE canUnserializeData(mixed $data, MediaTypeInterface $mediaType = null)

Parameters

mixed $data Data
MediaTypeInterface $mediaType Data media type

Return Value

TRUE if instance support de-serialization of $mediaType content