Merge branch 'master' into embeddec_items

Author: uttamukkoji

CHANGELOG.md

@@ -2,6 +2,23 @@
 ## CHANGELOG
 ------------------------------------------------
 
+## Version 2.0.0
+###### Date: 02-Apr-2021
+### New Feature
+ - Sync API support added
+### Enhancement
+ - Added PSR 4 Standardized implementation.
+
+------------------------------------------------
+
+## Version 1.8.1
+###### Date: 17-Mar-2021
+### Bug Fix
+- Updated addQuery method to pass non encoded Json to Query object
+- Removed parameter check on functions those pass default values.
+
+------------------------------------------------
+
 ## Version 1.8.0
 ###### Date: 5-Dec-2020
 ### New Feature

README.md

@@ -20,10 +20,18 @@ To use the PHP SDK, you need to perform the following steps:
 
 To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.
 
-    use Contentstack\Contentstack;
-    $stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
-
-
+```php
+use Contentstack\Contentstack;
+$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
+```
+For Setting the European Region:
+If you want to set and use European region, refer to the code below:
+
+```php
+use Contentstack\Contentstack;
+use Contentstack\ContentstackRegion;
+$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME, array('region'=> ContentstackRegion.EU));
+```
 #### Download and install library:
 To use the PHP SDK, you need to perform the following steps:
 
@@ -32,9 +40,11 @@ To use the PHP SDK, you need to perform the following steps:
 
 To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.
 
-    use Contentstack\Contentstack;
-    include_once "contentstack/contentstack.php";
-    $stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
+```php
+use Contentstack\Contentstack;
+include_once "contentstack/contentstack.php";
+$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
+```
 
 
 ### Key Concepts for using Contentstack
@@ -59,8 +69,7 @@ Assets refer to all the media files (images, videos, PDFs, audio files, and so o
 
 A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with [Environments](https://www.contentstack.com/docs/guide/environments). 
 
-  
-  
+
 
 ### Contentstack PHP SDK: 5-minute Quickstart
 
@@ -69,31 +78,35 @@ Install the library using [Composer](https://packagist.org/packages/contentstack
 
     composer require contentstack/contentstack
 
+
 To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.
 
-    use Contentstack\Contentstack;
-    $stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
+```php
+use Contentstack\Contentstack;
+$stack = Contentstack::Stack(API_KEY, DELIVERY_TOKEN, ENV_NAME);
+```
 
 To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings > Stack to view the API Key and Delivery Token.
 
-  
+
 
 #### Querying content from your stack
 
 To find all entries  of a content type, use the query given below:
 
-    $result = $stack->ContentType(CONTENT_TYPE_UID)->Query()->toJSON()->includeCount()->includeContentType()->find()
-    // $result[0] - array of entries
-    // $result[1] - content type
-    // $result[2] - count of the entries
-
-  
-  
+```php
+$result = $stack->ContentType(CONTENT_TYPE_UID)->Query()->toJSON()->includeCount()->includeContentType()->find();
+// $result[0] - array of entries
+// $result[1] - content type
+// $result[2] - count of the entries
+```
 
 To fetch a specific entry from a content type, use the following query:
 
-    $result = $stack->ContentType(CONTENT_TYPE_UID)->Entry(ENTRY_UID)->toJSON()->fetch()
-    // $result - entry object
+```php
+$result = $stack->ContentType(CONTENT_TYPE_UID)->Entry(ENTRY_UID)->toJSON()->fetch();
+// $result - entry object
+```
 
 ### Advanced Queries
 
@@ -115,22 +128,24 @@ You can use the Image Delivery API functions in this SDK as well. Here are a few
 
 // set the image quality to 100.
 
-    imageUrl = Stack->imageTransform(imageUrl, array(
-    'quality'=> 100));
+```php
+$imageUrl = $stack->imageTransform(imageUrl, array('quality' => 100));
+```
 
 // resize the image by specifying width and height.
 
-    imageUrl = Stack->imageTransform(imageUrl, array(
-    'width'=> 100,
-    'height'=> 100
-    ));
+```php
+$imageUrl = $stack->imageTransform(imageUrl, array(
+  'width' => 100,
+  'height' => 100
+));
+```
 
 // enable auto optimization for the image.
 
-    imageUrl = Stack->imageTransform(imageUrl, array(
-    'auto'=> 'webp'
-    ))
-
+```php
+$imageUrl = $stack->imageTransform(imageUrl, array('auto' => 'webp'));
+```
 
 
 ### Helpful Links

composer.json

@@ -27,16 +27,14 @@
     "require-dev": {
         "phpunit/phpunit": "^9.0",
         "phpunit/php-code-coverage": "^8.0",
-        "sami/sami": "^4.1",
-        "contentstack/utils": "dev-master"
+        "code-lts/doctum": "^5.3"
     },
-    "require": {
-        "php" : ">=5.5.0"
+    "scripts": {
+        "generate:docs": "vendor/bin/doctum.php update ./config.php",
+        "test": "vendor/bin/phpunit"
     },
-    "repositories": [
-        {
-            "type": "path",
-            "url": "../contentstack-utils-php/"
-        }
-    ]
+    "require": {
+        "php" : ">=5.5.0",
+        "contentstack/utils": "^1.0"
+    }
 }

config.php

@@ -1,4 +1,4 @@
 <?php
 
-return new Sami\Sami('/Users/uttamukkoji/Documents/php/contentstack-php/src');
+return new Doctum\Doctum('./src');
 

src/config/index.php renamed to src/Config/index.php

@@ -25,3 +25,4 @@
 define('ENTRIES', '/entries/');
 define('ASSETS', '/assets/');
 define('ENVIRONMENTS', '/environments/');
+define('SYNC', '/stacks/sync/');

src/contentstack.php renamed to src/Contentstack.php

@@ -18,7 +18,6 @@
 use Contentstack\Utils\Utils;
 use Contentstack\Utils\Model\Option;
 
-require_once __DIR__ . '/lib/models/stack.php';
 
 /**
  *  Contentstack abstract class to provide access to Stack Object
@@ -39,16 +38,17 @@ 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 array              $config       : Stack Configuration to provide region.
      * @param ContentstackRegion $region       : Region name of Contentstack.
-     * 
+
      * @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);
     }
 
     public static function renderContent(string $content, Option $option): string 

src/contentstackregion.php renamed to src/ContentstackRegion.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 

src/lib/models/csexception.php renamed to src/Error/CSException.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
@@ -365,9 +365,10 @@ public function includeContentType()
     public function includeEmbeddedItems() 
     {
         $this->queryObject->_query = call_user_func(
-            'contentstackAddBoolean', 
+            'contentstackReferences', 
             'include_embedded_items', 
-            $this->queryObject->_query
+            $this->queryObject->_query,
+            ["BASE"]
         );
         return $this->queryObject;
     }