CollectionMapper::getOptions()

Completed

Branch — master (7a03a0)

by Karsten

created 2017-05-18 19:57 UTC

↳ Parent: CollectionMapper

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0

<?php
/**
 * File was created 11.05.2016 10:13
 */

namespace PeekAndPoke\Component\Slumber\Core\Codec\Property;

use PeekAndPoke\Component\Slumber\Annotation\Slumber\AsCollection;
use PeekAndPoke\Component\Slumber\Core\Codec\Mapper;

/**
 * @author Karsten J. Gerber <[email protected]>
 */
interface CollectionMapper extends Mapper
{
    /**
     * @return AsCollection
     */
    public function getOptions();

    /**
     * @return Mapper
     */
    public function getNested();

    /**
     * @param Mapper $nested
     *
     * @return $this
     */
    public function setNested(Mapper $nested);

    /**
     * Traverse multiple nested Collection mappers, find the leave and check its type.
     *
     * @param string $class
     *
     * @return bool
     */
    public function isLeaveOfType($class);

    /**
     * Traverse multiple nested Collection mappers, and find the leave.
     *
     * @return Mapper
     */
    public function getLeaf();

    /**
     * Traverse multiple nested Collection mappers, and replace the leave.
     *
     * @param Mapper $leave
     */
    public function setLeaf(Mapper $leave);

    /**
     * @return null|CollectionMapper
     */
    public function getLeafParent();

    /**
     * @param string $collectionClass
     *
     * @return $this
     */
    public function setLeafParentsCollectionType($collectionClass);

    /**
     * Get the nesting level.
     *
     * If there is no nested element the level is 0.
     * If there is a nested element the level is 1.
     * If there is a nested element with a nested element as well the level 2.
     *
     * ... and so forth
     *
     * @return int
     */
    public function getNestingLevel();
}


1			<?php
2			/**
3			* File was created 11.05.2016 10:13
4			*/
5
6			namespace PeekAndPoke\Component\Slumber\Core\Codec\Property;
7
8			use PeekAndPoke\Component\Slumber\Annotation\Slumber\AsCollection;
9			use PeekAndPoke\Component\Slumber\Core\Codec\Mapper;
10
11			/**
12			* @author Karsten J. Gerber <[email protected]>
13			*/
14			interface CollectionMapper extends Mapper
15			{
16			/**
17			* @return AsCollection
18			*/
19			public function getOptions();
20
21			/**
22			* @return Mapper
23			*/
24			public function getNested();
25
26			/**
27			* @param Mapper $nested
28			*
29			* @return $this
30			*/
31			public function setNested(Mapper $nested);
32
33			/**
34			* Traverse multiple nested Collection mappers, find the leave and check its type.
35			*
36			* @param string $class
37			*
38			* @return bool
39			*/
40			public function isLeaveOfType($class);
41
42			/**
43			* Traverse multiple nested Collection mappers, and find the leave.
44			*
45			* @return Mapper
46			*/
47			public function getLeaf();
48
49			/**
50			* Traverse multiple nested Collection mappers, and replace the leave.
51			*
52			* @param Mapper $leave
53			*/
54			public function setLeaf(Mapper $leave);
55
56			/**
57			* @return null\|CollectionMapper
58			*/
59			public function getLeafParent();
60
61			/**
62			* @param string $collectionClass
63			*
64			* @return $this
65			*/
66			public function setLeafParentsCollectionType($collectionClass);
67
68			/**
69			* Get the nesting level.
70			*
71			* If there is no nested element the level is 0.
72			* If there is a nested element the level is 1.
73			* If there is a nested element with a nested element as well the level 2.
74			*
75			* ... and so forth
76			*
77			* @return int
78			*/
79			public function getNestingLevel();
80			}
81

PeekAndPoke / slumber

Branch — master (7a03a0)

CollectionMapper::getOptions()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like