first commit

Author: a-afsharfarnia

.gitignore

@@ -0,0 +1,4 @@
+/vendor/
+.idea/
+/composer.lock
+/phpunit.xml

README.md

@@ -0,0 +1,14 @@
+# A Simple Method to Make a Data Mapper in PHP
+In most projects, we have to map data to other cases. For example we want to map `1m` to `1 minute` or `3d` to `3 days`.
+
+This package is a data mapper and we can create our mapper based on that very easily.
+
+## Install
+ ```
+  $ composer require a-afsharfarnia/data-mapper
+ ```
+
+### How to use 
+You can find samples of using this package in `/src/samples`. You can have a look on `TimeMapper` and `LanguageMapper` classes.
+
+In fact, in your project, for each map data, you must create a class which is extended of `Afsharfarnia\DataMapper\mappers\Mapper` of this package. Then in each class you must define a `$mapper` static property which includes its mapper data. 

composer.json

@@ -0,0 +1,32 @@
+{
+    "name": "a-afsharfarnia/data-mapper",
+    "type": "helper",
+    "description": "This is a package to make a simple data mapper",
+    "keywords": ["a-afsharfarnia", "data-mapper", "data mapper", "map-data", "map data"],
+    "homepage": "https://github.com/a-afsharfarnia/php-data-mapper",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Abbas Afsharfarnia",
+            "email": "[email protected]",
+            "homepage": "http://afsharfarnia.com",
+            "role": "Senior Backend Developer"
+        }
+    ],
+    "require": {
+        "php": "7.2.*"
+    },
+    "require-dev": {
+        "phpunit/phpunit" : ">=7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Afsharfarnia\\DataMapper\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Afsharfarnia\\DataMapper\\tests\\": "tests/"
+        }
+    }
+}

src/mappers/Mapper.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Project_Name: Data Mapper in PHP
+ * package_Name: a-afsharfarnia/data-mapper
+ * Created_By: Abbas Afsharfarnia (07/10/2019 10:06)
+ * Project_Address: https://github.com/a-afsharfarnia/php-data-mapper
+ */
+
+namespace Afsharfarnia\DataMapper\mappers;
+
+/**
+ * Abstract Class Mapper
+ * Description: Define mapData and unmapData methods
+ */
+abstract class Mapper implements MapperInterface
+{
+    /**
+     * use this method to map data
+     *
+     * @param $data
+     * @return mixed
+     */
+    public static function mapData($data) {
+        $mapper = get_called_class()::$mapper;
+
+        if(array_key_exists($data, $mapper)) {
+            $mapData = $mapper[$data];
+            return $mapData;
+        }
+
+        return "Data not found in mapping list";
+    }
+
+    /**
+     * use this method to unmap data
+     *
+     * @param $data
+     * @return mixed
+     */
+    public static function unmapData($data) {
+        $mapper = get_called_class()::$mapper;
+
+        $unmapData = array_search ($data, $mapper);
+
+        if(!empty($unmapData)) {
+            return $unmapData;
+        }
+
+        return "Data not found in mapping list";
+    }
+}

src/mappers/MapperInterface.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Project_Name: Data Mapper in PHP
+ * package_Name: a-afsharfarnia/data-mapper
+ * Created_By: Abbas Afsharfarnia (07/10/2019 10:06)
+ * Project_Address: https://github.com/a-afsharfarnia/php-data-mapper
+ */
+
+namespace Afsharfarnia\DataMapper\mappers;
+
+/**
+ * Interface MapperInterface
+ * Description: Interface for Mapper abstract class
+ */
+interface MapperInterface
+{
+    /**
+     * use this method to map data
+     *
+     * @param $data
+     * @return mixed
+     */
+    public static function mapData($data);
+
+    /**
+     * use this method to unmap data
+     *
+     * @param $data
+     * @return mixed
+     */
+    public static function unmapData($data);
+}

