🎉 Live Preview feature support added

Author: uttamukkoji

src/Contentstack.php

@@ -46,7 +46,7 @@ abstract class Contentstack
     public static function Stack($api_key = '',
         $access_token = '',
         $environment = '',
-        $config = array('region'=> '')
+        $config = array('region'=> '', 'live_preview' => array('enable' => false))
     ) {
         return new Stack($api_key, $access_token, $environment, $config);
     }

src/Stack/Stack.php

@@ -55,10 +55,10 @@ public function __construct(
         $api_key = '', 
         $delivery_token = '', 
         $environment = '', 
-        $config = array('region'=> '')
+        $config = array('region'=> '', '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(
@@ -69,6 +69,7 @@ public function __construct(
         );
         $this->environment = $this->header['environment'];
         unset($this->header['environment']);
+        $this->live_preview = $config['live_preview'] ?? array();
         return $this;
     }
 
@@ -136,6 +137,10 @@ public function ImageTrasform($url, $parameters)
     }
 
 
+    public function LivePreviewQuery($parameters) {
+        $this->live_preview['hash'] = $parameters['hash'] ?? 'init';
+        $this->live_preview['content_type_uid'] = $parameters['content_type_uid'];
+    }
 
     /**
      * To get the last_activity information of the 

src/Support/Utility.php

@@ -98,6 +98,13 @@ public static function validateInput($type = '', $input = array())
             throw new \Exception($e->getMessage());
         }
     }
+
+    public static function isLivePreview($query) {
+        if ($query && isset($query->contentType)) { 
+            return ($query->contentType->stack->live_preview['enable'] == true && array_key_exists('content_type_uid', $query->contentType->stack->live_preview) && $query->contentType->uid == $query->contentType->stack->live_preview['content_type_uid']);
+        }
+        return false;
+    }
     /**
      * Get the domain from the current object
      * 
@@ -109,16 +116,20 @@ public static function getDomain($query)
     {
         $stack = $query;  
         if ($query && isset($query->contentType)) { 
-            $stack = $query->contentType->stack; 
+            $stack = $query->contentType->stack;
         }
         if ($query && isset($query->stack)) {
             $stack = $query->stack;
         }
         if ($query && isset($query->assets)) {
             $stack = $query->assets->stack;
         }
+        $host = $stack->getHost();
+        if (Utility::isLivePreview($query)) {
+            $host = $stack->live_preview['host'];
+        }
         return $stack->getProtocol()
-            .'://'.$stack->getHost()
+            .'://'.$host
             .':'
             .$stack->getPort().VERSION;
     }
@@ -136,8 +147,10 @@ public static function contentstackUrl($queryObject = '', $type = '')
         $URL = '';
         switch ($type) {
         case 'set_environment':
-            $URL = Utility::getDomain($queryObject).ENVIRONMENTS.''
-            .$queryObject->contentType->stack->getEnvironment();
+            if (!Utility::isLivePreview($queryObject)) {
+                $URL = Utility::getDomain($queryObject).ENVIRONMENTS.''
+                .$queryObject->contentType->stack->getEnvironment();
+            }
             break;
         case 'get_last_activites':
             $URL = Utility::getDomain($queryObject).CONTENT_TYPES;
@@ -374,7 +387,12 @@ public static function contentstackRequest($queryObject = '', $type = '')
             $request_headers = array();
             $request_headers[] = 'x-user-agent: contentstack-php/1.6.1';
             $request_headers[] = 'api_key: '.$Headers["api_key"];
-            $request_headers[] = 'access_token: '.$Headers["access_token"];
+            if (Utility::isLivePreview($queryObject)) {
+                $request_headers[] = 'authorization: '.$queryObject->contentType->stack->live_preview['authorization'] ;
+                $request_headers[] = 'hash: '.($queryObject->contentType->stack->live_preview['hash'] ?? 'init');
+            }else {
+                $request_headers[] = 'access_token: '.$Headers["access_token"];
+            }
             curl_setopt($http, CURLOPT_HTTPHEADER, $request_headers);
 
             curl_setopt($http, CURLOPT_HEADER, false);

test/EntriesTest.php

@@ -12,6 +12,7 @@
 class EntriesTest extends TestCase {
     public static $rest;
     public static $Stack;
+    public static $LivePreviewStack;
     public static $_uid;
     /*
      * Setup before the test suites executes
@@ -23,6 +24,13 @@ public static function setUpBeforeClass() : void {
         if (self::$rest->getHost() !== NULL) {
             self::$Stack->setHost(self::$rest->getHost());
         }
+
+        self::$LivePreviewStack = Contentstack::Stack(self::$rest->getAPIKEY(), self::$rest->getAccessToken(),  self::$rest->getEnvironmentName(), array('live_preview' => array(
+            'enable'=> true,
+            'host' => 'preview.contentstack.com',
+            'authorization' => 'token'
+        )));
+
     }
     /*
      * Tear Down after the test suites executes
@@ -49,6 +57,21 @@ public function testFind() {
             }
         }
     }
+    public function testLivePreviewEntry () {
+        $_entry = self::$LivePreviewStack->ContentType(CT_ContentType)->Entry(self::$_uid)->toJSON()->fetch();
+
+        $this->assertEquals($_entry['title'], 'CB1-10');
+    }
+
+    public function testLivePreviewEntrywithQuery () {
+        try {
+            self::$LivePreviewStack->livePreviewQuery(array('content_type_uid' => CT_ContentType));
+            $_entry = self::$LivePreviewStack->ContentType(CT_ContentType)->Entry(self::$_uid)->toJSON()->fetch();
+    
+        } catch (Exception $e) {
+            $this->assertTrue(true);  
+        }
+    }
 
     public function testFetch() {
         $_entry = self::$Stack->ContentType(CT_ContentType)->Entry(self::$_uid)->toJSON()->fetch();