1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Iterator;
38
39/**
40 * Class \Hoa\Iterator\Multiple.
41 *
42 * Extending the SPL MultipleIterator class.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47class Multiple extends \MultipleIterator
48{
49    /**
50     * Default value for each $infos.
51     *
52     * @var array
53     */
54    protected $_infos = [];
55
56
57
58    /**
59     * Attach iterator informations.
60     * Add the $default argument that will be use when the iterator has reached
61     * its end.
62     *
63     * @param   \Iterator  $iterator    Iterator.
64     * @param   string     $infos       Informations to attach.
65     * @param   mixed      $default     Default value.
66     * @return  void
67     */
68    public function attachIterator(
69        \Iterator $iterator,
70        $infos   = null,
71        $default = null
72    ) {
73        $out = parent::attachIterator($iterator, $infos);
74
75        if (null === $infos) {
76            $this->_infos[]       = $default;
77        } else {
78            $this->_infos[$infos] = $default;
79        }
80
81        return $out;
82    }
83
84    /**
85     * Get the registered iterator instances.
86     *
87     * @return  array
88     */
89    public function current()
90    {
91        $out = parent::current();
92
93        foreach ($out as $key => &$value) {
94            if (null === $value) {
95                $value = $this->_infos[$key];
96            }
97        }
98
99        return $out;
100    }
101}
102