locomotivemtl / charcoal-ui / 147

pending completion

Build # 147

Build Type

push

travis-ci

Committed by

mcaskill

Commit Message

<a href="https://github.com/locomotivemtl/charcoal-ui/commit/<a class=hub.com/locomotivemtl/charcoal-ui/commit/<a class="double-link" href="https://git"><a class=hub.com/locomotivemtl/charcoal-ui/commit/<a class="double-link" href="https://git"><a class=hub.com/locomotivemtl/charcoal-ui/commit/<a class="double-link" href="https://git"><a class=hub.com/locomotivemtl/charcoal-ui/commit/<a class="double-link" href="https://git"><a class=hub.com/locomotivemtl/charcoal-ui/commit/<a class="double-link" href="https://git"><a class=hub.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3">4c21a16b3">&lt;a href=&quot;https://github.com/locomotivemtl/charcoal-ui/commit/</a><a class="double-link" href="https://github.com/locomotivemtl/charcoal-ui/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/locomotivemtl/charcoal-ui/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/locomotivemtl/charcoal-ui/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/locomotivemtl/charcoal-ui/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3">4c21a16b3</a><a href="https://github.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3">&lt;a href=&quot;https://github.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/locomotivemtl/charcoal-ui/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/locomotivemtl/charcoal-ui/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3&amp;quot;&amp;gt;4c21a16b3&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/locomotivemtl/charcoal-ui/commit/4c21a16b32e4077903b5357dc3dbc69ad0d0c1c3&amp;amp;quot;&amp;amp;gt;&amp;amp;amp;quot;&amp;amp;amp;gt;Fix unit tests requir&amp;lt;/a&amp;</a>gt;ing View service

Amends: &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https... (continued)

Run Details

44 of 44 new or added lines in 10 files covered. (100.0%)

1556 of 2518 relevant lines covered (61.8%)

16.96 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

55.32

/src/Charcoal/Ui/MenuItem/AbstractMenuItem.php

<?php

namespace Charcoal\Ui\MenuItem;

use InvalidArgumentException;

// From 'charcoal-ui'
use Charcoal\Ui\AbstractUiItem;
use Charcoal\Ui\Menu\MenuInterface;
use Charcoal\Ui\MenuItem\MenuItemInterface;

/**
 * A Basic Menu Item
 *
 * Abstract implementation of {@see \Charcoal\Ui\MenuItem\MenuItemInterface}.
 */
abstract class AbstractMenuItem extends AbstractUiItem implements MenuItemInterface
{
    /**
     * Parent menu item
     * @var MenuInterface $menu
     */
    private $menu;

    /**
     * @var string $ident
     */
    protected $ident;

    /**
     * @var \Charcoal\Translator\Translation|null $label
     */
    protected $label;

    /**
     * @var string $url
     */
    protected $url;

    /**
     * @var MenuItemInterface[] $children
     */
    protected $children = [];

    /**
     * @var callable $childCallback
     */
    private $childCallback;

    /**
     * Return a new menu item.
     *
     * @param array|\ArrayAccess $data Class dependencies.
     */
    public function __construct($data)
    {
        parent::__construct($data);

        if (isset($data['menu'])) {
            $this->setMenu($data['menu']);
        }

        $this->setMenuItemBuilder($data['menu_item_builder']);

        /** Satisfies {@see \Charcoal\View\ViewableInterface} */
        $this->setView($data['view']);
    }

    /**
     * Set the parent (menu) object.
     *
     * @param MenuInterface $menu The parent menu object.
     * @return MenuItemInterface Chainable
     */
    protected function setMenu(MenuInterface $menu)
    {
        $this->menu = $menu;
        return $this;
    }

    /**
     * @param MenuItemBuilder $menuItemBuilder The Menu Item Builder that will be used to create new items.
     * @return MenuItemInterface Chainable
     */
    public function setMenuItemBuilder(MenuItemBuilder $menuItemBuilder)
    {
        $this->menuItemBuilder = $menuItemBuilder;
        return $this;
    }

    /**
     * @param callable $cb The item callback.
     * @return MenuItemInterface Chainable
     */
    public function setItemCallback(callable $cb)
    {
        $this->childCallback = $cb;
        return $this;
    }

