Configuration Reference¶

Default Configuration¶

tsantos_serializer:
    debug: "%kernel.debug%"
    format: "json"
    class_path: "%kernel.cache_dir%/tsantos_serializer/classes"
    generate_strategy: "file_not_exists"
    mapping:
        auto_configure: true
        paths: {  }
        cache:
            type: file
            prefix: TSantosSerializer
            path: "%kernel.cache_dir%/tsantos_serializer/metadata"

Configuration Reference¶

debug

Enable or disable some production optimizations.

format

The input and output format of serialization operations (e.g: encoder)

class_path

Directory that will store the generated classes

generate_strategy

Class generation strategy. Can be one of:

never: serializer classes will never be generated (best for production environment, but will require to generate the classes in your continous deployment system).

always: every time a new class will be generated (best for debugging).

file_not_found: serializer classes will be generated only if the class not exists (best for development environment)

mapping.auto_configure

The bundle will try to read the mappings automatically from the directories following the order bellow:

config/serializer - YAML or XML configuration files

src/Entity - Annotations

src/Document - Annotations

src/Model - Annotations

mapping.paths
A list of paths and its namespaces like so:
tsantos_serializer:
    mapping:
        paths:
            - { namespace: "My\\Document", path: "%kernel.project_dir%/config/serializer" }
mapping.cache.type

Type of cache implementation. Should be one of file, psr or doctrine.

mapping.cache.prefix

Prefix of cache keys. Required only for doctrine and psr cache types.

mapping.cache.path

Directory that will stored the metadata cache files. Required only for file cache type.