- Added trigger ability to Insert, Update and Create methods

Author: aemaddin

src/ZohoModule.php

@@ -19,8 +19,7 @@ class ZohoModule
      * @param ZCRMRestClient $rest
      * @param $module_api_name
      */
-    public function __construct($rest, $module_api_name)
-    {
+    public function __construct($rest, $module_api_name) {
         $this->rest = $rest;
         $this->module_api_name = $module_api_name;
         $this->moduleIns = $this->getModuleInstance();
@@ -31,8 +30,7 @@ public function __construct($rest, $module_api_name)
      *
      * @return ZCRMModule[]
      */
-    public function getAllModules()
-    {
+    public function getAllModules() {
         return $this->rest->getAllModules()->getData();
     }
 
@@ -41,29 +39,28 @@ public function getAllModules()
      *
      * @return ZCRMModule|object
      */
-    public function getModule()
-    {
+    public function getModule() {
         return $this->rest->getModule($this->module_api_name)->getData();
     }
 
     /**
      * get record instance
      *
      * @param $record_id
+     *
      * @return ZCRMRecord
      */
-    public function getRecordInstance($record_id = null)
-    {
-        return $this->rest->getRecordInstance($this->module_api_name, $record_id);
+    public function getRecordInstance($record_id = null) {
+        return $this->rest->getRecordInstance($this->module_api_name,
+            $record_id);
     }
 
     /**
      * get dummy module object
      *
      * @return ZCRMModule
      */
-    public function getModuleInstance()
-    {
+    public function getModuleInstance() {
         return $this->rest->getModuleInstance($this->module_api_name);
     }
 
@@ -72,133 +69,158 @@ public function getModuleInstance()
      *
      * @return ZCRMRecord[]
      */
-    public function getRecords()
-    {
+    public function getRecords() {
         return $this->moduleIns->getRecords()->getData();
     }
 
     /**
      * get the record object of given module api name and record id
      *
      * @param string $record_id
+     *
      * @return object|ZCRMRecord
      */
-    public function getRecord($record_id)
-    {
+    public function getRecord($record_id) {
         return $this->moduleIns->getRecord($record_id)->getData();
     }
 
     /**
      * get module records
      *
-     * @param string $word //word to be searched
-     * @param int $page //to get the list of records from the respective pages. Default value for page is 1.
-     * @param int $perPage //To get the list of records available per page. Default value for per page is 200.
+     * @param string $word  //word to be searched
+     * @param int $page  //to get the list of records from the respective pages. Default value for page is 1.
+     * @param int $perPage  //To get the list of records available per page. Default value for per page is 200.
+     *
      * @return ZCRMRecord[]
      */
-    public function searchRecordsByWord($word = '', $page = 1, $perPage = 200)
-    {
+    public function searchRecordsByWord($word = '', $page = 1, $perPage = 200) {
         $param_map = ["page" => $page, "per_page" => $perPage];
-        return $this->moduleIns->searchRecordsByWord($word, $param_map)->getData();
+
+        return $this->moduleIns->searchRecordsByWord($word, $param_map)
+                               ->getData();
     }
 
     /**
      * get module records
      *
-     * @param string $phone //phone to be searched
-     * @param int $page //to get the list of records from the respective pages. Default value for page is 1.
-     * @param int $perPage //To get the list of records available per page. Default value for per page is 200.
+     * @param string $phone  //phone to be searched
+     * @param int $page  //to get the list of records from the respective pages. Default value for page is 1.
+     * @param int $perPage  //To get the list of records available per page. Default value for per page is 200.
+     *
      * @return ZCRMRecord[]
      */
-    public function searchRecordsByPhone($phone = '', $page = 1, $perPage = 200)
-    {
+    public function searchRecordsByPhone(
+        $phone = '',
+        $page = 1,
+        $perPage = 200
+    ) {
         $param_map = ["page" => $page, "per_page" => $perPage];
-        return $this->moduleIns->searchRecordsByPhone($phone, $param_map)->getData();
+
+        return $this->moduleIns->searchRecordsByPhone($phone, $param_map)
+                               ->getData();
     }
 
     /**
      * get module records
      *
-     * @param string $email //email to be searched
-     * @param int $page //to get the list of records from the respective pages. Default value for page is 1.
-     * @param int $perPage //To get the list of records available per page. Default value for per page is 200.
+     * @param string $email  //email to be searched
+     * @param int $page  //to get the list of records from the respective pages. Default value for page is 1.
+     * @param int $perPage  //To get the list of records available per page. Default value for per page is 200.
+     *
      * @return ZCRMRecord[]
      */
-    public function searchRecordsByEmail($email = '', $page = 1, $perPage = 200)
-    {
+    public function searchRecordsByEmail(
+        $email = '',
+        $page = 1,
+        $perPage = 200
+    ) {
         $param_map = ["page" => $page, "per_page" => $perPage];
-        return $this->moduleIns->searchRecordsByEmail($email, $param_map)->getData();
+
+        return $this->moduleIns->searchRecordsByEmail($email, $param_map)
+                               ->getData();
     }
 
     /**
      * get module records
      *
-     * @param string $criteria //criteria to search for
-     * @param int $page //to get the list of records from the respective pages. Default value for page is 1.
-     * @param int $perPage //To get the list of records available per page. Default value for per page is 200.
+     * @param string $criteria  //criteria to search for
+     * @param int $page  //to get the list of records from the respective pages. Default value for page is 1.
+     * @param int $perPage  //To get the list of records available per page. Default value for per page is 200.
+     *
      * @return ZCRMRecord[]
      */
-    public function searchRecordsByCriteria($criteria, $page = 1, $perPage = 200)
-    {
+    public function searchRecordsByCriteria(
+        $criteria,
+        $page = 1,
+        $perPage = 200
+    ) {
         $param_map = ["page" => $page, "per_page" => $perPage];
-        return $this->moduleIns->searchRecordsByCriteria($criteria, $param_map)->getData();
+
+        return $this->moduleIns->searchRecordsByCriteria($criteria, $param_map)
+                               ->getData();
     }
 
     /**
      * Add new entities to a module.
      *
      * @param ZCRMRecord $record
+     * @param string|null $trigger  array of triggers
+     *
      * @return ZCRMRecord[]
      */
-    public function insert($record)
-    {
+    public function insert($record, string $trigger = null) {
         $records = [];
 
         array_push($records, $record);
-        return $this->moduleIns->createRecords($records)->getData();
+
+        return $this->moduleIns->createRecords($records, $trigger)->getData();
     }
 
     /**
      * create record instance that contains the array keys and values
      *
      * @param array $args
+     * @param string|null $trigger  array of triggers
+     *
      * @return object
      */
-    public function create($args = [])
-    {
+    public function create(array $args = [], string $trigger = null) {
         $record = $this->getRecordInstance();
 
-        foreach ($args as $key => $value) {
+        foreach($args as $key => $value) {
             $record->setFieldValue($key, $value);
         }
 
-        return $record->create()->getData();
+        return $record->create($trigger)->getData();
     }
 
     /**
      * update existing entities in the module.
      *
      * @param ZCRMRecord $record
+     * @param string $trigger array of triggers
+     *
      * @return ZCRMRecord[]
      */
-    public function update($record)
-    {
+    public function update($record, $trigger = null) {
         $records = [];
 
         array_push($records, $record);
-        return $this->moduleIns->updateRecords($records)->getData();
+
+        return $this->moduleIns->updateRecords($records, $trigger)->getData();
     }
 
     /**
      * @param CriteriaBuilder $builder
-     * @param int $page //to get the list of records from the respective pages. Default value for page is 1.
-     * @param int $perPage //To get the list of records available per page. Default value for per page is 200.
+     * @param int $page  //to get the list of records from the respective pages. Default value for page is 1.
+     * @param int $perPage  //To get the list of records available per page. Default value for per page is 200.
+     *
      * @return ZCRMRecord[]
      */
-    public function search($builder, $page = 1, $perPage = 200)
-    {
-        if ($builder->toString() !== "") {
-            return $this->searchRecordsByCriteria($builder->toString(), $page, $perPage);
+    public function search($builder, $page = 1, $perPage = 200) {
+        if($builder->toString() !== "") {
+            return $this->searchRecordsByCriteria($builder->toString(), $page,
+                $perPage);
         }
 
         return null;