src/samples/LanguageMapper.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Project_Name: Data Mapper in PHP
+ * package_Name: a-afsharfarnia/data-mapper
+ * Created_By: Abbas Afsharfarnia (07/10/2019 10:06)
+ * Project_Address: https://github.com/a-afsharfarnia/php-data-mapper
+ */
+
+namespace Afsharfarnia\DataMapper\samples;
+
+use Afsharfarnia\DataMapper\mappers\Mapper;
+
+/**
+ * Class LanguageMapper
+ * Description: a sample of a mapper class
+ */
+class LanguageMapper extends Mapper
+{
+    /** @var array $mapper */
+    public static $mapper = [
+        "en" => "English",
+        "de" => "German",
+        "fr" => "French",
+        "ar" => "Arabic",
+    ];
+}

src/samples/TimeMapper.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Project_Name: Data Mapper in PHP
+ * package_Name: a-afsharfarnia/data-mapper
+ * Created_By: Abbas Afsharfarnia (07/10/2019 10:06)
+ * Project_Address: https://github.com/a-afsharfarnia/php-data-mapper
+ */
+
+namespace Afsharfarnia\DataMapper\samples;
+
+use Afsharfarnia\DataMapper\mappers\Mapper;
+
+/**
+ * Class TimeMapper
+ * Description: a sample of a mapper class
+ */
+class TimeMapper extends Mapper
+{
+    /** @var array $mapper */
+    public static $mapper = [
+        "1m" => "1minute",
+        "3m" => "3minutes",
+        "5m" => "5minutes",
+        "15m" => "15minutes",
+        "30m" => "30minutes",
+        "1h" => "1hour",
+        "2h" => "2hours",
+        "4h" => "4hours",
+        "6h" => "6hours",
+        "8h" => "8hours",
+        "12h" => "12hours",
+        "1d" => "1day",
+        "3d" => "3days",
+        "1w" => "1week",
+        "1M" => "1month"
+    ];
+}

src/samples/UseSample.php

@@ -0,0 +1,14 @@
+<?php
+/**
+ * Project_Name: Data Mapper in PHP
+ * package_Name: a-afsharfarnia/data-mapper
+ * Created_By: Abbas Afsharfarnia (07/10/2019 10:06)
+ * Project_Address: https://github.com/a-afsharfarnia/php-data-mapper
+ */
+
+use Afsharfarnia\DataMapper\samples\LanguageMapper;
+use Afsharfarnia\DataMapper\samples\TimeMapper;
+
+echo TimeMapper::mapData("1m");
+echo "-----------";
+echo LanguageMapper::unmapData("German");

tests/TimeMapperTest.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Project_Name: Data Mapper in PHP
+ * package_Name: a-afsharfarnia/data-mapper
+ * Created_By: Abbas Afsharfarnia (07/10/2019 10:06)
+ * Project_Address: https://github.com/a-afsharfarnia/php-data-mapper
+ */
+
+namespace Afsharfarnia\DataMapper\tests;
+
+use PHPUnit\Framework\TestCase;
+use Afsharfarnia\DataMapper\samples\LanguageMapper;
+use Afsharfarnia\DataMapper\samples\TimeMapper;
+
+/**
+ * Class TimeMapperTest
+ * Description: a test class for testing the whole package
+ */
+class TimeMapperTest extends TestCase
+{
+    /**
+     * @dataProvider timeMapperDataProvider
+     * @param $data
+     * @param $expectResult
+     */
+    public function testTimeMapper($data, $expectResult) {
+        $time = TimeMapper::mapData($data);
+        $this->assertEquals($expectResult, $time);
+    }
+
+    /**
+     * @dataProvider languageMapperDataProvider
+     * @param $data
+     * @param $expectResult
+     */
+    public function testLanguageMapper($data, $expectResult) {
+        $time = LanguageMapper::unmapData($data);
+        $this->assertEquals($expectResult, $time);
+    }
+
+    /**
+     * @return array
+     */
+    public function timeMapperDataProvider()
+    {
+        return array(
+            array('1m', '1minute'),
+            array('30m', '30minutes'),
+            array('12h', '12hours')
+        );
+    }
+
+    /**
+     * @return array
+     */
+    public function languageMapperDataProvider()
+    {
+        return array(
+            array('German', 'de'),
+            array('French', 'fr'),
+            array('English', 'en')
+        );
+    }
+}