Skip to content

Commit

Permalink
Fix: moved list support in IsObjectProperty out into separate class
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartherbert committed Jun 12, 2017
1 parent 666e878 commit 118aeae
Show file tree
Hide file tree
Showing 5 changed files with 511 additions and 60 deletions.
1 change: 1 addition & 0 deletions docs/changelog.md
Expand Up @@ -20,6 +20,7 @@
- added `IsClassProperty` helper class
- added `IsListOfClassProperties` helper class
- added `IsObjectProperty` helper class
- added `IsListOfObjectProperties` helper class
* Added support for a formal approach to writing IsXXX() classes
- added `Check` interface
- added `CheckList` base class
Expand Down
92 changes: 92 additions & 0 deletions src/ClassesAndObjects/IsListOfObjectProperties.php
@@ -0,0 +1,92 @@
<?php

/**
* Copyright (c) 2016-present Ganbaro Digital Ltd
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the names of the copyright holders nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category Libraries
* @package MissingBits/ClassesAndObjects
* @author Stuart Herbert <stuherbert@ganbarodigital.com>
* @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @link http://ganbarodigital.github.io/php-the-missing-bits
*/

namespace GanbaroDigital\MissingBits\ClassesAndObjects;

use GanbaroDigital\MissingBits\Checks\CheckList;
use ReflectionProperty;

/**
* is everything in the list an object property?
*/
class IsListOfObjectProperties extends CheckList
{
/**
* our constructor
*
* we do not support any customisations
*/
public function __construct()
{
parent::__construct([new IsObjectProperty]);
}

/**
* fluent-interface entry point
*
* we do not support any customisations
*
* @return IsObjectPropertyList
*/
public static function using()
{
return new static();
}

/**
* is this a list of object properties?
*
* @param mixed $list
* the list to inspect
* @return bool
* TRUE if everything in the list is a ReflectionProperty that
* refers to an object property
* FALSE otherwise
* @throws TypeError
* if $list isn't an acceptable list
*/
public static function check($list)
{
return static::using()->inspect($list);
}
}
32 changes: 12 additions & 20 deletions src/ClassesAndObjects/IsObjectProperty.php
Expand Up @@ -43,18 +43,25 @@

namespace GanbaroDigital\MissingBits\ClassesAndObjects;

use GanbaroDigital\MissingBits\Checks\ListCheckHelper;
use GanbaroDigital\MissingBits\Checks\Check;
use GanbaroDigital\MissingBits\Checks\ListCheck;
use ReflectionProperty;

/**
* is this property an object property?
*/
class IsObjectProperty implements Check, ListCheck
class IsObjectProperty implements Check
{
// saves us having to implement inspectList() ourselves
use ListCheckHelper;
/**
* creates a new IsObjectProperty, ready to use
*
* we do not support any customisations
*
* @return IsObjectProperty
*/
public function using()
{
return new static();
}

/**
* is this property an object property?
Expand Down Expand Up @@ -87,19 +94,4 @@ public function inspect($refProp)
{
return static::check($refProp);
}

/**
* are all the entries in the list object properties?
*
* @param mixed $list
* the list of properties to inspect
* @return bool
* TRUE if every entry in $list is an object property
* FALSE otherwise
*/
public static function checkList($list)
{
$check = new static();
return $check->inspectList($list);
}
}

0 comments on commit 118aeae

Please sign in to comment.