Added function for getting properties (#10)

* Added function for getting properties

* cs

* Updated changelog

* USe PHP 5.3 syntax

* Use master build status

* PHP 5.3 code changes

Author: Nyholm

CHANGELOG.md

@@ -1,7 +1,11 @@
 # Change Log
 
 
-## 1.0.1 - 2016-08-x?
+## 1.1.0 - 2017-04-13
+
+* Added `NSA::getProperties` 
+
+## 1.0.1 - 2016-08-x9
 
 * Using stable version of webmozart/assert
 

README.md

@@ -2,7 +2,7 @@
 
 [![Latest Version](https://img.shields.io/github/release/Nyholm/NSA.svg?style=flat-square)](https://github.com/Nyholm/NSA/releases)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
-[![Build Status](https://img.shields.io/travis/Nyholm/NSA.svg?style=flat-square)](https://travis-ci.org/Nyholm/NSA)
+[![Build Status](https://img.shields.io/travis/Nyholm/NSA/master.svg?style=flat-square)](https://travis-ci.org/Nyholm/NSA)
 [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/Nyholm/NSA.svg?style=flat-square)](https://scrutinizer-ci.com/g/Nyholm/NSA)
 [![Quality Score](https://img.shields.io/scrutinizer/g/Nyholm/NSA.svg?style=flat-square)](https://scrutinizer-ci.com/g/Nyholm/NSA)
 [![Total Downloads](https://img.shields.io/packagist/dt/nyholm/nsa.svg?style=flat-square)](https://packagist.org/packages/nyholm/nsa)

src/NSA.php

@@ -156,4 +156,37 @@ protected static function getAccessibleReflectionProperty($objectOrClass, $prope
 
         return $property;
     }
+
+    /**
+     * Get all property names on a class or object
+     *
+     * @param object|string $objectOrClass
+     *
+     * @return array of strings
+     *
+     * @throws \InvalidArgumentException
+     */
+    public static function getProperties($objectOrClass)
+    {
+        $class = $objectOrClass;
+        if (!is_string($objectOrClass)) {
+            Assert::object($objectOrClass, 'Can not get a property of a non object. Variable of type "%s" was given.');
+            Assert::notInstanceOf($objectOrClass, '\stdClass', 'Can not get a property of \stdClass.');
+            $class = get_class($objectOrClass);
+        }
+
+        $refl = new \ReflectionClass($class);
+        $properties = $refl->getProperties();
+
+        // check parents
+        while (false !== $parent = get_parent_class($class)) {
+            $parentRefl = new \ReflectionClass($parent);
+            $properties = array_merge($properties, $parentRefl->getProperties());
+            $class = $parent;
+        }
+
+        return array_map(function($reflectionProperty) {
+            return $reflectionProperty->name;
+        }, $properties);
+    }
 }

tests/Unit/GetPropertiesTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Nyholm\NSA\tests\Unit;
+
+use Nyholm\NSA;
+use Nyholm\NSA\Tests\Fixture\Dog;
+
+class GetPropertiesTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testIntegerProperty()
+    {
+        NSA::getProperties(1);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testStdClassProperty()
+    {
+        $o = new \stdClass();
+        $o->foo = 'bar';
+
+        NSA::getProperties($o);
+    }
+
+    public function propertyDataProvider()
+    {
+        $dog = new Dog();
+        return array(
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'name'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'owner'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'owner'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'color'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'latinName'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'age'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'birthday'),
+            array('Nyholm\NSA\Tests\Fixture\Dog', 'count'),
+            array($dog, 'name'),
+            array($dog, 'owner'),
+            array($dog, 'owner'),
+            array($dog, 'color'),
+            array($dog, 'latinName'),
+            array($dog, 'age'),
+            array($dog, 'birthday'),
+            array($dog, 'count'),
+        );
+    }
+
+    /**
+     * @dataProvider propertyDataProvider
+     */
+    public function testListProperties($classOrObject, $propertyName)
+    {
+        $result = NSA::getProperties($classOrObject);
+
+        $message = sprintf('Count not find property "%s" in array [%s]', $propertyName, implode(', ', $result));
+        $this->assertTrue(in_array($propertyName, $result), $message);
+    }
+}