    /**
     * @param string $ident The menu item identifier.
     * @throws InvalidArgumentException If the identifier argument is not a string.
     * @return MenuItem Chainable
     */
    public function setIdent($ident)
    {
        if (!is_string($ident)) {
            throw new InvalidArgumentException(
                'Menu item identifier must a string'
            );
        }
        $this->ident = $ident;
        return $this;
    }

    /**
     * @return string
     */
    public function ident()
    {
        return $this->ident;
    }

    /**
     * @param mixed $label The menu item label.
     * @return MenuItem Chainable
     */
    public function setLabel($label)
    {
        $this->label = $this->translator()->translation($label);
        return $this;
    }

    /**
     * @return string
     */
    public function label()
    {
        return $this->label;
    }

    /**
     * @param string $url The menu item URL.
     * @return MenuItem Chainable
     */
    public function setUrl($url)
    {
        $this->url = $url;
        return $this;
    }

    /**
     * @return string
     */
    public function url()
    {
        return $this->url;
    }

    /**
     * @return boolean
     */
    public function hasUrl()
    {
        return !!($this->url());
    }

    /**
     * @param array $children The menu item children items structure.
     * @return MenuItem Chainable
     */
    public function setChildren(array $children)
    {
        $this->children = [];
        foreach ($children as $c) {
            $this->addChild($c);
        }
        return $this;
    }

    /**
     * @param array|MenuItem $child The child menu structure or object.
     * @throws InvalidArgumentException If the child is not a menu object or structure.
     * @return MenuItem Chainable
     */
    public function addChild($child)
    {
        if (is_array($child)) {
            $child['menu'] = $this->menu;
            $c = $this->menuItemBuilder->build($child);
            $this->children[] = $c;
        } elseif ($child instanceof MenuItemInterface) {
            $this->children[] = $child;
        } else {
            throw new InvalidArgumentException(
                'Child must be an array or a MenuItem object'
            );
        }
        return $this;
    }

    /**
     * Children (menu item) generator
     *
     * @param callable $childCallback Optional callback.
     * @return MenuItemInterface[]
     */
    public function children(callable $childCallback = null)
    {
        $children = $this->children;
        uasort($children, ['self', 'sortChildrenByPrioriy']);

        $childCallback = isset($childCallback) ? $childCallback : $this->childCallback;
        foreach ($children as $child) {
            if ($childCallback) {
                $childCallback($child);
            }
            $this->setDynamicTemplate('widget_template', $item->template());
            yield $child->ident() => $child;
        }
    }

    /**
     * @return boolean
     */
    public function hasChildren()
    {
        return (count($this->children) > 0);
    }

    /**
     * @return integer
     */
    public function numChildren()
    {
        return count($this->children);
    }
}

