locomotivemtl / charcoal-core / 454

pending completion

Build # 454

Build Type

push

travis-ci

Committed by

mcaskill

Commit Message

<a href="https://github.com/locomotivemtl/charcoal-core/commit/d78e8da31">Camelize property retrieval by identifier

Amends: </a><a class="double-link" href="https://github.com/locomotivemtl/charcoal-core/commit/a7d0a2ec6">a7d0a2ec6</a>

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

3422 of 4740 relevant lines covered (72.19%)

21.93 hits per line

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

58.82

/src/Charcoal/Model/AbstractMetadata.php

<?php

namespace Charcoal\Model;

// From 'charcoal-config'
use Charcoal\Config\AbstractConfig;

// From 'charcoal-property'
use Charcoal\Property\PropertyInterface;

// From 'charcoal-core'
use Charcoal\Model\MetadataInterface;

/**
 * A basic metadata container.
 *
 * Abstract implementation of {@see \Charcoal\Model\MetadataInterface}.
 *
 * This class also implements the `ArrayAccess`, so properties can be accessed with `[]`.
 * The `LoadableInterface` is also implemented, mostly through `LoadableTrait`.
 */
abstract class AbstractMetadata extends AbstractConfig implements
    MetadataInterface
{
    /**
     * Holds the default values of this configuration object.
     *
     * @var array
     */
    protected $defaultData = [];

    /**
     * Holds the properties of this configuration object.
     *
     * @var array
     */
    protected $properties = [];

    /**
     * Stores the properties, as objects, of this configuration object.
     *
     * @var PropertyInterface[]
     */
    protected $propertiesObjects;

    /**
     * Set the object's default values.
     *
     * @param array $defaultData An associative array.
     * @return self
     */
    public function setDefaultData(array $defaultData)
    {
        $this->defaultData = $defaultData;
        return $this;
    }

    /**
     * Retrieve the default values.
     *
     * @return array
     */
    public function defaultData()
    {
        return $this->defaultData;
    }

    /**
     * Set the properties. Ensure the property idents (keys) are camel-cased.
     *
     * @param array $properties One or more properties.
     * @return self
     */
    public function setProperties(array $properties)
    {
        $this->properties = [];
        foreach ($properties as $k => $v) {
            $this->properties[$this->camelize($k)] = $v;
        }
        return $this;
    }

    /**
     * Retrieve the properties.
     *
     * @return array
     */
    public function properties()
    {
        return $this->properties;
    }

    /**
     * Retrieve the given property.
     *
     * @param string $propertyIdent The property identifier.
     * @return array|null
     */
    public function property($propertyIdent = null)
    {
        $propertyIdent = $this->camelize($propertyIdent);
        if (isset($this->properties[$propertyIdent])) {
            return $this->properties[$propertyIdent];
        } else {
            return null;
        }
    }

    /**
     * Assign an instance of {@see PropertyInterface} to the given property.
     *
     * @param string            $propertyIdent  The property indentifer.
     * @param PropertyInterface $propertyObject The property, as an object.
     * @return self
     */
    public function setPropertyObject($propertyIdent, PropertyInterface $propertyObject)
    {
        $this->propertiesObjects[$propertyIdent] = $propertyObject;
        return $this;
    }

    /**
     * Retrieve the given property as an object.
     *
     * @param string $propertyIdent The property (identifier) to return, as an object.
     * @return PropertyInterface|null
     */
    public function propertyObject($propertyIdent)
    {
        if (!isset($this->propertiesObjects[$propertyIdent])) {
            return null;
        } else {
            return $this->propertiesObjects[$propertyIdent];
        }
    }
}

1	<?php
2
3	namespace Charcoal\Model;
4
5	// From 'charcoal-config'
6	use Charcoal\Config\AbstractConfig;
7
8	// From 'charcoal-property'
9	use Charcoal\Property\PropertyInterface;
10
11	// From 'charcoal-core'
12	use Charcoal\Model\MetadataInterface;
13
14	/**
15	* A basic metadata container.
16	*
17	* Abstract implementation of {@see \Charcoal\Model\MetadataInterface}.
18	*
19	* This class also implements the `ArrayAccess`, so properties can be accessed with `[]`.
20	* The `LoadableInterface` is also implemented, mostly through `LoadableTrait`.
21	*/
22	abstract class AbstractMetadata extends AbstractConfig implements
23	MetadataInterface
24	{
25	/**
26	* Holds the default values of this configuration object.
27	*
28	* @var array
29	*/
30	protected $defaultData = [];
31
32	/**
33	* Holds the properties of this configuration object.
34	*
35	* @var array
36	*/
37	protected $properties = [];
38
39	/**
40	* Stores the properties, as objects, of this configuration object.
41	*
42	* @var PropertyInterface[]
43	*/
44	protected $propertiesObjects;
45
46	/**
47	* Set the object's default values.
48	*
49	* @param array $defaultData An associative array.
50	* @return self
51	*/
52	public function setDefaultData(array $defaultData)
53	{
54	$this->defaultData = $defaultData;	×
55	return $this;	×
56	}
57
58	/**
59	* Retrieve the default values.
60	*
61	* @return array
62	*/
63	public function defaultData()
64	{
65	return $this->defaultData;	×
66	}
67
68	/**
69	* Set the properties. Ensure the property idents (keys) are camel-cased.
70	*
71	* @param array $properties One or more properties.
72	* @return self
73	*/
74	public function setProperties(array $properties)
75	{
76	$this->properties = [];	64✔
77	foreach ($properties as $k => $v) {	64✔
78	$this->properties[$this->camelize($k)] = $v;	60✔
79	}	16✔
80	return $this;	64✔
81	}
82
83	/**
84	* Retrieve the properties.
85	*
86	* @return array
87	*/
88	public function properties()
89	{
90	return $this->properties;	64✔
91	}
92
93	/**
94	* Retrieve the given property.
95	*
96	* @param string $propertyIdent The property identifier.
97	* @return array\|null
98	*/
99	public function property($propertyIdent = null)
100	{
101	$propertyIdent = $this->camelize($propertyIdent);	×
102	if (isset($this->properties[$propertyIdent])) {	×
103	return $this->properties[$propertyIdent];	×
104	} else {
105	return null;	×
106	}
107	}
108
109	/**
110	* Assign an instance of {@see PropertyInterface} to the given property.
111	*
112	* @param string $propertyIdent The property indentifer.
113	* @param PropertyInterface $propertyObject The property, as an object.
114	* @return self
115	*/
116	public function setPropertyObject($propertyIdent, PropertyInterface $propertyObject)
117	{
118	$this->propertiesObjects[$propertyIdent] = $propertyObject;	60✔
119	return $this;	60✔
120	}
121
122	/**
123	* Retrieve the given property as an object.
124	*
125	* @param string $propertyIdent The property (identifier) to return, as an object.
126	* @return PropertyInterface\|null
127	*/
128	public function propertyObject($propertyIdent)
129	{
130	if (!isset($this->propertiesObjects[$propertyIdent])) {	60✔
131	return null;	60✔
132	} else {
133	return $this->propertiesObjects[$propertyIdent];	36✔
134	}
135	}
136	}

locomotivemtl / charcoal-core / 454

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