refactor: ♻️ PSR 4 Standard

uttamukkoji · uttamukkoji · commit 1e145e6f6620 · 2021-03-22T12:50:25.000+05:30
diff --git a/composer.json b/composer.json
@@ -27,7 +27,11 @@
     "require-dev": {
         "phpunit/phpunit": "^9.0",
         "phpunit/php-code-coverage": "^8.0",
-        "sami/sami": "^4.1"
+        "code-lts/doctum": "^5.3"
+    },
+    "scripts": {
+        "generate:docs": "vendor/bin/doctum.php update ./config.php",
+        "test": "vendor/bin/phpunit"
     },
     "require": {
         "php" : ">=5.5.0"
diff --git a/config.php b/config.php
@@ -1,4 +1,4 @@
 <?php
 
-return new Sami\Sami('/Users/uttamukkoji/Documents/php/contentstack-php/src');
+return new Doctum\Doctum('./src');
 
diff --git a/src/Config/index.php b/src/Config/index.php
diff --git a/src/Contentstack.php b/src/Contentstack.php
@@ -16,8 +16,6 @@
 
 use Contentstack\Stack\Stack;
 
-require_once __DIR__ . '/lib/models/stack.php';
-
 /**
  *  Contentstack abstract class to provide access to Stack Object
  * 
@@ -37,15 +35,15 @@ abstract class Contentstack
      * @param string             $api_key      : Contentstack Stack API KEY.
      * @param string             $access_token : Contentstack Stack ACCESS TOKEN.
      * @param string             $environment  : Environment Name.
-     * @param ContentstackRegion $region       : Region name of Contentstack.
+     * @param array              $config       : Stack Configuration to provide region.
      * 
      * @return Stack
      * */
     public static function Stack($api_key = '',
         $access_token = '',
         $environment = '',
-        $region = ''
+        $config = array('region'=> '')
     ) {
-        return new Stack($api_key, $access_token, $environment, $region);
+        return new Stack($api_key, $access_token, $environment, $config);
     }
 }
diff --git a/src/ContentstackRegion.php b/src/ContentstackRegion.php
diff --git a/src/Error/CSException.php b/src/Error/CSException.php
diff --git a/src/Stack/Assets.php b/src/Stack/Assets.php
@@ -14,20 +14,14 @@
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
-namespace Contentstack\Stack\Assets;
+namespace Contentstack\Stack;
 
-require_once __DIR__ . "/../../Support/helper.php";
+require_once __DIR__ . "/../Support/helper.php";
 
-use Contentstack\Stack\ContentType\Query\Query;
-use Contentstack\Stack\ContentType\BaseQuery\BaseQuery;
+use Contentstack\Stack\ContentType\Query;
+use Contentstack\Stack\BaseQuery;
 use Contentstack\Support\Utility;
 
-
-require_once __DIR__.'/query.php';
-require_once __DIR__."/base_query.php";
-require_once __DIR__."/../../Support/Utility.php";
-
-
 /**
  * Assets refer to all the media files (images, videos, PDFs, 
  * audio files, and so on) uploaded in your Contentstack 
diff --git a/src/Stack/BaseQuery.php b/src/Stack/BaseQuery.php
@@ -14,11 +14,11 @@
  * @link      https://pear.php.net/package/contentstack
  * */
 
-namespace Contentstack\Stack\ContentType\BaseQuery;
+namespace Contentstack\Stack;
 use Contentstack\Support\Utility;
 
