serializer/OptionManagerInterface.php at master · 4devs/serializer · GitHub

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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?php

/*
 * This file is part of the 4devs Serialiser package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FDevs\Serializer;

use FDevs\Serializer\Exception\UnsupportedDataTypeException;
use FDevs\Serializer\Mapping\MetadataInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

interface OptionManagerInterface
{
    /**
     * @param MetadataInterface $metadata
     * @param string            $name
     * @param mixed             $value
     * @param array             $context
     *
     * @return bool
     */
    public function isVisibleValue(MetadataInterface $metadata, $name, $value, array $context = []);

    /**
     * @param MetadataInterface $metadata
     * @param string            $name
     * @param array             $context
     *
     * @return bool
     */
    public function isVisibleProperty(MetadataInterface $metadata, $name, array $context = []);

    /**
     * @param MetadataInterface $convert
     * @param string            $name
     * @param array             $context
     *
     * @return string
     */
    public function convertName(MetadataInterface $convert, $name, array $context = []);

    /**
     * @param MetadataInterface $accessor
     * @param object            $object
     * @param array             $context
     *
     * @return mixed
     */
    public function getValue(MetadataInterface $accessor, $object, array $context = []);

    /**
     * @param MetadataInterface $type
     * @param $value
     * @param array                    $context
     * @param NormalizerInterface|null $normalizer
     *
     * @throws UnsupportedDataTypeException
     *
     * @return array|string|bool|int|float|null
     */
    public function normalize(MetadataInterface $type, $value, array $context = [], NormalizerInterface $normalizer = null);

    /**
     * @param MetadataInterface $accessor
     * @param object            $object
     * @param mixed             $data
     * @param array             $context
     */
    public function setValue(MetadataInterface $accessor, $object, $data, array $context = []);

    /**
     * @param MetadataInterface          $accessor
     * @param mixed                      $value
     * @param array                      $context
     * @param DenormalizerInterface|null $denormalizer
     *
     * @throws UnsupportedDataTypeException
     *
     * @return mixed
     */
    public function denormalize(MetadataInterface $accessor, $value, array $context = [], DenormalizerInterface $denormalizer = null);
}