AgelxNash / DocLister

assets/lib/MODxAPI/MODx.php

Spacing +59 added lines, -59 removed lines

@@ -1,7 +1,7 @@ 
 <?php

-include_once(MODX_BASE_PATH.'assets/lib/APIHelpers.class.php');

-include_once(MODX_BASE_PATH.'assets/snippets/DocLister/lib/jsonHelper.class.php');

-include_once(MODX_BASE_PATH.'assets/snippets/DocLister/lib/DLCollection.class.php');

+include_once(MODX_BASE_PATH . 'assets/lib/APIHelpers.class.php');

+include_once(MODX_BASE_PATH . 'assets/snippets/DocLister/lib/jsonHelper.class.php');

+include_once(MODX_BASE_PATH . 'assets/snippets/DocLister/lib/DLCollection.class.php');

 

 abstract class MODxAPI extends MODxAPIhelpers

 {

@@ -26,7 +26,7 @@ 
     public function __construct(DocumentParser $modx, $debug = false)

     {	

     	$this->modx = $modx;

-        if(function_exists("get_magic_quotes_gpc") && get_magic_quotes_gpc()){

+        if (function_exists("get_magic_quotes_gpc") && get_magic_quotes_gpc()) {

         	throw new Exception('Magic Quotes is a deprecated and mostly useless setting that should be disabled. Please ask your server administrator to disable it in php.ini or in your webserver config.');

 		}

 

@@ -34,40 +34,40 @@ 
         $this->_decodedFields = new DLCollection($this->modx);

     }

 

-    public function setDebug($flag){

+    public function setDebug($flag) {

         $this->_debug = (bool)$flag;

         return $this;

     }

-    public function getDebug(){

+    public function getDebug() {

         return $this->_debug;

     }

-    public function getDefaultFields(){

+    public function getDefaultFields() {

         return $this->default_field;

     }

     final public function modxConfig($name, $default = null)

     {

         return APIHelpers::getkey($this->modx->config, $name, $default);

     }

-    public function addQuery($q){

-        if(is_scalar($q) && !empty($q)){

+    public function addQuery($q) {

+        if (is_scalar($q) && !empty($q)) {

             $this->_query[] = $q;

         }

         return $this;

     }

-    public function getQueryList(){

+    public function getQueryList() {

         return $this->_query;

     }

     final public function query($SQL)

     {

-        if($this->getDebug()){

+        if ($this->getDebug()) {

             $this->addQuery($SQL);

         }

         return empty($SQL) ? null : $this->modx->db->query($SQL);

     }

-    final public function escape($value){

-        if(!is_scalar($value)){

+    final public function escape($value) {

+        if (!is_scalar($value)) {

             $value = '';

-        }else{

+        } else {

             $value = $this->modx->db->escape($value);

         }

         return $value;

@@ -111,7 +111,7 @@ 
     final public function clearCache($fire_events = null, $custom = false)

     {

 		$IDs = array();

-		if($custom === false) {

+		if ($custom === false) {

 			$this->modx->clearCache();

 			include_once(MODX_MANAGER_PATH . 'processors/cache_sync.class.processor.php');

 			$sync = new synccache();

@@ -119,8 +119,8 @@ 
 			$sync->setCachepath($path);

 			$sync->setReport(false);

 			$sync->emptyCache();

-		}else {

-			if(is_scalar($custom)){

+		} else {

+			if (is_scalar($custom)) {

 				$custom = array($custom);

 			}

 			switch ($this->modx->config['cache_type']) {

@@ -130,11 +130,11 @@ 
 				default:

 					$cacheFile = ".pageCache.php";

 			}

-			if(is_array($custom)) {

-				foreach($custom as $id) {

-					$tmp = glob(MODX_BASE_PATH."assets/cache/docid_" . $id . $cacheFile);

-					foreach($tmp as $file){

-						if(is_readable($file)){

+			if (is_array($custom)) {

+				foreach ($custom as $id) {

+					$tmp = glob(MODX_BASE_PATH . "assets/cache/docid_" . $id . $cacheFile);

+					foreach ($tmp as $file) {

+						if (is_readable($file)) {

 							unlink($file);

 						}

 						$IDs[] = $id;

@@ -145,8 +145,8 @@ 
 		}

         $this->invokeEvent('OnSiteRefresh', array('IDs' => $IDs), $fire_events);

     }

-	public function switchObject($id){

-        switch(true){

+	public function switchObject($id) {

+        switch (true) {

             //Если загружен другой объект - не тот, с которым мы хотим временно поработать

             case ($this->getID() != $id && $id):

                 $obj = clone $this;

@@ -162,11 +162,11 @@ 
         }

         return $obj;

     }

-	public function useIgnore($flag = true){

+	public function useIgnore($flag = true) {

 		$this->ignoreError = $flag ? 'IGNORE' : '';

 		return $this;

 	}

-	public function hasIgnore(){

+	public function hasIgnore() {

 		return (bool)$this->ignoreError;

 	}

 

@@ -313,7 +313,7 @@ 
         }

         return $out;

     }

-    final public function fieldPKName(){

+    final public function fieldPKName() {

         return $this->pkName;

     }

     final public function makeTable($table)

@@ -329,7 +329,7 @@ 
         }

         $out = array();

         foreach ($data as $item) {

-            if($item !== ''){

+            if ($item !== '') {

                 $out[] = $this->escape($item);

             }

         }

@@ -344,18 +344,18 @@ 
             foreach ($field as $_field) {

                 $val = $this->get($_field);

                 if ($val != '')

-                    $where[] = "`".$this->escape($_field)."` = '".$this->escape($val)."'";

+                    $where[] = "`" . $this->escape($_field) . "` = '" . $this->escape($val) . "'";

             }

-            $where = implode(' AND ',$where);

+            $where = implode(' AND ', $where);

         } else {

             $where = '';

             $val = $this->get($field);

             if ($val != '')

-                $where = "`".$this->escape($field)."` = '".$this->escape($val)."'";

+                $where = "`" . $this->escape($field) . "` = '" . $this->escape($val) . "'";

         }

         

         if ($where != '') {

-            $sql = $this->query("SELECT `" . $this->escape($PK) . "` FROM " . $this->makeTable($table) . " WHERE ".$where);

+            $sql = $this->query("SELECT `" . $this->escape($PK) . "` FROM " . $this->makeTable($table) . " WHERE " . $where);

             $id = $this->modx->db->getValue($sql);

             if (is_null($id) || (!$this->newDoc && $id == $this->getID())) {

                 $flag = true;

@@ -439,7 +439,7 @@ 
      * @param  string $field имя поля

      * @return boolean

      */

-    public function isJsonField($field){

+    public function isJsonField($field) {

         return (is_scalar($field) && in_array($field, $this->jsonFields));

     }

 

@@ -448,8 +448,8 @@ 
      * @param  string $field имя поля

      * @return $this

      */

-    public function markAsDecode($field){

-        if(is_scalar($field)){

+    public function markAsDecode($field) {

+        if (is_scalar($field)) {

             $this->_decodedFields->set($field, false);

         }

         return $this;

@@ -460,8 +460,8 @@ 
      * @param  string $field имя поля

      * @return $this

      */

-    public function markAsEncode($field){

-        if(is_scalar($field)){

+    public function markAsEncode($field) {

+        if (is_scalar($field)) {

             $this->_decodedFields->set($field, true);

         }

         return $this;

@@ -471,9 +471,9 @@ 
      * Пометить все поля как запакованные

      * @return $this

      */

-    public function markAllEncode(){

+    public function markAllEncode() {

         $this->_decodedFields->clear();

-        foreach($this->jsonFields as $field){

+        foreach ($this->jsonFields as $field) {

             $this->markAsEncode($field);

         }

         return $this;

@@ -483,9 +483,9 @@ 
      * Пометить все поля как распакованные

      * @return $this

      */

-    public function markAllDecode(){

+    public function markAllDecode() {

         $this->_decodedFields->clear();

-        foreach($this->jsonFields as $field){

+        foreach ($this->jsonFields as $field) {

             $this->markAsDecode($field);

         }

         return $this;

@@ -495,8 +495,8 @@ 
      * Получить список не запакованных полей

      * @return array

      */

-    public function getNoEncodeFields(){

-        return $this->_decodedFields->filter(function($value){

+    public function getNoEncodeFields() {

+        return $this->_decodedFields->filter(function($value) {

             return ($value === false);

         });

     }

@@ -505,8 +505,8 @@ 
      * Получить список не распакованных полей

      * @return array

      */

-    public function getNoDecodeFields(){

-       return $this->_decodedFields->filter(function($value){

+    public function getNoDecodeFields() {

+       return $this->_decodedFields->filter(function($value) {

             return ($value === true);

         });

     }

@@ -516,12 +516,12 @@ 
      * @param  string $field имя поля

      * @return boolean

      */

-    public function isDecodableField($field){

+    public function isDecodableField($field) {

         $data = $this->get($field);

         /**

          * Если поле скалярного типа и оно не распаковывалось раньше

          */

-        return (is_scalar($data) && is_scalar($field) && $this->_decodedFields->get($field)===true);

+        return (is_scalar($data) && is_scalar($field) && $this->_decodedFields->get($field) === true);

     }

 

     /**

@@ -529,11 +529,11 @@ 
      * @param  string  $field имя поля

      * @return boolean

      */

-    public function isEncodableField($field){

+    public function isEncodableField($field) {

         /**

          * Если поле было распаковано ранее и еще не упаковано

          */

-        return (is_scalar($field) && $this->_decodedFields->get($field)===false);

+        return (is_scalar($field) && $this->_decodedFields->get($field) === false);

     }

 

     /**

@@ -542,13 +542,13 @@ 
      * @param  bool $store обновить распакованное поле

      * @return array ассоциативный массив с данными из json строки

      */

-    public function decodeField($field, $store = false){

+    public function decodeField($field, $store = false) {

         $out = array();

-        if($this->isDecodableField($field)){

+        if ($this->isDecodableField($field)) {

             $data = $this->get($field);

             $out = jsonHelper::jsonDecode($data, array('assoc' => true), true);

         }

-        if($store){

+        if ($store) {

             $this->field[$field] = $out;

             $this->markAsDecode($field);

         }

@@ -559,8 +559,8 @@ 
      * Декодирование всех json полей

      * @return $this

      */

-    protected function decodeFields(){

-        foreach($this->getNoDecodeFields() as $field => $flag){

+    protected function decodeFields() {

+        foreach ($this->getNoDecodeFields() as $field => $flag) {

             $this->decodeField($field, true);

         }

         return $this;

@@ -572,13 +572,13 @@ 
      * @param  bool $store обновить запакованное поле

      * @return array json строка

      */

-    public function encodeField($field, $store = false){

+    public function encodeField($field, $store = false) {

         $out = null;

-        if($this->isEncodableField($field)){

+        if ($this->isEncodableField($field)) {

             $data = $this->get($field);

             $out = json_encode($data);

         }

-        if($store){

+        if ($store) {

             $this->field[$field] = $out;

             $this->markAsEncode($field);

         }

@@ -589,8 +589,8 @@ 
      * Запаковка всех json полей

      * @return $this

      */

-    protected function encodeFields(){

-        foreach($this->getNoEncodeFields() as $field => $flag){

+    protected function encodeFields() {

+        foreach ($this->getNoEncodeFields() as $field => $flag) {

             $this->encodeField($field, true);

         }

         return $this;

Braces +26 added lines, -12 removed lines

@@ -67,7 +67,7 @@ 
     final public function escape($value){

         if(!is_scalar($value)){

             $value = '';

-        }else{

+        } else{

             $value = $this->modx->db->escape($value);

         }

         return $value;

@@ -95,7 +95,9 @@ 
     final public function list_log($flush = false)

     {

         echo '<pre>' . print_r(APIHelpers::sanitarTag($this->log), true) . '</pre>';

-        if ($flush) $this->clearLog();

+        if ($flush) {

+            $this->clearLog();

+        }

         return $this;

     }

 

@@ -119,7 +121,7 @@ 
 			$sync->setCachepath($path);

 			$sync->setReport(false);

 			$sync->emptyCache();

-		}else {

+		} else {

 			if(is_scalar($custom)){

 				$custom = array($custom);

 			}

@@ -206,7 +208,9 @@ 
         } else {

             if ($this->issetField($key) && is_scalar($this->field[$key])) {

             	$tmp = "`{$key}`='{$this->escape($this->field[$key])}'";

-			} else throw new Exception("{$key} is invalid <pre>" . print_r($this->field[$key], true) . "</pre>");

+			} else {

+			    throw new Exception("{$key} is invalid <pre>" . print_r($this->field[$key], true) . "</pre>");

+			}

         }

         if (!empty($tmp)) {

             if ($id == '') {

@@ -248,18 +252,24 @@ 
     {

         if (is_scalar($data) && !empty($data)) {

         	$json = json_decode($data);

-		} else throw new Exception("json is not string with json data");

+		} else {

+		    throw new Exception("json is not string with json data");

+		}

 

 		if ($this->jsonError($json)) {

         	if (isset($callback) && is_callable($callback)) {

             	call_user_func_array($callback, array($json));

 			} else {

-            	if (isset($callback)) throw new Exception("Can't call callback JSON unpack <pre>" . print_r($callback, 1) . "</pre>");

+            	if (isset($callback)) {

+            	    throw new Exception("Can't call callback JSON unpack <pre>" . print_r($callback, 1) . "</pre>");

+            	}

                 foreach ($json as $key => $val) {

                 	$this->set($key, $val);

 				}

 			}

-		} else throw new Exception('Error from JSON decode: <pre>' . print_r($data, 1) . '</pre>');

+		} else {

+		    throw new Exception('Error from JSON decode: <pre>' . print_r($data, 1) . '</pre>');

+		}

 

 		return $this;

     }

@@ -270,7 +280,9 @@ 
         if (isset($callback) && is_callable($callback)) {

         	$data = call_user_func_array($callback, array($data));

 		} else {

-        	if (isset($callback)) throw new Exception("Can't call callback JSON pre pack <pre>" . print_r($callback, 1) . "</pre>");

+        	if (isset($callback)) {

+        	    throw new Exception("Can't call callback JSON pre pack <pre>" . print_r($callback, 1) . "</pre>");

+        	}

 		}

         $json = json_encode($data);

 

@@ -343,15 +355,17 @@ 
             $where = array();

             foreach ($field as $_field) {

                 $val = $this->get($_field);

-                if ($val != '')

-                    $where[] = "`".$this->escape($_field)."` = '".$this->escape($val)."'";

+                if ($val != '') {

+                                    $where[] = "`".$this->escape($_field)."` = '".$this->escape($val)."'";

+                }

             }

             $where = implode(' AND ',$where);

         } else {

             $where = '';

             $val = $this->get($field);

-            if ($val != '')

-                $where = "`".$this->escape($field)."` = '".$this->escape($val)."'";

+            if ($val != '') {

+                            $where = "`".$this->escape($field)."` = '".$this->escape($val)."'";

+            }

         }

         

         if ($where != '') {