1	<?php
2
3	namespace Charcoal\Ui\MenuItem;
4
5	use InvalidArgumentException;
6
7	// From 'charcoal-ui'
8	use Charcoal\Ui\AbstractUiItem;
9	use Charcoal\Ui\Menu\MenuInterface;
10	use Charcoal\Ui\MenuItem\MenuItemInterface;
11
12	/**
13	* A Basic Menu Item
14	*
15	* Abstract implementation of {@see \Charcoal\Ui\MenuItem\MenuItemInterface}.
16	*/
17	abstract class AbstractMenuItem extends AbstractUiItem implements MenuItemInterface
18	{
19	/**
20	* Parent menu item
21	* @var MenuInterface $menu
22	*/
23	private $menu;
24
25	/**
26	* @var string $ident
27	*/
28	protected $ident;
29
30	/**
31	* @var \Charcoal\Translator\Translation\|null $label
32	*/
33	protected $label;
34
35	/**
36	* @var string $url
37	*/
38	protected $url;
39
40	/**
41	* @var MenuItemInterface[] $children
42	*/
43	protected $children = [];
44
45	/**
46	* @var callable $childCallback
47	*/
48	private $childCallback;
49
50	/**
51	* Return a new menu item.
52	*
53	* @param array\|\ArrayAccess $data Class dependencies.
54	*/
55	public function __construct($data)
56	{
57	parent::__construct($data);	32✔
58
59	if (isset($data['menu'])) {	32✔
60	$this->setMenu($data['menu']);	12✔
61	}	3✔
62
63	$this->setMenuItemBuilder($data['menu_item_builder']);	32✔
64
65	/** Satisfies {@see \Charcoal\View\ViewableInterface} */
66	$this->setView($data['view']);	32✔
67	}	32✔
68
69	/**
70	* Set the parent (menu) object.
71	*
72	* @param MenuInterface $menu The parent menu object.
73	* @return MenuItemInterface Chainable
74	*/
75	protected function setMenu(MenuInterface $menu)
76	{
77	$this->menu = $menu;	32✔
78	return $this;	32✔
79	}
80
81	/**
82	* @param MenuItemBuilder $menuItemBuilder The Menu Item Builder that will be used to create new items.
83	* @return MenuItemInterface Chainable
84	*/
85	public function setMenuItemBuilder(MenuItemBuilder $menuItemBuilder)
86	{
87	$this->menuItemBuilder = $menuItemBuilder;	32✔
88	return $this;	32✔
89	}
90
91	/**
92	* @param callable $cb The item callback.
93	* @return MenuItemInterface Chainable
94	*/
95	public function setItemCallback(callable $cb)
96	{
97	$this->childCallback = $cb;	×
98	return $this;	×
99	}
100
101	/**
102	* @param string $ident The menu item identifier.
103	* @throws InvalidArgumentException If the identifier argument is not a string.
104	* @return MenuItem Chainable
105	*/
106	public function setIdent($ident)
107	{
108	if (!is_string($ident)) {	20✔
109	throw new InvalidArgumentException(	×
110	'Menu item identifier must a string'
111	);
112	}
113	$this->ident = $ident;	20✔
114	return $this;	20✔
115	}
116
117	/**
118	* @return string
119	*/
120	public function ident()
121	{
122	return $this->ident;	12✔
123	}
124
125	/**
126	* @param mixed $label The menu item label.
127	* @return MenuItem Chainable
128	*/
129	public function setLabel($label)
130	{
131	$this->label = $this->translator()->translation($label);	×
132	return $this;	×
133	}
134
135	/**
136	* @return string
137	*/
138	public function label()
139	{
140	return $this->label;	×
141	}
142
143	/**
144	* @param string $url The menu item URL.
145	* @return MenuItem Chainable
146	*/
147	public function setUrl($url)
148	{
149	$this->url = $url;	×
150	return $this;	×
151	}
152
153	/**
154	* @return string
155	*/
156	public function url()
157	{
158	return $this->url;	×
159	}
160
161	/**
162	* @return boolean
163	*/
164	public function hasUrl()
165	{
166	return !!($this->url());	×
167	}
168
169	/**
170	* @param array $children The menu item children items structure.
171	* @return MenuItem Chainable
172	*/
173	public function setChildren(array $children)
174	{
175	$this->children = [];	8✔
176	foreach ($children as $c) {	8✔
177	$this->addChild($c);	8✔
178	}	2✔
179	return $this;	8✔
180	}
181
182	/**
183	* @param array\|MenuItem $child The child menu structure or object.
184	* @throws InvalidArgumentException If the child is not a menu object or structure.
185	* @return MenuItem Chainable
186	*/
187	public function addChild($child)
188	{
189	if (is_array($child)) {	8✔
190	$child['menu'] = $this->menu;	8✔
191	$c = $this->menuItemBuilder->build($child);	8✔
192	$this->children[] = $c;	8✔
193	} elseif ($child instanceof MenuItemInterface) {	2✔
194	$this->children[] = $child;	×
195	} else {
196	throw new InvalidArgumentException(	×
197	'Child must be an array or a MenuItem object'
198	);
199	}
200	return $this;	8✔
201	}
202
203	/**
204	* Children (menu item) generator
205	*
206	* @param callable $childCallback Optional callback.
207	* @return MenuItemInterface[]
208	*/
209	public function children(callable $childCallback = null)
210	{
211	$children = $this->children;	×
212	uasort($children, ['self', 'sortChildrenByPrioriy']);	×
213
214	$childCallback = isset($childCallback) ? $childCallback : $this->childCallback;	×
215	foreach ($children as $child) {	×
216	if ($childCallback) {	×
217	$childCallback($child);	×
218	}
219	$this->setDynamicTemplate('widget_template', $item->template());	×
220	yield $child->ident() => $child;	×
221	}
222	}	×
223
224	/**
225	* @return boolean
226	*/
227	public function hasChildren()
228	{
229	return (count($this->children) > 0);	4✔
230	}
231
232	/**
233	* @return integer
234	*/
235	public function numChildren()
236	{
237	return count($this->children);	4✔
238	}
239	}

locomotivemtl / charcoal-ui / 147

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous