Add Entities

Author: adrorocker

.gitignore

@@ -1 +1,4 @@
-build
+build
+html
+vendor
+composer.lock

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Alejandro Morelos.
+Copyright (c) 2016 - 2018, Alejandro Morelos.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -45,6 +45,86 @@ $put = $firebase->put('/logs/'.$id, $data);
 $get = $firebase->get('/logs');
 ```
 
+
+## Extras
+
+Now [PHP-Firebase](https://github.com/adrorocker/php-firebase) include a simple way to save and retrieve _Entities_ using repositories.
+
+You can use them like this:
+
+* Create an _entity_ class
+
+```php
+// app/Model/User/User.php
+<?php
+
+namespace App\Model\User;
+
+use PhpFirebase\Entities\Entity;
+
+class User extends Entity
+{
+    protected $id;
+
+    public $firstName;
+
+    public $lastName;
+}
+
+```
+
+* Create a _repository_ class
+
+```php
+// app/Model/User/UserRepository.php
+<?php
+
+namespace App\Model\User;
+
+use PhpFirebase\Entities\Repository\Repository;
+
+class UserRepository extends Repository
+{
+    public function __construct()
+    {
+        // Base endpoint
+        $base = 'https://hey-123.firebaseio.com/somesubendpoint';
+        // Auth token
+        $token = 'a1b2c3d4e5f6g7h8i9';
+
+        $this->class = User::class;
+
+        parent::__construct($base, $token, '/users');
+    }
+}
+
+```
+
+* Usage
+
+```php
+require '../vendor/autoload.php';
+
+$repo =  new UserRepository();
+// Create user
+$user = new User([
+    'id' => 1,
+    'firstName' => 'Adro',
+    'lastName' => 'Rocker',
+]);
+$user = $repo->store($user); // $user will be an instance of App\Model\User
+
+// Update user
+// You can get or assign values to an entity property using a method named as the property name.
+$user->lastName('Rocks'); // setting $lastName to be 'Rocks'.
+$lastName = $user->lastName(); // getting $lastName, $lastName has the value 'Rocks'.
+$user = $repo->store($user);
+
+// Find user
+$user = $repo->find(1); // $user will be an instance of App\Model\User
+
+```
+
 ## Authors:
 
 [Alejandro Morelos](https://github.com/adrorocker). 

composer.json

@@ -8,7 +8,7 @@
     "authors": [
         {
             "name": "Adro Rocker",
-            "email": "alejandro.morelos@jarwebdev.com",
+            "email": "me@adro.rocks",
             "homepage": "https://github.com/adrorocker"
         }
     ],
@@ -21,9 +21,10 @@
     },
     "autoload": {
         "psr-4": {
-            "PhpFirebase\\": ["src/","tests/"]
+            "PhpFirebase\\": ["src/", "extra/", "tests/"]
         },
         "files": [
+            "extra/Entities/functions.php"
         ]
     },
     "extra": {

extra/Entities/Bridge.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * PHP-Firebase
+ *
+ * @link      https://github.com/adrorocker/php-firebase
+ * @copyright Copyright (c) 2018 Adro Rocker
+ * @author    Adro Rocker <mes@adro.rocks>
+ */
+namespace PhpFirebase\Entities;
+
+use ReflectionObject;
+use ReflectionProperty;
+
+class Bridge
+{
+    /**
+     * @var object
+     */
+    protected $object;
+
+    /**
+     * @var array
+     */
+    protected $properties = [];
+
+
+    /**
+     * Make non-public members of the given object accessible
+     *
+     * @param object $object.- Object which members we'll make accessible
+     */
+    public function __construct($object)
+    {
+        $this->object = $object;
+        $reflected = new ReflectionObject($this->object);
+        $this->properties = array();
+
+        $properties = $reflected->getProperties(
+            ReflectionProperty::IS_PROTECTED | ReflectionProperty::IS_PRIVATE | ReflectionProperty::IS_PUBLIC
+        );
+
+        foreach ($properties as $property) {
+            $property->setAccessible(true);
+            $this->properties[$property->getName()] = $property;
+        }
+    }
+
+    public function getProperties()
+    {
+        return $this->properties;
+    }
+
+    /**
+     * Returns a property of $this->object
+     *
+     * @param string $name
+     *
+     * @return mixed
+     */
+    public function __get($name)
+    {
+        // If the property is exposed (with reflection) then we use getValue()
+        // to access it, else we access it directly
+        if (isset($this->properties[$name])) {
+            return $this->properties[$name]->getValue($this->object);
+        }
+
+        return null;
+    }
+}

extra/Entities/Call.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * PHP-Firebase
+ *
+ * @link      https://github.com/adrorocker/php-firebase
+ * @copyright Copyright (c) 2018 Adro Rocker
+ * @author    Adro Rocker <mes@adro.rocks>
+ */
+namespace PhpFirebase\Entities;
+
+use BadMethodCallException;
+use ReflectionClass;
+use ReflectionProperty;
+
+trait Call
+{
+    /**
+     * Get or Set property
+     *
+     * @param string $name Name of the method
+     * @param array $arguments Arguments
+     *
+     * @throws BadMethodCallException If the $name is not a property
+     */
+    public function __call($name, $arguments)
+    {
+        if (true !== property_exists($this, $name)) {
+            throw new BadMethodCallException(sprintf(
+                'The metod "%s" does not exist',
+                $name
+            ));
+        }
+        if ($arguments && count($arguments) == 1) {
+            $reflect = new ReflectionClass($this);
+            $props   = $reflect->getProperties(ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED);
+            foreach ($props as $prop) {
+                if ($prop->getName()  == $name) {
+                    $this->{$name} = $arguments[0];
+                }
+            }
+        }
+
+        return $this->{$name};
+    }
+}

extra/Entities/Entity.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * PHP-Firebase
+ *
+ * @link      https://github.com/adrorocker/php-firebase
+ * @copyright Copyright (c) 2018 Adro Rocker
+ * @author    Adro Rocker <mes@adro.rocks>
+ */
+namespace PhpFirebase\Entities;
+
+use ReflectionObject;
+use ReflectionProperty;
+
+class Entity implements EntityInterface
+{
+    use Call;
+
+    public function __construct(array $properties)
+    {
+        $this->fill($properties);
+    }
+
+    public function toArray()
+    {
+        $bridge = new Bridge($this);
+        $array = [];
+        foreach ($bridge->getProperties() as $key => $value) {
+            $array[$key] = $this->$key;
+        }
+
+        return json_decode(json_encode($array), true);
+    }
+
+    public function toJson()
+    {
+        return json_encode($this->toArray());
+    }
+
+    public static function fromJson($json)
+    {
+        $array = json_decode($json, true);
+        $class = get_called_class();
+
+        return new $class($array);
+    }
+
+    protected function fill(array $properties)
+    {
+        foreach ($properties as $key => $value) {
+            if (true == property_exists($this, $key)) {
+                $this->$key = $value;
+            }
+        }
+    }
+}

extra/Entities/EntityInterface.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * PHP-Firebase
+ *
+ * @link      https://github.com/adrorocker/php-firebase
+ * @copyright Copyright (c) 2018 Adro Rocker
+ * @author    Adro Rocker <mes@adro.rocks>
+ */
+namespace PhpFirebase\Entities;
+
+interface EntityInterface
+{
+    public function toArray();
+
+    public function toJson();
+
+    public static function fromJson($string);
+}