contentstack · uttamukkoji · Dec 8, 2021 · Jan 1, 2017 · Jan 1, 2017 · Jan 17, 2017
@@ -13,4 +13,5 @@ test/ImageTransformreport.html
 examples/index.php
 .DS_Store
 tmp/
+test/result.json
 stdout
@@ -1,6 +1,12 @@
 
 ## CHANGELOG
 ------------------------------------------------
+## Version 2.1.0
+###### Date: 29-Oct-2021
+### New Feature
+    - Live Preview feature support added
+    - Content branching feature support added
+------------------------------------------------
 
 ## Version 2.0.0
 ###### Date: 02-Apr-2021

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2020 Contentstack (http://app.contentstack.com). All Rights Reserved
+Copyright (c) 2012-2021 Contentstack (http://app.contentstack.com). All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

@@ -8,7 +8,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -8,7 +8,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  */
@@ -26,7 +26,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  */
@@ -46,7 +46,7 @@ abstract class Contentstack
     public static function Stack($api_key = '',
         $access_token = '',
         $environment = '',
-        $config = array('region'=> '')
+        $config = array('region'=> '', 'branch'=> '', 'live_preview' => array('enable' => false, 'host' => 'api.contentstack.io'))
     ) {
         return new Stack($api_key, $access_token, $environment, $config);
     }

@@ -8,7 +8,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -21,7 +21,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -9,7 +9,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -24,7 +24,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -10,7 +10,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -31,7 +31,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -9,7 +9,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -27,7 +27,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -143,6 +143,7 @@ public function includeReference($field_uids = array())
     /**
      * To search the given string in the entries
      * 
+     * @deprecated since verion 2.2.0
      * @param $search - string to be search in entries
      * 
      * @return Query
@@ -307,6 +308,23 @@ public function includeFallback()
 
         return $this->queryObject;
     }
+
+    /** 
+     * To include branch of publish content.
+     * 
+     * @return Query
+    */
+    public function includeBranch() 
+    {
+        $this->queryObject->_query = call_user_func(
+            'contentstackAddBoolean', 
+            'include_branch', 
+            $this->queryObject->_query
+        );
+
+        return $this->queryObject;
+    }
+
     /**
      * To include schema along with entries
      * 

@@ -10,7 +10,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -27,7 +27,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -9,7 +9,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -26,7 +26,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -8,7 +8,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -25,7 +25,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -9,7 +9,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -22,7 +22,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */

@@ -8,7 +8,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -26,7 +26,7 @@
  * @package   Contentstack
  * @author    Uttam K Ukkoji <uttamukkoji@gmail.com>
  * @author    Rohit Mishra <rhtmishra4545@gmail.com>
- * @copyright 2012-2020 Contentstack. All Rights Reserved
+ * @copyright 2012-2021 Contentstack. All Rights Reserved
  * @license   https://github.com/contentstack/contentstack-php/blob/master/LICENSE.txt MIT Licence
  * @link      https://pear.php.net/package/contentstack
  * */
@@ -55,20 +55,22 @@ public function __construct(
         $api_key = '', 
         $delivery_token = '', 
         $environment = '', 
-        $config = array('region'=> '')
+        $config = array('region'=> '', 'branch'=> '', 'live_preview' => array())
     ) {
 
-        if ($config && $config !== "undefined" && $config['region'] !== "undefined" && $config['region'] =="eu" ) {
+        if ($config && $config !== "undefined" && array_key_exists('region', $config) && $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' => $config['region'] ?? '')
+            'region' => $config['region'] ?? '',
+            'branch' => $config['branch'] ?? '')
         );
         $this->environment = $this->header['environment'];
         unset($this->header['environment']);
+        $this->live_preview = $config['live_preview'] ?? array();
         return $this;
     }
 
@@ -135,7 +137,10 @@ public function ImageTrasform($url, $parameters)
         }                                   
     }
 
-
+    public function LivePreviewQuery($parameters) {
+        $this->live_preview['live_preview'] = $parameters['live_preview'] ?? 'init';
+        $this->live_preview['content_type_uid'] = $parameters['content_type_uid'];
+    }
 
     /**
      * To get the last_activity information of the 
@@ -220,7 +225,7 @@ public function getPort()
     /**
      * This function sets API Key.
      * 
-     * @param string $api_key - Name of Environment
+     * @param string $api_key - API Key
      * 
      * @return Stack
      * */
@@ -233,7 +238,7 @@ public function setAPIKEY($api_key = '')
     /**
      * This function sets Delivery Token.
      * 
-     * @param string $delivery_token - Name of Environment
+     * @param string $delivery_token - Delivery Token
      * 
      * @return Stack
      * */
@@ -286,6 +291,30 @@ public function getEnvironment()
         return $this->environment;
     }
 
+    /**
+     * This function sets Branch.
+     * 
+     * @param string $branch - Name of branch
+     * 
+     * @return Stack
+     * */
+    public function setBranch($branch = '')
+    {
+        Utility::validateInput('branch', $branch);
+        $this->header['branch'] = $branch;
+        return $this;
+    }
+
+    /**
+     * This function returns Branch.
+     * 
+     * @return string
+     * */
+    public function Branch()
+    {
+        return $this->header['branch'];
+    }
+
     /**
      * This call returns comprehensive information of all 
      * the content types available in a particular stack in your account.