-require_once __DIR__ . "/../../Support/helper.php";
-require_once __DIR__."/../../Support/Utility.php";
+require_once __DIR__ . "/../Support/helper.php";
+
 /**
  * BaseQuery
  * Base Class where all the Queries will be created
@@ -128,7 +128,7 @@ public function only($level = 'BASE', $field_uids = array())
      * */
     public function includeReference($field_uids = array()) 
     {
-        if (is_array($field_uids)) {
+        if ($field_uids && is_array($field_uids)) {
             $this->queryObject->_query = call_user_func(
                 'contentstackReferences', 
                 'include', 
@@ -465,7 +465,7 @@ public function skip($skip = 0)
      * */
     public function tags($tags = array()) 
     {
-        if (is_array($tags)) {
+        if ($tags && is_array($tags)) {
             $this->queryObject->_query = call_user_func(
                 'contentstackTags', 
                 'tags', 
@@ -508,7 +508,7 @@ public function limit($limit = '')
      * */
     public function containedIn($field = '', $value = array()) 
     {
-        if (is_array($value)) {
+        if ($value && is_array($value)) {
             $this->subQuery = call_user_func(
                 'contentstackContains', 
                 '$in', 
@@ -533,7 +533,7 @@ public function containedIn($field = '', $value = array())
      * */
     public function notContainedIn($field = '', $value = array()) 
     {
-        if (is_array($value)) {
+        if ($value && is_array($value)) {
             $this->subQuery = call_user_func(
                 'contentstackContains', 
                 '$nin',
@@ -675,8 +675,8 @@ public function notEqualTo($field = '', $value = '')
      * */
     public function addQuery($_query = array()) 
     {
-        if (is_array($_query)) {
-            $this->subQuery = $_query;
+        if ($_query && is_array($_query)) {
+            $this->subQuery = json_encode($_query);
             return $this->queryObject;
         }
         throw contentstackCreateError("Provide valid query");
diff --git a/src/Stack/ContentType.php b/src/Stack/ContentType.php
@@ -15,15 +15,11 @@
  * @link      https://pear.php.net/package/contentstack
  * */
 
-namespace Contentstack\Stack\ContentType;
+namespace Contentstack\Stack;
 
-use Contentstack\Stack\ContentType\Entry\Entry;
-use Contentstack\Stack\ContentType\Query\Query;
-//use Contentstack\Stack\ContentType\Query\Fetch;
+use Contentstack\Stack\ContentType\Entry;
+use Contentstack\Stack\ContentType\Query;
 use Contentstack\Support\Utility;
-require_once __DIR__.'/entry.php';
-require_once __DIR__.'/query.php';
-require_once __DIR__."/../../Support/Utility.php";
 /**
  * Class ContentType
  *  
diff --git a/src/Stack/ContentType/Entry.php b/src/Stack/ContentType/Entry.php
@@ -14,13 +14,11 @@
  * @link      https://pear.php.net/package/contentstack
  * */
 
-namespace Contentstack\Stack\ContentType\Entry;
+namespace Contentstack\Stack\ContentType;
 
-use Contentstack\Stack\ContentType\BaseQuery\BaseQuery;
+use Contentstack\Stack\BaseQuery;
 use Contentstack\Support\Utility;
 
-require_once __DIR__."/base_query.php";
-require_once __DIR__."/../../Support/Utility.php";
 /**
  * Entry
  * 
diff --git a/src/Stack/ContentType/Query.php b/src/Stack/ContentType/Query.php
@@ -13,13 +13,11 @@
  * @link      https://pear.php.net/package/contentstack
  * */
 
-namespace Contentstack\Stack\ContentType\Query;
+namespace Contentstack\Stack\ContentType;
 
-use Contentstack\Stack\ContentType\BaseQuery\BaseQuery;
+use Contentstack\Stack\BaseQuery;
 use Contentstack\Support\Utility;
 
-require_once __DIR__."/base_query.php";
-require_once __DIR__."/../../Support/Utility.php";
 /**
  * Class Query
  * 
diff --git a/src/Stack/Result.php b/src/Stack/Result.php
@@ -13,7 +13,7 @@
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
-namespace Contentstack\Result;
+namespace Contentstack\Stack;
 
 /**
  * Class Result
diff --git a/src/Stack/Stack.php b/src/Stack/Stack.php
@@ -15,13 +15,10 @@
 namespace Contentstack\Stack;
 
 use Contentstack\Support\Utility;
-use Contentstack\Stack\ContentType\ContentType;
-use Contentstack\Stack\Assets\Assets;
+use Contentstack\Stack\ContentType;
+use Contentstack\Stack\Assets;
 
-require_once __DIR__."/content_type.php";
-require_once __DIR__."/assets.php";
-require_once __DIR__."/../../config/index.php";
-require_once __DIR__."/../../Support/Utility.php";
+require_once __DIR__."/../Config/index.php";
 /**
  * Stack Class to initialize the provided parameter Stack
  * 
@@ -58,17 +55,17 @@ public function __construct(
         $api_key = '', 
         $delivery_token = '', 
         $environment = '', 
-        $region = ''
+        $config = array('region'=> '')
     ) {
        
-        if ($region && $region =="eu" && $region !== "undefined") {
-            $this->host = $region.'-cdn.contentstack.com';
+        if ($config && $config !== "undefined" && $config['region'] !== "undefined" && $config['region'] =="eu" ) {
+            $this->host = $config['region'].'-cdn.contentstack.com';
         }
         $this->header = Utility::validateInput(
             'stack', array('api_key' => $api_key, 
             'access_token' => $delivery_token, 
             'environment' => $environment, 
-            'region' => $region)
+            'region' => $config['region'])
         );
         $this->environment = $this->header['environment'];
         unset($this->header['environment']);
@@ -306,4 +303,19 @@ public function getContentTypes($params)
         
         return Utility::contentstackRequest($this, "getcontentTypes");
     }
+
+    /**
+     * Syncs your Contentstack data with your app and ensures that the data is always up-to-date by providing delta updates
+     * 
+     * @param object $params -  params is an object that supports ‘locale’, ‘start_date’, ‘content_type_uid’, and ‘type’ queries.
+     * 
+     * @return Stack
+     * */
+    public function sync($params) 
+    {
+        if ($params && $params !== "undefined") {
+            $this->_query = $params;
+        }
+        return Utility::contentstackRequest($this, "sync");
+    }
 }
diff --git a/src/Support/Utility.php b/src/Support/Utility.php
@@ -14,11 +14,8 @@
  * */
 namespace Contentstack\Support;
 
-require_once __DIR__ . "/../lib/models/result.php";
-require_once __DIR__ . "/../lib/models/csexception.php";
-
 use Contentstack\Error\CSException;
-use Contentstack\Result\Result;
+use Contentstack\Stack\Result;
 
 /**
  * Utility/Helper where all the helper and utility functions will be available.
@@ -153,7 +150,10 @@ public static function contentstackUrl($queryObject = '', $type = '')
             break;
         case 'assets':
             $URL = Utility::getDomain($queryObject).ASSETS;
-            break;                      
+            break;
+        case 'sync':
+            $URL = Utility::getDomain($queryObject).SYNC;
+            break;                     
         default:
             $URL = Utility::getDomain($queryObject).CONTENT_TYPES
             .$queryObject->contentType->uid.ENTRIES;
diff --git a/src/Support/helper.php b/src/Support/helper.php
@@ -1,7 +1,7 @@
 <?php
 
 use Contentstack\Support\Utility;
-require_once __DIR__."/Utility.php";
+
 if(!function_exists('contentstackGetFunctionName')) {
     /*
      * To get the Query method name
@@ -168,7 +168,7 @@ function contentstackLogical($operator = '', $query = array(), $value = array())
             throw contentstackCreateError('Invalid input for "'.contentstackGetFunctionName().'". At least one Query or array object is expected');
         foreach($value as $key => $_qry) {
             if(!Utility::isKeySet($query, $operator)) $query[$operator] = array();
-            if($_qry instanceof \Contentstack\Stack\ContentType\BaseQuery\BaseQuery)
+            if($_qry instanceof \Contentstack\Stack\BaseQuery)
                 array_push($query[$operator], $_qry->subQuery);
             else if(is_array($_qry))
                 array_push($query[$operator], $_qry);
diff --git a/test/AssetsTest.php b/test/AssetsTest.php
@@ -2,7 +2,6 @@
 require_once __DIR__ . '/REST.php';
 require_once __DIR__ . '/constants.php';
 
-require_once __DIR__ . '/../src/contentstack.php';
 require_once __DIR__ . '/utility.php';
 use Contentstack\Test\REST;
 use Contentstack\Contentstack;
diff --git a/test/EntriesTest.php b/test/EntriesTest.php
@@ -2,7 +2,6 @@
 require_once __DIR__ . '/REST.php';
 require_once __DIR__ . '/constants.php';
 
-require_once __DIR__ . '/../src/contentstack.php';
 require_once __DIR__ . '/utility.php';
 use Contentstack\Test\REST;
 use PHPUnit\Framework\TestCase;
diff --git a/test/ImageTransformTest.php b/test/ImageTransformTest.php
@@ -3,8 +3,6 @@
 require_once __DIR__ . '/constants.php';
 require_once __DIR__ . '/utility.php';
 
-require_once __DIR__ . '/../src/contentstack.php';
-
 use Contentstack\Test\REST;
 use Contentstack\Contentstack;
 use PHPUnit\Framework\TestCase;
diff --git a/test/SyncTest.php b/test/SyncTest.php
@@ -0,0 +1,74 @@
+<?php
+require_once __DIR__ . '/REST.php';
+require_once __DIR__ . '/constants.php';
+
+require_once __DIR__ . '/utility.php';
+use Contentstack\Test\REST;
+use Contentstack\Contentstack;
+
+use PHPUnit\Framework\TestCase;
+use Contentstack\Support\Utility;
+class SyncTest extends TestCase {
+    public static $rest;
+    public static $Stack;
+    /*
+     * Setup before the test suites executes
+     * @test
+     */
+    public static function setUpBeforeClass() : void {
+        self::$rest = new REST();
+        self::$Stack = Contentstack::Stack(self::$rest->getAPIKEY(), self::$rest->getAccessToken(),  self::$rest->getEnvironmentName());
+        if (self::$rest->getHost() !== NULL) {
+            self::$Stack->setHost(self::$rest->getHost());
+        }
+    }
+    /*
+     * Tear Down after the test suites executes
+     */
+    public static function tearDownAfterClass() : void{
+        if(ENV !== 'TEST_LOCAL') {
+            // self::$rest->deleteStack();
+        }
+    }
+
+    public function testSyncInit() {
+         $_result = self::$Stack->sync(array('init'=> 'true'));
+         $this->assertEquals(18, count($_result['items']));
+         $this->assertNotNull($_result['sync_token']);
+         $this->assertEquals(18, $_result['total_count']);
+         $this->assertEquals(100, $_result['limit']);
+
+    }
+
+    public function testSyncInitContentType() {
+        $_result = self::$Stack->sync(array('init'=> 'true', "content_type_uid"=> CT_ContentType));
+        $this->assertEquals(11, count($_result['items']));
+        $this->assertNotNull($_result['sync_token']);
+        $this->assertEquals(11, $_result['total_count']);
+        $this->assertEquals(100, $_result['limit']);
+    }
+
+    public function testSyncInitLocale() {
+        $_result = self::$Stack->sync(array('init'=> 'true', "locale"=> 'hi-in'));
+        $this->assertEquals(3, count($_result['items']));
+        $this->assertNotNull($_result['sync_token']);
+        $this->assertEquals(3, $_result['total_count']);
+        $this->assertEquals(100, $_result['limit']);
+    }
+
+    public function testSyncInitType() {
+        $_result = self::$Stack->sync(array('init'=> 'true', "type"=> 'asset_published'));
+        $this->assertEquals(4, count($_result['items']));
+        $this->assertNotNull($_result['sync_token']);
+        $this->assertEquals(4, $_result['total_count']);
+        $this->assertEquals(100, $_result['limit']);
+    }
+
+    public function testSyncInitMultipleQuery() {
+        $_result = self::$Stack->sync(array('init'=> 'true', "type"=> 'entry_published', "locale"=> 'hi-in', "content_type_uid"=> CT_ContentType));
+        $this->assertEquals(1, count($_result['items']));
+        $this->assertNotNull($_result['sync_token']);
+        $this->assertEquals(1, $_result['total_count']);
+        $this->assertEquals(100, $_result['limit']);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-return new Sami\Sami('/Users/uttamukkoji/Documents/php/contentstack-php/src');`
	`3`	`+return new Doctum\Doctum('./src');`
`4`	`4`