AgelxNash / DocLister

assets/snippets/DLUsers/src/Actions.php

Unused Use Statements +4 added lines, -1 removed lines

@@ -6,7 +6,10 @@
 include_once(MODX_BASE_PATH . 'assets/snippets/DocLister/lib/DLTemplate.class.php');
 include_once(MODX_BASE_PATH . 'assets/snippets/DocLister/lib/DLCollection.class.php');
 
-use APIHelpers, DocumentParser, DLCollection, DLTemplate;
+use APIHelpers;
+use DocumentParser;
+use DLCollection;
+use DLTemplate;
 use Helpers\FS;
 
 class Actions{

Doc Comments +6 added lines, -4 removed lines

@@ -50,6 +50,8 @@ 
     /**
      * is not allowed to call from outside: private!
      *
+     * @param string $userClass
+     * @param boolean $debug
      */
     private function __construct(DocumentParser $modx, $userClass, $debug)
     {
@@ -285,9 +287,9 @@ 
      * @param $emailField
      * @param $rememberField
      * @param $backUrl
-     * @param $method
-     * @param $error
-     * @param $errorCode
+     * @param string $method
+     * @param string $error
+     * @param string $errorCode
      * @param array $params
      * @return array
      */
@@ -468,7 +470,7 @@ 
 	}
 
     /**
-     * @param $name
+     * @param string $name
      * @return string
      */
     protected function getTemplate($name){

Spacing +18 added lines, -18 removed lines

@@ -97,7 +97,7 @@ 
     public function logout($params)
     {
         $LogoutName = APIHelpers::getkey($params, 'LogoutName', 'logout');
-        if (is_scalar($LogoutName) && !empty($LogoutName) && isset($_GET[$LogoutName])) {
+        if (is_scalar($LogoutName) && ! empty($LogoutName) && isset($_GET[$LogoutName])) {
             $userID = $this->UserID('web');
             if ($userID) {
                 $this->userObj->edit($userID);
@@ -177,7 +177,7 @@ 
             $dataTPL = $this->userObj->toArray();
             $dataTPL['url.logout'] = $this->logoutUrl($params);
             $homeID = APIHelpers::getkey($params, 'homeID');
-            if (!empty($homeID)) {
+            if ( ! empty($homeID)) {
                 $dataTPL['url.profile'] = $this->makeUrl($homeID);
             }
         } else {
@@ -197,7 +197,7 @@ 
                 'errorCode'  => $errorCode
             );
             $authId = APIHelpers::getkey($params, 'authId');
-            if (!empty($authId)) {
+            if ( ! empty($authId)) {
                 $dataTPL['authPage'] = $this->makeUrl($authId);
                 $dataTPL['method'] = strtolower(__CLASS__ . '::' . 'authpage');
             }
@@ -231,7 +231,7 @@ 
         if ($request === false) {
             $request = array();
         }
-        if (!empty($_SERVER['HTTP_REFERER'])) {
+        if ( ! empty($_SERVER['HTTP_REFERER'])) {
             /**
              * Thank you for super protection against hacking in protect.inc.php:-)
              */
@@ -242,7 +242,7 @@ 
 
         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
             $backUrl = APIHelpers::getkey($_POST, 'backUrl', $POST['backUrl']);
-            if (!is_scalar($backUrl)) {
+            if ( ! is_scalar($backUrl)) {
                 $backUrl = $refer;
             } else {
                 $backUrl = urldecode($backUrl);
@@ -254,12 +254,12 @@ 
         if ($backUrl === false) {
             $backUrl = array();
         }
-        if (!empty($backUrl['path']) && $request['path'] != $backUrl['path']) {
+        if ( ! empty($backUrl['path']) && $request['path'] != $backUrl['path']) {
             $POST['backUrl'] = $backUrl['path'];
         } else {
             $POST['backUrl'] = $this->getBackUrl($backUrl);
         }
-        if (!empty($POST['backUrl'])) {
+        if ( ! empty($POST['backUrl'])) {
             $idURL = $this->moveTo(array(
                 'url'      => '/' . ltrim($POST['backUrl'], '/'),
                 'validate' => true
@@ -295,8 +295,8 @@ 
     {
         $selfHost = rtrim(str_replace("http://", "", $this->config['site_url']), '/');
         if (empty($request['host']) || $request['host'] == $selfHost) {
-            $query = !empty($request['query']) ? '?' . $request['query'] : '';
-            $out = !empty($request['path']) ? $request['path'] . $query : '';
+            $query = ! empty($request['query']) ? '?' . $request['query'] : '';
+            $out = ! empty($request['path']) ? $request['path'] . $query : '';
         } else {
             $out = '';
         }
@@ -335,7 +335,7 @@ 
                 'email'    => APIHelpers::getkey($_POST, $emailField, ''),
                 'remember' => (bool)((int)APIHelpers::getkey($_POST, $rememberField, 0))
             ));
-            if (!empty($POST['email']) && is_scalar($POST['email']) && !$userObj->emailValidate($POST['email'],
+            if ( ! empty($POST['email']) && is_scalar($POST['email']) && ! $userObj->emailValidate($POST['email'],
                     false)
             ) {
                 $userObj->edit($POST['email']);
@@ -346,7 +346,7 @@ 
                     "rememberme"   => $POST['remember'],
                     'userObj'      => $userObj
                 ));
-                if ($userObj->getID() && !$userObj->checkBlock($userObj->getID())) {
+                if ($userObj->getID() && ! $userObj->checkBlock($userObj->getID())) {
                     $pluginFlag = $this->modx->invokeEvent("OnWebAuthentication", array(
                         "userid"        => $userObj->getID(),
                         "username"      => $userObj->get('username'),
@@ -385,7 +385,7 @@ 
                 $POST['email'] = '';
             }
         }
-        if (!empty($error)) {
+        if ( ! empty($error)) {
             $errorCode = $error;
             $error = APIHelpers::getkey($params, $error, '');
             $error = static::getLangMsg($error, $error);
@@ -434,7 +434,7 @@ 
      */
     public function isGuestGoHome($params)
     {
-        if (!$this->UserID('web')) {
+        if ( ! $this->UserID('web')) {
             /**
              * @see : http://modx.im/blog/triks/105.html
              */
@@ -470,7 +470,7 @@ 
     {
         $id = (int)APIHelpers::getkey($params, 'id', 0);
         $uri = APIHelpers::getkey($params, 'url', '');
-        if ((empty($uri) && !empty($id)) || !is_string($uri)) {
+        if ((empty($uri) && ! empty($id)) || ! is_string($uri)) {
             $uri = $this->makeUrl($id);
         }
         $code = (int)APIHelpers::getkey($params, 'code', 0);
@@ -538,10 +538,10 @@ 
     protected static function loadLang($lang)
     {
         $file = dirname(dirname(__FILE__)) . '/lang/' . $lang . '.php';
-        if (!FS::getInstance()->checkFile($file)) {
+        if ( ! FS::getInstance()->checkFile($file)) {
             $file = false;
         }
-        if (!empty($lang) && !isset(static::$langDic[$lang]) && !empty($file)) {
+        if ( ! empty($lang) && ! isset(static::$langDic[$lang]) && ! empty($file)) {
             static::$langDic[$lang] = include_once($file);
             if (is_array(static::$langDic[$lang])) {
                 static::$langDic[$lang] = APIHelpers::renameKeyArr(static::$langDic[$lang], $lang);
@@ -550,7 +550,7 @@ 
             }
         }
 
-        return !(empty($lang) || empty(static::$langDic[$lang]));
+        return ! (empty($lang) || empty(static::$langDic[$lang]));
     }
 
     /**
@@ -568,7 +568,7 @@ 
         }
         if (class_exists('evoBabel', false) && isset(self::$instance->modx->snippetCache['lang'])) {
             $msg = self::$instance->modx->runSnippet('lang', array('a' => 'DLUsers.' . $key));
-            if (!empty($msg)) {
+            if ( ! empty($msg)) {
                 $out = $msg;
             }
         }

Braces +103 added lines, -103 removed lines

@@ -13,8 +13,8 @@ 
  * Class Actions
  * @package DLUsers
  */
-class Actions
-{
+class Actions

+{

     /**
      * Объект DocumentParser - основной класс MODX
      * @var \DocumentParser
@@ -40,10 +40,10 @@ 
      *
      * @return self
      */
-    public static function getInstance(DocumentParser $modx, $lang, $userClass = 'modUsers', $debug = false)
-    {
+    public static function getInstance(DocumentParser $modx, $lang, $userClass = 'modUsers', $debug = false)

+    {

 
-        if (null === self::$instance) {
+        if (null === self::$instance) {

             self::$instance = new self($modx, $userClass, $debug);
         }
 
@@ -57,8 +57,8 @@ 
      * is not allowed to call from outside: private!
      *
      */
-    private function __construct(DocumentParser $modx, $userClass, $debug)
-    {
+    private function __construct(DocumentParser $modx, $userClass, $debug)

+    {

         $this->modx = $modx;
         $this->userObj = new $userClass($this->modx, $debug);
         $this->url = new DLCollection($this->modx);
@@ -76,8 +76,8 @@ 
      *
      * @return void
      */
-    private function __clone()
-    {
+    private function __clone()

+    {

 
     }
 
@@ -86,23 +86,23 @@ 
      *
      * @return void
      */
-    private function __wakeup()
-    {
+    private function __wakeup()

+    {

 
     }
 
     /**
      * Сброс авторизации и обновление страницы
      */
-    public function logout($params)
-    {
+    public function logout($params)

+    {

         $LogoutName = APIHelpers::getkey($params, 'LogoutName', 'logout');
-        if (is_scalar($LogoutName) && !empty($LogoutName) && isset($_GET[$LogoutName])) {
+        if (is_scalar($LogoutName) && !empty($LogoutName) && isset($_GET[$LogoutName])) {

             $userID = $this->UserID('web');
-            if ($userID) {
+            if ($userID) {

                 $this->userObj->edit($userID);
                 $params = array();
-                if ($this->userObj->getID()) {
+                if ($this->userObj->getID()) {

                     $params = array(
                         "userid"   => $this->userObj->getID(),
                         "username" => $this->userObj->get('username')
@@ -110,12 +110,12 @@ 
                     $this->modx->invokeEvent("OnBeforeWebLogout", $params);
                 }
                 $this->userObj->logOut();
-                if ($this->userObj->getID()) {
+                if ($this->userObj->getID()) {

                     $this->modx->invokeEvent("OnWebLogout", $params);
                 }
 
                 $go = APIHelpers::getkey($params, 'url', '');
-                if (empty($go)) {
+                if (empty($go)) {

                     $go = str_replace(
                         array("?" . $LogoutName, "&" . $LogoutName),
                         array("", ""),
@@ -124,13 +124,13 @@ 
                 }
 
                 $start = $this->makeUrl($this->config['site_start']);
-                if ($start == $go) {
+                if ($start == $go) {

                     $go = $this->config['site_url'];
-                } else {
+                } else {

                     $go = $this->config['site_url'] . ltrim($go, '/');
                 }
                 $this->moveTo(array('url' => $go));
-            } else {
+            } else {

                 //Если юзер не авторизован, то показываем ему 404 ошибку
                 $this->modx->sendErrorPage();
             }
@@ -143,8 +143,8 @@ 
      * Генерация ссылки под кнопку выход
      * @return string
      */
-    public function logoutUrl($params)
-    {
+    public function logoutUrl($params)

+    {

         $LogoutName = APIHelpers::getkey($params, 'LogoutName', 'logout');
         $request = parse_url($_SERVER['REQUEST_URI']);
 
@@ -159,8 +159,8 @@ 
      *        если указан параметр authId, то данные из формы перекидываются в метод AuthPage
      *    В противном случае вся работа происходит внутри самого блока
      */
-    public function AuthBlock($params)
-    {
+    public function AuthBlock($params)

+    {

         $POST = array('backUrl' => $_SERVER['REQUEST_URI']);
 
         $error = $errorCode = '';
@@ -169,20 +169,20 @@ 
         $emailField = APIHelpers::getkey($params, 'emailField', 'email');
         $rememberField = APIHelpers::getkey($params, 'rememberField', 'remember');
 
-        if ($this->UserID('web')) {
+        if ($this->UserID('web')) {

             $tpl = APIHelpers::getkey($params, 'tplProfile', '');
-            if (empty($tpl)) {
+            if (empty($tpl)) {

                 $tpl = $this->getTemplate('tplProfile');
             }
             $dataTPL = $this->userObj->toArray();
             $dataTPL['url.logout'] = $this->logoutUrl($params);
             $homeID = APIHelpers::getkey($params, 'homeID');
-            if (!empty($homeID)) {
+            if (!empty($homeID)) {

                 $dataTPL['url.profile'] = $this->makeUrl($homeID);
             }
-        } else {
+        } else {

             $tpl = APIHelpers::getkey($params, 'tplForm', '');
-            if (empty($tpl)) {
+            if (empty($tpl)) {

                 $tpl = $this->getTemplate('authForm');
             }
             $POST = $this->Auth($pwdField, $emailField, $rememberField, $POST['backUrl'], __METHOD__, $error,
@@ -197,7 +197,7 @@ 
                 'errorCode'  => $errorCode
             );
             $authId = APIHelpers::getkey($params, 'authId');
-            if (!empty($authId)) {
+            if (!empty($authId)) {

                 $dataTPL['authPage'] = $this->makeUrl($authId);
                 $dataTPL['method'] = strtolower(__CLASS__ . '::' . 'authpage');
             }
@@ -210,8 +210,8 @@ 
      * Авторизация на сайте со страницы авторизации
      * [!Auth? &login=`password` &pwdField=`password` &homeID=`72`!]
      */
-    public function AuthPage($params)
-    {
+    public function AuthPage($params)

+    {

         $homeID = APIHelpers::getkey($params, 'homeID');
         $this->isAuthGoHome(array('id' => $homeID));
 
@@ -223,52 +223,52 @@ 
         $rememberField = APIHelpers::getkey($params, 'rememberField', 'remember');
 
         $tpl = APIHelpers::getkey($params, 'tpl', '');
-        if (empty($tpl)) {
+        if (empty($tpl)) {

             $tpl = $this->getTemplate('authForm');
         }
 
         $request = parse_url($_SERVER['REQUEST_URI']);
-        if ($request === false) {
+        if ($request === false) {

             $request = array();
         }
-        if (!empty($_SERVER['HTTP_REFERER'])) {
+        if (!empty($_SERVER['HTTP_REFERER'])) {

             /**
              * Thank you for super protection against hacking in protect.inc.php:-)
              */
             $refer = htmlspecialchars_decode($_SERVER['HTTP_REFERER'], ENT_QUOTES);
-        } else {
+        } else {

             $refer = $this->getBackUrl($request);
         }
 
-        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+        if ($_SERVER['REQUEST_METHOD'] == 'POST') {

             $backUrl = APIHelpers::getkey($_POST, 'backUrl', $POST['backUrl']);
-            if (!is_scalar($backUrl)) {
+            if (!is_scalar($backUrl)) {

                 $backUrl = $refer;
-            } else {
+            } else {

                 $backUrl = urldecode($backUrl);
             }
-        } else {
+        } else {

             $backUrl = $refer;
         }
         $backUrl = parse_url($backUrl);
-        if ($backUrl === false) {
+        if ($backUrl === false) {

             $backUrl = array();
         }
-        if (!empty($backUrl['path']) && $request['path'] != $backUrl['path']) {
+        if (!empty($backUrl['path']) && $request['path'] != $backUrl['path']) {

             $POST['backUrl'] = $backUrl['path'];
-        } else {
+        } else {

             $POST['backUrl'] = $this->getBackUrl($backUrl);
         }
-        if (!empty($POST['backUrl'])) {
+        if (!empty($POST['backUrl'])) {

             $idURL = $this->moveTo(array(
                 'url'      => '/' . ltrim($POST['backUrl'], '/'),
                 'validate' => true
             ));
-        } else {
+        } else {

             $idURL = 0;
         }
-        if (empty($idURL)) {
-            if (empty($homeID)) {
+        if (empty($idURL)) {

+            if (empty($homeID)) {

                 $homeID = $this->config['site_start'];
             }
             $POST['backUrl'] = $this->makeUrl($homeID);
@@ -291,13 +291,13 @@ 
      * @param array $request
      * @return string
      */
-    protected function getBackUrl(array $request = array())
-    {
+    protected function getBackUrl(array $request = array())

+    {

         $selfHost = rtrim(str_replace("http://", "", $this->config['site_url']), '/');
-        if (empty($request['host']) || $request['host'] == $selfHost) {
+        if (empty($request['host']) || $request['host'] == $selfHost) {

             $query = !empty($request['query']) ? '?' . $request['query'] : '';
             $out = !empty($request['path']) ? $request['path'] . $query : '';
-        } else {
+        } else {

             $out = '';
         }
 
@@ -324,12 +324,12 @@ 
         &$error,
         &$errorCode,
         $params = array()
-    ) {
+    ) {

         $POST = array(
             'backUrl' => urlencode($backUrl)
         );
         $userObj = &$this->userObj;
-        if ($_SERVER['REQUEST_METHOD'] == 'POST' && APIHelpers::getkey($_POST, 'method', '') == strtolower($method)) {
+        if ($_SERVER['REQUEST_METHOD'] == 'POST' && APIHelpers::getkey($_POST, 'method', '') == strtolower($method)) {

             $POST = array_merge($POST, array(
                 'password' => APIHelpers::getkey($_POST, $pwdField, ''),
                 'email'    => APIHelpers::getkey($_POST, $emailField, ''),
@@ -337,7 +337,7 @@ 
             ));
             if (!empty($POST['email']) && is_scalar($POST['email']) && !$userObj->emailValidate($POST['email'],
                     false)
-            ) {
+            ) {

                 $userObj->edit($POST['email']);
 
                 $this->modx->invokeEvent("OnBeforeWebLogin", array(
@@ -346,7 +346,7 @@ 
                     "rememberme"   => $POST['remember'],
                     'userObj'      => $userObj
                 ));
-                if ($userObj->getID() && !$userObj->checkBlock($userObj->getID())) {
+                if ($userObj->getID() && !$userObj->checkBlock($userObj->getID())) {

                     $pluginFlag = $this->modx->invokeEvent("OnWebAuthentication", array(
                         "userid"        => $userObj->getID(),
                         "username"      => $userObj->get('username'),
@@ -358,7 +358,7 @@ 
                         ($pluginFlag === true || $userObj->testAuth($userObj->getID(), $POST['password'], 0))
                         &&
                         $userObj->authUser($userObj->getID(), $POST['remember'])
-                    ) {
+                    ) {

                         $userObj->set('logincount', (int)$userObj->get('logincount') + 1);
                         $userObj->set('lastlogin', time());
                         $userObj->set('failedlogincount', 0);
@@ -371,21 +371,21 @@ 
                             "rememberme"   => $POST['remember'],
                         ));
                         $this->moveTo(array('url' => urldecode($POST['backUrl'])));
-                    } else {
+                    } else {

                         $userObj->set('failedlogincount', (int)$userObj->get('failedlogincount') + 1);
                         $userObj->save(false, false);
 
                         $error = 'error.incorrect_password';
                     }
-                } else {
+                } else {

                     $error = 'error.no_user';
                 }
-            } else {
+            } else {

                 $error = 'error.incorrect_mail';
                 $POST['email'] = '';
             }
         }
-        if (!empty($error)) {
+        if (!empty($error)) {

             $errorCode = $error;
             $error = APIHelpers::getkey($params, $error, '');
             $error = static::getLangMsg($error, $error);
@@ -398,17 +398,17 @@ 
      * Информация о пользователе
      * [!DLUsers? &action=`UserInfo` &field=`fullname` &id=`2`!]
      */
-    public function UserInfo($params)
-    {
+    public function UserInfo($params)

+    {

         $out = '';
         $userID = APIHelpers::getkey($params, 'id', 0);
-        if (empty($userID)) {
+        if (empty($userID)) {

             $userID = $this->UserID('web');
         }
         $field = APIHelpers::getkey($params, 'field', 'username');
-        if ($userID > 0) {
+        if ($userID > 0) {

             $this->userObj->edit($userID);
-            switch (true) {
+            switch (true) {

                 case ($field == $this->userObj->fieldPKName()):
                     $out = $this->userObj->getID();
                     break;
@@ -424,17 +424,17 @@ 
     /**
      * ID пользователя
      */
-    public function UserID($type = 'web')
-    {
+    public function UserID($type = 'web')

+    {

         return $this->modx->getLoginUserID($type);
     }
 
     /**
      * Если не авторизован - то отправить на страницу
      */
-    public function isGuestGoHome($params)
-    {
-        if (!$this->UserID('web')) {
+    public function isGuestGoHome($params)

+    {

+        if (!$this->UserID('web')) {

             /**
              * @see : http://modx.im/blog/triks/105.html
              */
@@ -449,12 +449,12 @@ 
     /**
      * Если авторизован - то открыть личный кабинет
      */
-    public function isAuthGoHome($params)
-    {
+    public function isAuthGoHome($params)

+    {

         $userID = $this->UserID('web');
-        if ($userID > 0) {
+        if ($userID > 0) {

             $id = APIHelpers::getkey($params, 'homeID');
-            if (empty($id)) {
+            if (empty($id)) {

                 $id = $this->modx->getConfig('login_home', $this->config['site_start']);
             }
             $this->moveTo(compact('id'));
@@ -466,28 +466,28 @@ 
     /**
      * Редирект
      */
-    public function moveTo($params)
-    {
+    public function moveTo($params)

+    {

         $id = (int)APIHelpers::getkey($params, 'id', 0);
         $uri = APIHelpers::getkey($params, 'url', '');
-        if ((empty($uri) && !empty($id)) || !is_string($uri)) {
+        if ((empty($uri) && !empty($id)) || !is_string($uri)) {

             $uri = $this->makeUrl($id);
         }
         $code = (int)APIHelpers::getkey($params, 'code', 0);
         $addUrl = APIHelpers::getkey($params, 'addUrl', '');
-        if (is_scalar($addUrl) && $addUrl != '') {
+        if (is_scalar($addUrl) && $addUrl != '') {

             $uri .= "?" . $addUrl;
         }
-        if (APIHelpers::getkey($params, 'validate', false)) {
-            if (isset($this->modx->snippetCache['getPageID'])) {
+        if (APIHelpers::getkey($params, 'validate', false)) {

+            if (isset($this->modx->snippetCache['getPageID'])) {

                 $out = $this->modx->runSnippet('getPageID', compact('uri'));
-                if (empty($out)) {
+                if (empty($out)) {

                     $uri = '';
                 }
-            } else {
+            } else {

                 $uri = APIhelpers::sanitarTag($uri);
             }
-        } else {
+        } else {

             header("Location: " . $uri, true, ($code > 0 ? $code : 307));
         }
 
@@ -500,15 +500,15 @@ 
      * @param  int $id ID документа
      * @return string
      */
-    protected function makeUrl($id = null)
-    {
+    protected function makeUrl($id = null)

+    {

         $id = (int)$id;
-        if ($id <= 0) {
+        if ($id <= 0) {

             $id = $this->modx->documentObject['id'];
         }
-        if ($this->url->containsKey($id)) {
+        if ($this->url->containsKey($id)) {

             $url = $this->url->get($id);
-        } else {
+        } else {

             $url = $this->modx->makeUrl($id);
             $this->url->set($id, $url);
         }
@@ -520,11 +520,11 @@ 
      * @param $name
      * @return string
      */
-    protected function getTemplate($name)
-    {
+    protected function getTemplate($name)

+    {

         $out = '';
         $file = dirname(dirname(__FILE__)) . '/tpl/' . $name . '.html';
-        if (FS::getInstance()->checkFile($file)) {
+        if (FS::getInstance()->checkFile($file)) {

             $out = '@CODE: ' . file_get_contents($file);
         }
 
@@ -535,17 +535,17 @@ 
      * @param $lang
      * @return bool
      */
-    protected static function loadLang($lang)
-    {
+    protected static function loadLang($lang)

+    {

         $file = dirname(dirname(__FILE__)) . '/lang/' . $lang . '.php';
-        if (!FS::getInstance()->checkFile($file)) {
+        if (!FS::getInstance()->checkFile($file)) {

             $file = false;
         }
-        if (!empty($lang) && !isset(static::$langDic[$lang]) && !empty($file)) {
+        if (!empty($lang) && !isset(static::$langDic[$lang]) && !empty($file)) {

             static::$langDic[$lang] = include_once($file);
-            if (is_array(static::$langDic[$lang])) {
+            if (is_array(static::$langDic[$lang])) {

                 static::$langDic[$lang] = APIHelpers::renameKeyArr(static::$langDic[$lang], $lang);
-            } else {
+            } else {

                 static::$langDic[$lang] = array();
             }
         }
@@ -558,17 +558,17 @@ 
      * @param $default
      * @return string
      */
-    protected static function getLangMsg($key, $default)
-    {
+    protected static function getLangMsg($key, $default)

+    {

         $out = $default;
         $lng = static::$lang;
         $dic = static::$langDic;
-        if (isset($dic[$lng], $dic[$lng][$lng . '.' . $key])) {
+        if (isset($dic[$lng], $dic[$lng][$lng . '.' . $key])) {

             $out = $dic[$lng][$lng . '.' . $key];
         }
-        if (class_exists('evoBabel', false) && isset(self::$instance->modx->snippetCache['lang'])) {
+        if (class_exists('evoBabel', false) && isset(self::$instance->modx->snippetCache['lang'])) {

             $msg = self::$instance->modx->runSnippet('lang', array('a' => 'DLUsers.' . $key));
-            if (!empty($msg)) {
+            if (!empty($msg)) {

                 $out = $msg;
             }
         }

assets/lib/APIHelpers.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -73,7 +73,7 @@ 
      * @license    GNU General Public License (GPL), http://www.gnu.org/copyleft/gpl.html
      * @param string $email проверяемый email
      * @param boolean $dns проверять ли DNS записи
-     * @return boolean Результат проверки почтового ящика
+     * @return false|string Результат проверки почтового ящика
      * @author Anton Shevchuk
      */
     public static function emailValidate($email, $dns = true)
@@ -146,7 +146,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param string $data
      * @return bool|false|string
      */
     private function _getEnv($data)

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
     {
         if (filter_var($email, FILTER_VALIDATE_EMAIL)) {
             list(, $domain) = explode("@", $email, 2);
-            if (!$dns || ($dns && checkdnsrr($domain, "MX") && checkdnsrr($domain, "A"))) {
+            if ( ! $dns || ($dns && checkdnsrr($domain, "MX") && checkdnsrr($domain, "A"))) {
                 $error = false;
             } else {
                 $error = 'dns';
@@ -218,7 +218,7 @@ 
             case ($tmp = self::_getEnv('HTTP_X_FORWARDED_FOR')):
                 $out = $tmp;
                 break;
-            case (!empty($_SERVER['REMOTE_ADDR'])):
+            case ( ! empty($_SERVER['REMOTE_ADDR'])):
                 $out = $_SERVER['REMOTE_ADDR'];
                 break;
             default:
@@ -354,7 +354,7 @@ 
             }
             for ($i = 0; $i < $len; $i++) {
                 $chr = mb_strtoupper(mb_substr($value, $i, 1, 'UTF-8'), 'UTF-8');
-                if (!in_array($chr, $data, true)) {
+                if ( ! in_array($chr, $data, true)) {
                     $flag = false;
                     break;
                 }

Braces +50 added lines, -50 removed lines

@@ -3,16 +3,16 @@ 
 /**
  * Class APIhelpers
  */
-class APIhelpers
-{
+class APIhelpers

+{

     /**
      * Преобразует первый символ в нижний регистр
      * @param $str
      * @param string $encoding - кодировка, по-умолчанию UTF-8
      * @return string
      */
-    public static function mb_lcfirst($str, $encoding = 'UTF-8')
-    {
+    public static function mb_lcfirst($str, $encoding = 'UTF-8')

+    {

         return mb_strtolower(mb_substr($str, 0, 1, $encoding), $encoding) . mb_substr($str, 1, mb_strlen($str),
             $encoding);
     }
@@ -23,8 +23,8 @@ 
      * @param string $encoding - кодировка, по-умолчанию UTF-8
      * @return string
      */
-    public static function mb_ucfirst($str, $encoding = 'UTF-8')
-    {
+    public static function mb_ucfirst($str, $encoding = 'UTF-8')

+    {

         $str = mb_ereg_replace('^[\ ]+', '', $str);
         $str = mb_strtoupper(mb_substr($str, 0, 1, $encoding), $encoding) . mb_substr($str, 1, mb_strlen($str),
                 $encoding);
@@ -43,13 +43,13 @@ 
      * @param string $encoding кодировка
      * @return string
      */
-    public static function mb_trim_word($html, $len, $encoding = 'UTF-8')
-    {
+    public static function mb_trim_word($html, $len, $encoding = 'UTF-8')

+    {

         $text = trim(preg_replace('|\s+|', ' ', strip_tags($html)));
         $text = mb_substr($text, 0, $len + 1, $encoding);
-        if (mb_substr($text, -1, null, $encoding) == ' ') {
+        if (mb_substr($text, -1, null, $encoding) == ' ') {

             $out = trim($text);
-        } else {
+        } else {

             $out = mb_substr($text, 0, mb_strripos($text, ' ', null, $encoding), $encoding);
         }
 
@@ -62,10 +62,10 @@ 
      * @param mixed $default null
      * @return mixed
      */
-    public static function getkey($data, $key, $default = null)
-    {
+    public static function getkey($data, $key, $default = null)

+    {

         $out = $default;
-        if (is_array($data) && (is_int($key) || is_string($key)) && $key !== '' && array_key_exists($key, $data)) {
+        if (is_array($data) && (is_int($key) || is_string($key)) && $key !== '' && array_key_exists($key, $data)) {

             $out = $data[$key];
         }
 
@@ -83,16 +83,16 @@ 
      * @return boolean Результат проверки почтового ящика
      * @author Anton Shevchuk
      */
-    public static function emailValidate($email, $dns = true)
-    {
-        if (filter_var($email, FILTER_VALIDATE_EMAIL)) {
+    public static function emailValidate($email, $dns = true)

+    {

+        if (filter_var($email, FILTER_VALIDATE_EMAIL)) {

             list(, $domain) = explode("@", $email, 2);
-            if (!$dns || ($dns && checkdnsrr($domain, "MX") && checkdnsrr($domain, "A"))) {
+            if (!$dns || ($dns && checkdnsrr($domain, "MX") && checkdnsrr($domain, "A"))) {

                 $error = false;
-            } else {
+            } else {

                 $error = 'dns';
             }
-        } else {
+        } else {

             $error = 'format';
         }
 
@@ -125,16 +125,16 @@ 
      * $this->genPass(20,"."); //AMV,>&?J)v55,(^g}Z06
      * $this->genPass(20,"aaa0aaa.A"); //rtvKja5xb0\KpdiRR1if
      */
-    public static function genPass($len, $data = '')
-    {
-        if ($data == '') {
+    public static function genPass($len, $data = '')

+    {

+        if ($data == '') {

             $data = 'Aa0.';
         }
         $opt = strlen($data);
         $pass = array();
 
-        for ($i = $len; $i > 0; $i--) {
-            switch ($data[rand(0, ($opt - 1))]) {
+        for ($i = $len; $i > 0; $i--) {

+            switch ($data[rand(0, ($opt - 1))]) {

                 case 'A':
                     $tmp = rand(65, 90);
                     break;
@@ -158,9 +158,9 @@ 
      * @param $data
      * @return bool|false|string
      */
-    private function _getEnv($data)
-    {
-        switch (true) {
+    private function _getEnv($data)

+    {

+        switch (true) {

             case (isset($_SERVER[$data])):
                 $out = $_SERVER[$data];
                 break;
@@ -193,10 +193,10 @@ 
      *
      * @see http://stackoverflow.com/questions/5036443/php-how-to-block-proxies-from-my-site
      */
-    public static function getUserIP($default = '127.0.0.1')
-    {
+    public static function getUserIP($default = '127.0.0.1')

+    {

         //Порядок условий зависит от приоритетов
-        switch (true) {
+        switch (true) {

             case ($tmp = self::_getEnv('HTTP_COMING_FROM')):
                 $out = $tmp;
                 break;
@@ -250,8 +250,8 @@ 
             '`'   => '`',
             '%60' => '`'
         )
-    ) {
-        switch (true) {
+    ) {

+        switch (true) {

             case is_scalar($data):
                 $out = str_replace(
                     array_keys($chars),
@@ -261,7 +261,7 @@ 
                 break;
             case is_array($data):
                 $out = $data;
-                foreach ($out as $key => &$val) {
+                foreach ($out as $key => &$val) {

                     $val = self::sanitarTag($val, $charset, $chars);
                 }
                 break;
@@ -277,8 +277,8 @@ 
      * @param string $charset
      * @return string
      */
-    public static function e($text, $charset = 'UTF-8')
-    {
+    public static function e($text, $charset = 'UTF-8')

+    {

         return is_scalar($text) ? htmlspecialchars($text, ENT_QUOTES, $charset, false) : '';
     }
 
@@ -293,17 +293,17 @@ 
      * @param array $mixArray Примесь символов, которые так же могут использоваться в строке
      * @return bool
      */
-    public static function checkString($value, $minLen = 1, $alph = array(), $mixArray = array())
-    {
+    public static function checkString($value, $minLen = 1, $alph = array(), $mixArray = array())

+    {

         $flag = true;
         $len = mb_strlen($value, 'UTF-8');
         $value = trim($value);
-        if (mb_strlen($value, 'UTF-8') == $len) {
+        if (mb_strlen($value, 'UTF-8') == $len) {

             $data = is_array($mixArray) ? $mixArray : array();
             $alph = is_array($alph) ? array_unique($alph) : array();
-            foreach ($alph as $item) {
+            foreach ($alph as $item) {

                 $item = strtolower($item);
-                switch ($item) {
+                switch ($item) {

                     case 'rus':
                         $data = array_merge($data, array(
                             'А',
@@ -343,7 +343,7 @@ 
                         break;
                     case 'num':
                         $tmp = range('0', '9');
-                        foreach ($tmp as $t) {
+                        foreach ($tmp as $t) {

                             $data[] = (string)$t;
                         }
                         break;
@@ -352,15 +352,15 @@ 
                         break;
                 }
             }
-            for ($i = 0; $i < $len; $i++) {
+            for ($i = 0; $i < $len; $i++) {

                 $chr = mb_strtoupper(mb_substr($value, $i, 1, 'UTF-8'), 'UTF-8');
-                if (!in_array($chr, $data, true)) {
+                if (!in_array($chr, $data, true)) {

                     $flag = false;
                     break;
                 }
             }
             $flag = ($flag && $len >= $minLen);
-        } else {
+        } else {

             $flag = false;
         }
 
@@ -377,18 +377,18 @@ 
      * @param string $sep разделитель ключей при склейке многомерных массивов
      * @return array массив с переименованными ключами
      */
-    public static function renameKeyArr($data, $prefix = '', $suffix = '', $addPS = '.', $sep = '.')
-    {
+    public static function renameKeyArr($data, $prefix = '', $suffix = '', $addPS = '.', $sep = '.')

+    {

         $out = array();
-        if ($prefix == '' && $suffix == '') {
+        if ($prefix == '' && $suffix == '') {

             $out = $data;
-        } else {
+        } else {

             $InsertPrefix = ($prefix != '') ? ($prefix . $addPS) : '';
             $InsertSuffix = ($suffix != '') ? ($addPS . $suffix) : '';
-            foreach ($data as $key => $item) {
+            foreach ($data as $key => $item) {

                 $key = $InsertPrefix . $key;
                 $val = null;
-                switch (true) {
+                switch (true) {

                     case is_scalar($item):
                         $val = $item;
                         break;

assets/lib/Formatter/SqlFormatter.php

Doc Comments +2 added lines, -2 removed lines

@@ -330,8 +330,8 @@
     }
 
     /**
-     * @param $string
-     * @return null
+     * @param string $string
+     * @return string|null
      */
     protected static function getQuotedString($string)
     {

Spacing +11 added lines, -11 removed lines

@@ -862,7 +862,7 @@ 
 
         // A reserved word cannot be preceded by a '.'
         // this makes it so in "mytable.from", "from" is not considered a reserved word
-        if (!$previous || !isset($previous[self::TOKEN_VALUE]) || $previous[self::TOKEN_VALUE] !== '.') {
+        if ( ! $previous || ! isset($previous[self::TOKEN_VALUE]) || $previous[self::TOKEN_VALUE] !== '.') {
             $upper = strtoupper($string);
             // Top Level Reserved Word
             if (preg_match('/^(' . self::$regex_reserved_toplevel . ')($|\s|' . self::$regex_boundaries . ')/', $upper,
@@ -1118,7 +1118,7 @@ 
                 $length = 0;
                 for ($j = 1; $j <= 250; $j++) {
                     // Reached end of string
-                    if (!isset($tokens[$i + $j])) {
+                    if ( ! isset($tokens[$i + $j])) {
                         break;
                     }
 
@@ -1156,7 +1156,7 @@ 
                     $return = rtrim($return, ' ');
                 }
 
-                if (!$inline_parentheses) {
+                if ( ! $inline_parentheses) {
                     $increase_block_indent = true;
                     // Add a newline after the parentheses
                     $newline = true;
@@ -1189,7 +1189,7 @@ 
                 }
 
                 // Add a newline before the closing parentheses (if not already added)
-                if (!$added_newline) {
+                if ( ! $added_newline) {
                     $return .= "\n" . str_repeat($tab, $indent_level);
                 }
             } // Top level reserved words start a new line and increase the special indent level
@@ -1206,7 +1206,7 @@ 
                 // Add a newline after the top level reserved word
                 $newline = true;
                 // Add a newline before the top level reserved word (if not already added)
-                if (!$added_newline) {
+                if ( ! $added_newline) {
                     $return .= "\n" . str_repeat($tab, $indent_level);
                 } // If we already added a newline, redo the indentation since it may be different now
                 else {
@@ -1220,14 +1220,14 @@ 
                     $highlighted = preg_replace('/\s+/', ' ', $highlighted);
                 }
                 //if SQL 'LIMIT' clause, start variable to reset newline
-                if ($token[self::TOKEN_VALUE] === 'LIMIT' && !$inline_parentheses) {
+                if ($token[self::TOKEN_VALUE] === 'LIMIT' && ! $inline_parentheses) {
                     $clause_limit = true;
                 }
             } // Checks if we are out of the limit clause
             elseif ($clause_limit && $token[self::TOKEN_VALUE] !== "," && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_NUMBER && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {
                 $clause_limit = false;
             } // Commas start a new line (unless within inline parentheses or SQL 'LIMIT' clause)
-            elseif ($token[self::TOKEN_VALUE] === ',' && !$inline_parentheses) {
+            elseif ($token[self::TOKEN_VALUE] === ',' && ! $inline_parentheses) {
                 //If the previous TOKEN_VALUE is 'LIMIT', resets new line
                 if ($clause_limit === true) {
                     $newline = false;
@@ -1239,7 +1239,7 @@ 
             } // Newline reserved words start a new line
             elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE) {
                 // Add a newline before the reserved word (if not already added)
-                if (!$added_newline) {
+                if ( ! $added_newline) {
                     $return .= "\n" . str_repeat($tab, $indent_level);
                 }
 
@@ -1333,7 +1333,7 @@ 
         foreach ($tokens as $token) {
             // If this is a query separator
             if ($token[self::TOKEN_VALUE] === ';') {
-                if (!$empty) {
+                if ( ! $empty) {
                     $queries[] = $current_query . ';';
                 }
                 $current_query = '';
@@ -1349,7 +1349,7 @@ 
             $current_query .= $token[self::TOKEN_VALUE];
         }
 
-        if (!$empty) {
+        if ( ! $empty) {
             $queries[] = trim($current_query);
         }
 
@@ -1643,7 +1643,7 @@ 
             return $string . "\n";
         } else {
             $string = trim($string);
-            if (!self::$use_pre) {
+            if ( ! self::$use_pre) {
                 return $string;
             }
 

Braces +184 added lines, -182 removed lines

@@ -12,8 +12,8 @@ 
  * @link       http://github.com/jdorn/sql-formatter
  * @version    1.2.18
  */
-class SqlFormatter
-{
+class SqlFormatter

+{

     // Constants for token types
     const TOKEN_TYPE_WHITESPACE = 0;
     const TOKEN_TYPE_WORD = 1;
@@ -732,8 +732,8 @@ 
      * Get stats about the token cache
      * @return Array An array containing the keys 'hits', 'misses', 'entries', and 'size' in bytes
      */
-    public static function getCacheStats()
-    {
+    public static function getCacheStats()

+    {

         return array(
             'hits'    => self::$cache_hits,
             'misses'  => self::$cache_misses,
@@ -745,9 +745,9 @@ 
     /**
      * Stuff that only needs to be done once.  Builds regular expressions and sorts the reserved words.
      */
-    protected static function init()
-    {
-        if (self::$init) {
+    protected static function init()

+    {

+        if (self::$init) {

             return;
         }
 
@@ -779,10 +779,10 @@ 
      *
      * @return Array An associative array containing the type and value of the token.
      */
-    protected static function getNextToken($string, $previous = null)
-    {
+    protected static function getNextToken($string, $previous = null)

+    {

         // Whitespace
-        if (preg_match('/^\s+/', $string, $matches)) {
+        if (preg_match('/^\s+/', $string, $matches)) {

             return array(
                 self::TOKEN_VALUE => $matches[0],
                 self::TOKEN_TYPE  => self::TOKEN_TYPE_WHITESPACE
@@ -790,17 +790,18 @@ 
         }
 
         // Comment
-        if ($string[0] === '#' || (isset($string[1]) && ($string[0] === '-' && $string[1] === '-') || ($string[0] === '/' && $string[1] === '*'))) {
+        if ($string[0] === '#' || (isset($string[1]) && ($string[0] === '-' && $string[1] === '-') || ($string[0] === '/' && $string[1] === '*'))) {

             // Comment until end of line
-            if ($string[0] === '-' || $string[0] === '#') {
+            if ($string[0] === '-' || $string[0] === '#') {

                 $last = strpos($string, "\n");
                 $type = self::TOKEN_TYPE_COMMENT;
-            } else { // Comment until closing comment tag
+            } else {

+// Comment until closing comment tag
                 $last = strpos($string, "*/", 2) + 2;
                 $type = self::TOKEN_TYPE_BLOCK_COMMENT;
             }
 
-            if ($last === false) {
+            if ($last === false) {

                 $last = strlen($string);
             }
 
@@ -811,7 +812,7 @@ 
         }
 
         // Quoted String
-        if ($string[0] === '"' || $string[0] === '\'' || $string[0] === '`' || $string[0] === '[') {
+        if ($string[0] === '"' || $string[0] === '\'' || $string[0] === '`' || $string[0] === '[') {

             $return = array(
                 self::TOKEN_TYPE  => (($string[0] === '`' || $string[0] === '[') ? self::TOKEN_TYPE_BACKTICK_QUOTE : self::TOKEN_TYPE_QUOTE),
                 self::TOKEN_VALUE => self::getQuotedString($string)
@@ -821,31 +822,31 @@ 
         }
 
         // User-defined Variable
-        if (($string[0] === '@' || $string[0] === ':') && isset($string[1])) {
+        if (($string[0] === '@' || $string[0] === ':') && isset($string[1])) {

             $ret = array(
                 self::TOKEN_VALUE => null,
                 self::TOKEN_TYPE  => self::TOKEN_TYPE_VARIABLE
             );
 
             // If the variable name is quoted
-            if ($string[1] === '"' || $string[1] === '\'' || $string[1] === '`') {
+            if ($string[1] === '"' || $string[1] === '\'' || $string[1] === '`') {

                 $ret[self::TOKEN_VALUE] = $string[0] . self::getQuotedString(substr($string, 1));
             } // Non-quoted variable name
-            else {
+            else {

                 preg_match('/^(' . $string[0] . '[a-zA-Z0-9\._\$]+)/', $string, $matches);
-                if ($matches) {
+                if ($matches) {

                     $ret[self::TOKEN_VALUE] = $matches[1];
                 }
             }
 
-            if ($ret[self::TOKEN_VALUE] !== null) {
+            if ($ret[self::TOKEN_VALUE] !== null) {

                 return $ret;
             }
         }
 
         // Number (decimal, binary, or hex)
         if (preg_match('/^([0-9]+(\.[0-9]+)?|0x[0-9a-fA-F]+|0b[01]+)($|\s|"\'`|' . self::$regex_boundaries . ')/',
-            $string, $matches)) {
+            $string, $matches)) {

             return array(
                 self::TOKEN_VALUE => $matches[1],
                 self::TOKEN_TYPE  => self::TOKEN_TYPE_NUMBER
@@ -853,7 +854,7 @@ 
         }
 
         // Boundary Character (punctuation and symbols)
-        if (preg_match('/^(' . self::$regex_boundaries . ')/', $string, $matches)) {
+        if (preg_match('/^(' . self::$regex_boundaries . ')/', $string, $matches)) {

             return array(
                 self::TOKEN_VALUE => $matches[1],
                 self::TOKEN_TYPE  => self::TOKEN_TYPE_BOUNDARY
@@ -862,11 +863,11 @@ 
 
         // A reserved word cannot be preceded by a '.'
         // this makes it so in "mytable.from", "from" is not considered a reserved word
-        if (!$previous || !isset($previous[self::TOKEN_VALUE]) || $previous[self::TOKEN_VALUE] !== '.') {
+        if (!$previous || !isset($previous[self::TOKEN_VALUE]) || $previous[self::TOKEN_VALUE] !== '.') {

             $upper = strtoupper($string);
             // Top Level Reserved Word
             if (preg_match('/^(' . self::$regex_reserved_toplevel . ')($|\s|' . self::$regex_boundaries . ')/', $upper,
-                $matches)) {
+                $matches)) {

                 return array(
                     self::TOKEN_TYPE  => self::TOKEN_TYPE_RESERVED_TOPLEVEL,
                     self::TOKEN_VALUE => substr($string, 0, strlen($matches[1]))
@@ -874,7 +875,7 @@ 
             }
             // Newline Reserved Word
             if (preg_match('/^(' . self::$regex_reserved_newline . ')($|\s|' . self::$regex_boundaries . ')/', $upper,
-                $matches)) {
+                $matches)) {

                 return array(
                     self::TOKEN_TYPE  => self::TOKEN_TYPE_RESERVED_NEWLINE,
                     self::TOKEN_VALUE => substr($string, 0, strlen($matches[1]))
@@ -882,7 +883,7 @@ 
             }
             // Other Reserved Word
             if (preg_match('/^(' . self::$regex_reserved . ')($|\s|' . self::$regex_boundaries . ')/', $upper,
-                $matches)) {
+                $matches)) {

                 return array(
                     self::TOKEN_TYPE  => self::TOKEN_TYPE_RESERVED,
                     self::TOKEN_VALUE => substr($string, 0, strlen($matches[1]))
@@ -894,7 +895,7 @@ 
         // this makes it so "count(" is considered a function, but "count" alone is not
         $upper = strtoupper($string);
         // function
-        if (preg_match('/^(' . self::$regex_function . '[(]|\s|[)])/', $upper, $matches)) {
+        if (preg_match('/^(' . self::$regex_function . '[(]|\s|[)])/', $upper, $matches)) {

             return array(
                 self::TOKEN_TYPE  => self::TOKEN_TYPE_RESERVED,
                 self::TOKEN_VALUE => substr($string, 0, strlen($matches[1]) - 1)
@@ -914,8 +915,8 @@ 
      * @param $string
      * @return null
      */
-    protected static function getQuotedString($string)
-    {
+    protected static function getQuotedString($string)

+    {

         $ret = null;
 
         // This checks for the following patterns:
@@ -924,7 +925,7 @@ 
         // 3. double quoted string using "" or \" to escape
         // 4. single quoted string using '' or \' to escape
         if (preg_match('/^(((`[^`]*($|`))+)|((\[[^\]]*($|\]))(\][^\]]*($|\]))*)|(("[^"\\\\]*(?:\\\\.[^"\\\\]*)*("|$))+)|((\'[^\'\\\\]*(?:\\\\.[^\'\\\\]*)*(\'|$))+))/s',
-            $string, $matches)) {
+            $string, $matches)) {

             $ret = $matches[1];
         }
 
@@ -939,8 +940,8 @@ 
      *
      * @return Array An array of tokens.
      */
-    protected static function tokenize($string)
-    {
+    protected static function tokenize($string)

+    {

         self::init();
 
         $tokens = array();
@@ -953,9 +954,9 @@ 
         $current_length = strlen($string);
 
         // Keep processing the string until it is empty
-        while ($current_length) {
+        while ($current_length) {

             // If the string stopped shrinking, there was a problem
-            if ($old_string_len <= $current_length) {
+            if ($old_string_len <= $current_length) {

                 $tokens[] = array(
                     self::TOKEN_VALUE => $string,
                     self::TOKEN_TYPE  => self::TOKEN_TYPE_ERROR
@@ -966,26 +967,26 @@ 
             $old_string_len = $current_length;
 
             // Determine if we can use caching
-            if ($current_length >= self::$max_cachekey_size) {
+            if ($current_length >= self::$max_cachekey_size) {

                 $cacheKey = substr($string, 0, self::$max_cachekey_size);
-            } else {
+            } else {

                 $cacheKey = false;
             }
 
             // See if the token is already cached
-            if ($cacheKey && isset(self::$token_cache[$cacheKey])) {
+            if ($cacheKey && isset(self::$token_cache[$cacheKey])) {

                 // Retrieve from cache
                 $token = self::$token_cache[$cacheKey];
                 $token_length = strlen($token[self::TOKEN_VALUE]);
                 self::$cache_hits++;
-            } else {
+            } else {

                 // Get the next token and the token type
                 $token = self::getNextToken($string, $token);
                 $token_length = strlen($token[self::TOKEN_VALUE]);
                 self::$cache_misses++;
 
                 // If the token is shorter than the max length, store it in cache
-                if ($cacheKey && $token_length < self::$max_cachekey_size) {
+                if ($cacheKey && $token_length < self::$max_cachekey_size) {

                     self::$token_cache[$cacheKey] = $token;
                 }
             }
@@ -1009,8 +1010,8 @@ 
      *
      * @return String The SQL string with HTML styles and formatting wrapped in a <pre> tag
      */
-    public static function format($string, $highlight = true)
-    {
+    public static function format($string, $highlight = true)

+    {

         // This variable will be populated with formatted html
         $return = '';
 
@@ -1032,47 +1033,48 @@ 
 
         // Remove existing whitespace
         $tokens = array();
-        foreach ($original_tokens as $i => $token) {
-            if ($token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {
+        foreach ($original_tokens as $i => $token) {

+            if ($token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {

                 $token['i'] = $i;
                 $tokens[] = $token;
             }
         }
 
         // Format token by token
-        foreach ($tokens as $i => $token) {
+        foreach ($tokens as $i => $token) {

             // Get highlighted token if doing syntax highlighting
-            if ($highlight) {
+            if ($highlight) {

                 $highlighted = self::highlightToken($token);
-            } else { // If returning raw text
+            } else {

+// If returning raw text
                 $highlighted = $token[self::TOKEN_VALUE];
             }
 
             // If we are increasing the special indent level now
-            if ($increase_special_indent) {
+            if ($increase_special_indent) {

                 $indent_level++;
                 $increase_special_indent = false;
                 array_unshift($indent_types, 'special');
             }
             // If we are increasing the block indent level now
-            if ($increase_block_indent) {
+            if ($increase_block_indent) {

                 $indent_level++;
                 $increase_block_indent = false;
                 array_unshift($indent_types, 'block');
             }
 
             // If we need a new line before the token
-            if ($newline) {
+            if ($newline) {

                 $return .= "\n" . str_repeat($tab, $indent_level);
                 $newline = false;
                 $added_newline = true;
-            } else {
+            } else {

                 $added_newline = false;
             }
 
             // Display comments directly where they appear in the source
-            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {
-                if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {
+            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {

+                if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {

                     $indent = str_repeat($tab, $indent_level);
                     $return .= "\n" . $indent;
                     $highlighted = str_replace("\n", "\n" . $indent, $highlighted);
@@ -1083,12 +1085,12 @@ 
                 continue;
             }
 
-            if ($inline_parentheses) {
+            if ($inline_parentheses) {

                 // End of inline parentheses
-                if ($token[self::TOKEN_VALUE] === ')') {
+                if ($token[self::TOKEN_VALUE] === ')') {

                     $return = rtrim($return, ' ');
 
-                    if ($inline_indented) {
+                    if ($inline_indented) {

                         array_shift($indent_types);
                         $indent_level--;
                         $return .= "\n" . str_repeat($tab, $indent_level);
@@ -1100,8 +1102,8 @@ 
                     continue;
                 }
 
-                if ($token[self::TOKEN_VALUE] === ',') {
-                    if ($inline_count >= 30) {
+                if ($token[self::TOKEN_VALUE] === ',') {

+                    if ($inline_count >= 30) {

                         $inline_count = 0;
                         $newline = true;
                     }
@@ -1111,21 +1113,21 @@ 
             }
 
             // Opening parentheses increase the block indent level and start a new line
-            if ($token[self::TOKEN_VALUE] === '(') {
+            if ($token[self::TOKEN_VALUE] === '(') {

                 // First check if this should be an inline parentheses block
                 // Examples are "NOW()", "COUNT(*)", "int(10)", key(`somecolumn`), DECIMAL(7,2)
                 // Allow up to 3 non-whitespace tokens inside inline parentheses
                 $length = 0;
-                for ($j = 1; $j <= 250; $j++) {
+                for ($j = 1; $j <= 250; $j++) {

                     // Reached end of string
-                    if (!isset($tokens[$i + $j])) {
+                    if (!isset($tokens[$i + $j])) {

                         break;
                     }
 
                     $next = $tokens[$i + $j];
 
                     // Reached closing parentheses, able to inline it
-                    if ($next[self::TOKEN_VALUE] === ')') {
+                    if ($next[self::TOKEN_VALUE] === ')') {

                         $inline_parentheses = true;
                         $inline_count = 0;
                         $inline_indented = false;
@@ -1133,72 +1135,72 @@ 
                     }
 
                     // Reached an invalid token for inline parentheses
-                    if ($next[self::TOKEN_VALUE] === ';' || $next[self::TOKEN_VALUE] === '(') {
+                    if ($next[self::TOKEN_VALUE] === ';' || $next[self::TOKEN_VALUE] === '(') {

                         break;
                     }
 
                     // Reached an invalid token type for inline parentheses
-                    if ($next[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_TOPLEVEL || $next[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE || $next[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $next[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {
+                    if ($next[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_TOPLEVEL || $next[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE || $next[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $next[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {

                         break;
                     }
 
                     $length += strlen($next[self::TOKEN_VALUE]);
                 }
 
-                if ($inline_parentheses && $length > 30) {
+                if ($inline_parentheses && $length > 30) {

                     $increase_block_indent = true;
                     $inline_indented = true;
                     $newline = true;
                 }
 
                 // Take out the preceding space unless there was whitespace there in the original query
-                if (isset($original_tokens[$token['i'] - 1]) && $original_tokens[$token['i'] - 1][self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {
+                if (isset($original_tokens[$token['i'] - 1]) && $original_tokens[$token['i'] - 1][self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {

                     $return = rtrim($return, ' ');
                 }
 
-                if (!$inline_parentheses) {
+                if (!$inline_parentheses) {

                     $increase_block_indent = true;
                     // Add a newline after the parentheses
                     $newline = true;
                 }
 
             } // Closing parentheses decrease the block indent level
-            elseif ($token[self::TOKEN_VALUE] === ')') {
+            elseif ($token[self::TOKEN_VALUE] === ')') {

                 // Remove whitespace before the closing parentheses
                 $return = rtrim($return, ' ');
 
                 $indent_level--;
 
                 // Reset indent level
-                while ($j = array_shift($indent_types)) {
-                    if ($j === 'special') {
+                while ($j = array_shift($indent_types)) {

+                    if ($j === 'special') {

                         $indent_level--;
-                    } else {
+                    } else {

                         break;
                     }
                 }
 
-                if ($indent_level < 0) {
+                if ($indent_level < 0) {

                     // This is an error
                     $indent_level = 0;
 
-                    if ($highlight) {
+                    if ($highlight) {

                         $return .= "\n" . self::highlightError($token[self::TOKEN_VALUE]);
                         continue;
                     }
                 }
 
                 // Add a newline before the closing parentheses (if not already added)
-                if (!$added_newline) {
+                if (!$added_newline) {

                     $return .= "\n" . str_repeat($tab, $indent_level);
                 }
             } // Top level reserved words start a new line and increase the special indent level
-            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_TOPLEVEL) {
+            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_TOPLEVEL) {

                 $increase_special_indent = true;
 
                 // If the last indent type was 'special', decrease the special indent for this round
                 reset($indent_types);
-                if (current($indent_types) === 'special') {
+                if (current($indent_types) === 'special') {

                     $indent_level--;
                     array_shift($indent_types);
                 }
@@ -1206,88 +1208,88 @@ 
                 // Add a newline after the top level reserved word
                 $newline = true;
                 // Add a newline before the top level reserved word (if not already added)
-                if (!$added_newline) {
+                if (!$added_newline) {

                     $return .= "\n" . str_repeat($tab, $indent_level);
                 } // If we already added a newline, redo the indentation since it may be different now
-                else {
+                else {

                     $return = rtrim($return, $tab) . str_repeat($tab, $indent_level);
                 }
 
                 // If the token may have extra whitespace
                 if (strpos($token[self::TOKEN_VALUE], ' ') !== false || strpos($token[self::TOKEN_VALUE],
                         "\n") !== false || strpos($token[self::TOKEN_VALUE], "\t") !== false
-                ) {
+                ) {

                     $highlighted = preg_replace('/\s+/', ' ', $highlighted);
                 }
                 //if SQL 'LIMIT' clause, start variable to reset newline
-                if ($token[self::TOKEN_VALUE] === 'LIMIT' && !$inline_parentheses) {
+                if ($token[self::TOKEN_VALUE] === 'LIMIT' && !$inline_parentheses) {

                     $clause_limit = true;
                 }
             } // Checks if we are out of the limit clause
-            elseif ($clause_limit && $token[self::TOKEN_VALUE] !== "," && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_NUMBER && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {
+            elseif ($clause_limit && $token[self::TOKEN_VALUE] !== "," && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_NUMBER && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {

                 $clause_limit = false;
             } // Commas start a new line (unless within inline parentheses or SQL 'LIMIT' clause)
-            elseif ($token[self::TOKEN_VALUE] === ',' && !$inline_parentheses) {
+            elseif ($token[self::TOKEN_VALUE] === ',' && !$inline_parentheses) {

                 //If the previous TOKEN_VALUE is 'LIMIT', resets new line
-                if ($clause_limit === true) {
+                if ($clause_limit === true) {

                     $newline = false;
                     $clause_limit = false;
                 } // All other cases of commas
-                else {
+                else {

                     $newline = true;
                 }
             } // Newline reserved words start a new line
-            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE) {
+            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE) {

                 // Add a newline before the reserved word (if not already added)
-                if (!$added_newline) {
+                if (!$added_newline) {

                     $return .= "\n" . str_repeat($tab, $indent_level);
                 }
 
                 // If the token may have extra whitespace
                 if (strpos($token[self::TOKEN_VALUE], ' ') !== false || strpos($token[self::TOKEN_VALUE],
                         "\n") !== false || strpos($token[self::TOKEN_VALUE], "\t") !== false
-                ) {
+                ) {

                     $highlighted = preg_replace('/\s+/', ' ', $highlighted);
                 }
             } // Multiple boundary characters in a row should not have spaces between them (not including parentheses)
-            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BOUNDARY) {
-                if (isset($tokens[$i - 1]) && $tokens[$i - 1][self::TOKEN_TYPE] === self::TOKEN_TYPE_BOUNDARY) {
-                    if (isset($original_tokens[$token['i'] - 1]) && $original_tokens[$token['i'] - 1][self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {
+            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BOUNDARY) {

+                if (isset($tokens[$i - 1]) && $tokens[$i - 1][self::TOKEN_TYPE] === self::TOKEN_TYPE_BOUNDARY) {

+                    if (isset($original_tokens[$token['i'] - 1]) && $original_tokens[$token['i'] - 1][self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE) {

                         $return = rtrim($return, ' ');
                     }
                 }
             }
 
             // If the token shouldn't have a space before it
-            if ($token[self::TOKEN_VALUE] === '.' || $token[self::TOKEN_VALUE] === ',' || $token[self::TOKEN_VALUE] === ';') {
+            if ($token[self::TOKEN_VALUE] === '.' || $token[self::TOKEN_VALUE] === ',' || $token[self::TOKEN_VALUE] === ';') {

                 $return = rtrim($return, ' ');
             }
 
             $return .= $highlighted . ' ';
 
             // If the token shouldn't have a space after it
-            if ($token[self::TOKEN_VALUE] === '(' || $token[self::TOKEN_VALUE] === '.') {
+            if ($token[self::TOKEN_VALUE] === '(' || $token[self::TOKEN_VALUE] === '.') {

                 $return = rtrim($return, ' ');
             }
 
             // If this is the "-" of a negative number, it shouldn't have a space after it
-            if ($token[self::TOKEN_VALUE] === '-' && isset($tokens[$i + 1]) && $tokens[$i + 1][self::TOKEN_TYPE] === self::TOKEN_TYPE_NUMBER && isset($tokens[$i - 1])) {
+            if ($token[self::TOKEN_VALUE] === '-' && isset($tokens[$i + 1]) && $tokens[$i + 1][self::TOKEN_TYPE] === self::TOKEN_TYPE_NUMBER && isset($tokens[$i - 1])) {

                 $prev = $tokens[$i - 1][self::TOKEN_TYPE];
-                if ($prev !== self::TOKEN_TYPE_QUOTE && $prev !== self::TOKEN_TYPE_BACKTICK_QUOTE && $prev !== self::TOKEN_TYPE_WORD && $prev !== self::TOKEN_TYPE_NUMBER) {
+                if ($prev !== self::TOKEN_TYPE_QUOTE && $prev !== self::TOKEN_TYPE_BACKTICK_QUOTE && $prev !== self::TOKEN_TYPE_WORD && $prev !== self::TOKEN_TYPE_NUMBER) {

                     $return = rtrim($return, ' ');
                 }
             }
         }
 
         // If there are unmatched parentheses
-        if ($highlight && array_search('block', $indent_types) !== false) {
+        if ($highlight && array_search('block', $indent_types) !== false) {

             $return .= "\n" . self::highlightError("WARNING: unclosed parentheses or section");
         }
 
         // Replace tab characters with the configuration tab character
         $return = trim(str_replace("\t", self::$tab, $return));
 
-        if ($highlight) {
+        if ($highlight) {

             $return = self::output($return);
         }
 
@@ -1301,13 +1303,13 @@ 
      *
      * @return String The SQL string with HTML styles applied
      */
-    public static function highlight($string)
-    {
+    public static function highlight($string)

+    {

         $tokens = self::tokenize($string);
 
         $return = '';
 
-        foreach ($tokens as $token) {
+        foreach ($tokens as $token) {

             $return .= self::highlightToken($token);
         }
 
@@ -1322,18 +1324,18 @@ 
      *
      * @return Array An array of individual query strings without trailing semicolons
      */
-    public static function splitQuery($string)
-    {
+    public static function splitQuery($string)

+    {

         $queries = array();
         $current_query = '';
         $empty = true;
 
         $tokens = self::tokenize($string);
 
-        foreach ($tokens as $token) {
+        foreach ($tokens as $token) {

             // If this is a query separator
-            if ($token[self::TOKEN_VALUE] === ';') {
-                if (!$empty) {
+            if ($token[self::TOKEN_VALUE] === ';') {

+                if (!$empty) {

                     $queries[] = $current_query . ';';
                 }
                 $current_query = '';
@@ -1342,14 +1344,14 @@ 
             }
 
             // If this is a non-empty character
-            if ($token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_COMMENT && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_BLOCK_COMMENT) {
+            if ($token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_WHITESPACE && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_COMMENT && $token[self::TOKEN_TYPE] !== self::TOKEN_TYPE_BLOCK_COMMENT) {

                 $empty = false;
             }
 
             $current_query .= $token[self::TOKEN_VALUE];
         }
 
-        if (!$empty) {
+        if (!$empty) {

             $queries[] = trim($current_query);
         }
 
@@ -1363,15 +1365,15 @@ 
      *
      * @return String The SQL string without comments
      */
-    public static function removeComments($string)
-    {
+    public static function removeComments($string)

+    {

         $result = '';
 
         $tokens = self::tokenize($string);
 
-        foreach ($tokens as $token) {
+        foreach ($tokens as $token) {

             // Skip comment tokens
-            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {
+            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {

                 continue;
             }
 
@@ -1389,32 +1391,32 @@ 
      *
      * @return String The SQL string without comments
      */
-    public static function compress($string)
-    {
+    public static function compress($string)

+    {

         $result = '';
 
         $tokens = self::tokenize($string);
 
         $whitespace = true;
-        foreach ($tokens as $token) {
+        foreach ($tokens as $token) {

             // Skip comment tokens
-            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {
+            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_COMMENT || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_BLOCK_COMMENT) {

                 continue;
             } // Remove extra whitespace in reserved words (e.g "OUTER     JOIN" becomes "OUTER JOIN")
-            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_TOPLEVEL) {
+            elseif ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_NEWLINE || $token[self::TOKEN_TYPE] === self::TOKEN_TYPE_RESERVED_TOPLEVEL) {

                 $token[self::TOKEN_VALUE] = preg_replace('/\s+/', ' ', $token[self::TOKEN_VALUE]);
             }
 
-            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_WHITESPACE) {
+            if ($token[self::TOKEN_TYPE] === self::TOKEN_TYPE_WHITESPACE) {

                 // If the last token was whitespace, don't add another one
-                if ($whitespace) {
+                if ($whitespace) {

                     continue;
-                } else {
+                } else {

                     $whitespace = true;
                     // Convert all whitespace to a single space
                     $token[self::TOKEN_VALUE] = ' ';
                 }
-            } else {
+            } else {

                 $whitespace = false;
             }
 
@@ -1431,39 +1433,39 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightToken($token)
-    {
+    protected static function highlightToken($token)

+    {

         $type = $token[self::TOKEN_TYPE];
 
-        if (self::is_cli()) {
+        if (self::is_cli()) {

             $token = $token[self::TOKEN_VALUE];
-        } else {
-            if (defined('ENT_IGNORE')) {
+        } else {

+            if (defined('ENT_IGNORE')) {

                 $token = htmlentities($token[self::TOKEN_VALUE], ENT_COMPAT | ENT_IGNORE, 'UTF-8');
-            } else {
+            } else {

                 $token = htmlentities($token[self::TOKEN_VALUE], ENT_COMPAT, 'UTF-8');
             }
         }
 
-        if ($type === self::TOKEN_TYPE_BOUNDARY) {
+        if ($type === self::TOKEN_TYPE_BOUNDARY) {

             return self::highlightBoundary($token);
-        } elseif ($type === self::TOKEN_TYPE_WORD) {
+        } elseif ($type === self::TOKEN_TYPE_WORD) {

             return self::highlightWord($token);
-        } elseif ($type === self::TOKEN_TYPE_BACKTICK_QUOTE) {
+        } elseif ($type === self::TOKEN_TYPE_BACKTICK_QUOTE) {

             return self::highlightBacktickQuote($token);
-        } elseif ($type === self::TOKEN_TYPE_QUOTE) {
+        } elseif ($type === self::TOKEN_TYPE_QUOTE) {

             return self::highlightQuote($token);
-        } elseif ($type === self::TOKEN_TYPE_RESERVED) {
+        } elseif ($type === self::TOKEN_TYPE_RESERVED) {

             return self::highlightReservedWord($token);
-        } elseif ($type === self::TOKEN_TYPE_RESERVED_TOPLEVEL) {
+        } elseif ($type === self::TOKEN_TYPE_RESERVED_TOPLEVEL) {

             return self::highlightReservedWord($token);
-        } elseif ($type === self::TOKEN_TYPE_RESERVED_NEWLINE) {
+        } elseif ($type === self::TOKEN_TYPE_RESERVED_NEWLINE) {

             return self::highlightReservedWord($token);
-        } elseif ($type === self::TOKEN_TYPE_NUMBER) {
+        } elseif ($type === self::TOKEN_TYPE_NUMBER) {

             return self::highlightNumber($token);
-        } elseif ($type === self::TOKEN_TYPE_VARIABLE) {
+        } elseif ($type === self::TOKEN_TYPE_VARIABLE) {

             return self::highlightVariable($token);
-        } elseif ($type === self::TOKEN_TYPE_COMMENT || $type === self::TOKEN_TYPE_BLOCK_COMMENT) {
+        } elseif ($type === self::TOKEN_TYPE_COMMENT || $type === self::TOKEN_TYPE_BLOCK_COMMENT) {

             return self::highlightComment($token);
         }
 
@@ -1477,11 +1479,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightQuote($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightQuote($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_quote . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$quote_attributes . '>' . $value . '</span>';
         }
     }
@@ -1493,11 +1495,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightBacktickQuote($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightBacktickQuote($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_backtick_quote . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$backtick_quote_attributes . '>' . $value . '</span>';
         }
     }
@@ -1509,11 +1511,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightReservedWord($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightReservedWord($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_reserved . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$reserved_attributes . '>' . $value . '</span>';
         }
     }
@@ -1525,15 +1527,15 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightBoundary($value)
-    {
-        if ($value === '(' || $value === ')') {
+    protected static function highlightBoundary($value)

+    {

+        if ($value === '(' || $value === ')') {

             return $value;
         }
 
-        if (self::is_cli()) {
+        if (self::is_cli()) {

             return self::$cli_boundary . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$boundary_attributes . '>' . $value . '</span>';
         }
     }
@@ -1545,11 +1547,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightNumber($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightNumber($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_number . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$number_attributes . '>' . $value . '</span>';
         }
     }
@@ -1561,11 +1563,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightError($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightError($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_error . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$error_attributes . '>' . $value . '</span>';
         }
     }
@@ -1577,11 +1579,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightComment($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightComment($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_comment . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$comment_attributes . '>' . $value . '</span>';
         }
     }
@@ -1593,11 +1595,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightWord($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightWord($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_word . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$word_attributes . '>' . $value . '</span>';
         }
     }
@@ -1609,11 +1611,11 @@ 
      *
      * @return String HTML code of the highlighted token.
      */
-    protected static function highlightVariable($value)
-    {
-        if (self::is_cli()) {
+    protected static function highlightVariable($value)

+    {

+        if (self::is_cli()) {

             return self::$cli_variable . $value . "\x1b[0m";
-        } else {
+        } else {

             return '<span ' . self::$variable_attributes . '>' . $value . '</span>';
         }
     }
@@ -1625,8 +1627,8 @@ 
      *
      * @return String The quoted string
      */
-    private static function quote_regex($a)
-    {
+    private static function quote_regex($a)

+    {

         return preg_quote($a, '/');
     }
 
@@ -1637,13 +1639,13 @@ 
      *
      * @return String The quoted string
      */
-    private static function output($string)
-    {
-        if (self::is_cli()) {
+    private static function output($string)

+    {

+        if (self::is_cli()) {

             return $string . "\n";
-        } else {
+        } else {

             $string = trim($string);
-            if (!self::$use_pre) {
+            if (!self::$use_pre) {

                 return $string;
             }
 
@@ -1654,11 +1656,11 @@ 
     /**
      * @return bool
      */
-    private static function is_cli()
-    {
-        if (isset(self::$cli)) {
+    private static function is_cli()

+    {

+        if (isset(self::$cli)) {

             return self::$cli;
-        } else {
+        } else {

             return php_sapi_name() === 'cli';
         }
     }

assets/lib/Helpers/PHPThumb.php

Doc Comments +3 added lines, -3 removed lines

@@ -23,8 +23,8 @@ 
     }
 
     /**
-     * @param $inputFile
-     * @param $outputFile
+     * @param string $inputFile
+     * @param string $outputFile
      * @param $options
      * @return bool
      */
@@ -66,7 +66,7 @@ 
     }
 
     /**
-     * @param $options
+     * @param string $options
      */
     private function setOptions($options) {
         $options = strtr($options, Array("," => "&", "_" => "=", '{' => '[', '}' => ']'));

Braces +17 added lines, -17 removed lines

@@ -7,8 +7,8 @@ 
  * Class PHPThumb
  * @package Helpers
  */
-class PHPThumb
-{
+class PHPThumb

+{

 
     private $thumb = null;
     protected $fs = null;
@@ -17,8 +17,8 @@ 
     /**
      * PHPThumb constructor.
      */
-    public function __construct()
-    {
+    public function __construct()

+    {

         $this->thumb = new \phpthumb();
         $this->fs = FS::getInstance();
     }
@@ -29,16 +29,16 @@ 
      * @param $options
      * @return bool
      */
-    public function create($inputFile, $outputFile, $options)
-    {
+    public function create($inputFile, $outputFile, $options)

+    {

         $this->thumb->sourceFilename = $inputFile;
         $ext = explode('.', $inputFile);
         $ext = str_replace('jpeg', 'jpg', strtolower(array_pop($ext)));
         $options = 'f=' . $ext . '&' . $options;
         $this->setOptions($options);
-        if ($this->thumb->GenerateThumbnail() && $this->thumb->RenderToFile($outputFile)) {
+        if ($this->thumb->GenerateThumbnail() && $this->thumb->RenderToFile($outputFile)) {

             return true;
-        } else {
+        } else {

             $this->debugMessages = implode('<br/>', $this->thumb->debugmessages);
 
             return false;
@@ -49,17 +49,17 @@ 
      * @param $file
      * @param string $type
      */
-    public function optimize($file, $type = 'jpg')
-    {
-        switch ($type) {
+    public function optimize($file, $type = 'jpg')

+    {

+        switch ($type) {

             case 'jpg':
                 $ext = $this->fs->takeFileExt($file);
-                if ($ext == 'jpeg' || $ext == 'jpg') {
+                if ($ext == 'jpeg' || $ext == 'jpg') {

                     $cmd = '/usr/bin/jpegtran -optimize -progressive -copy none -outfile ' . escapeshellarg($file . '_') . ' ' . escapeshellarg($file);
                     exec($cmd, $result, $return_var);
-                    if ($this->fs->fileSize($file) > $this->fs->fileSize($file . '_')) {
+                    if ($this->fs->fileSize($file) > $this->fs->fileSize($file . '_')) {

                         $this->fs->moveFile($file . '_', $file);
-                    } else {
+                    } else {

                         $this->fs->unlink($file . '_');
                     }
                 }
@@ -72,11 +72,11 @@ 
     /**
      * @param $options
      */
-    private function setOptions($options)
-    {
+    private function setOptions($options)

+    {

         $options = strtr($options, Array("," => "&", "_" => "=", '{' => '[', '}' => ']'));
         parse_str($options, $params);
-        foreach ($params as $key => $value) {
+        foreach ($params as $key => $value) {

             $this->thumb->setParameter($key, $value);
         }
     }

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
      */
     private function setOptions($options)
     {
-        $options = strtr($options, Array("," => "&", "_" => "=", '{' => '[', '}' => ']'));
+        $options = strtr($options, array("," => "&", "_" => "=", '{' => '[', '}' => ']'));
         parse_str($options, $params);
         foreach ($params as $key => $value) {
             $this->thumb->setParameter($key, $value);

assets/snippets/DocLister/core/controller/site_content.php

Doc Comments +2 added lines, -2 removed lines

@@ -440,8 +440,8 @@
     }
 
     /**
-     * @param $table
-     * @param $sort
+     * @param string $table
+     * @param string $sort
      * @return array
      */
     protected function injectSortByTV($table, $sort)

Spacing +9 added lines, -9 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('MODX_BASE_PATH')) {
+if ( ! defined('MODX_BASE_PATH')) {
     die('HACK???');
 }
 
@@ -58,7 +58,7 @@ 
         $this->_docs = ($type == 'parents') ? $this->getChildrenList() : $this->getDocList();
         if ($tvlist != '' && count($this->_docs) > 0) {
             $tv = $this->extTV->getTVList(array_keys($this->_docs), $tvlist);
-            if (!is_array($tv)) {
+            if ( ! is_array($tv)) {
                 $tv = array();
             }
             foreach ($tv as $docID => $TVitem) {
@@ -278,7 +278,7 @@ 
 
             $where = "WHERE {$where}";
             $whereArr = array();
-            if (!$this->getCFGDef('showNoPublish', 0)) {
+            if ( ! $this->getCFGDef('showNoPublish', 0)) {
                 $whereArr[] = "c.deleted=0 AND c.published=1";
             }
 
@@ -431,7 +431,7 @@ 
     protected function injectSortByTV($table, $sort)
     {
         $out = $this->getExtender('tv', true, true)->injectSortByTV($table, $sort);
-        if (!is_array($out) || empty($out)) {
+        if ( ! is_array($out) || empty($out)) {
             $out = array($table, $sort);
         }
 
@@ -448,12 +448,12 @@ 
 
         $tmpWhere = $this->getCFGDef('addWhereList', '');
         $tmpWhere = sqlHelper::trimLogicalOp($tmpWhere);
-        if (!empty($tmpWhere)) {
+        if ( ! empty($tmpWhere)) {
             $where[] = $tmpWhere;
         }
 
         $tmpWhere = sqlHelper::trimLogicalOp($this->_filters['where']);
-        if (!empty($tmpWhere)) {
+        if ( ! empty($tmpWhere)) {
             $where[] = $tmpWhere;
         }
 
@@ -486,13 +486,13 @@ 
                 $tmpWhere = "((" . $tmpWhere . ") OR c.id IN({$addDocs}))";
             }
         }
-        if (!empty($tmpWhere)) {
+        if ( ! empty($tmpWhere)) {
             $where[] = $tmpWhere;
         }
-        if (!$this->getCFGDef('showNoPublish', 0)) {
+        if ( ! $this->getCFGDef('showNoPublish', 0)) {
             $where[] = "c.deleted=0 AND c.published=1";
         }
-        if (!empty($where)) {
+        if ( ! empty($where)) {
             $where = "WHERE " . implode(" AND ", $where);
         } else {
             $where = '';

Braces +99 added lines, -99 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('MODX_BASE_PATH')) {
+if (!defined('MODX_BASE_PATH')) {

     die('HACK???');
 }
 
@@ -11,8 +11,8 @@ 
  * @license GNU General Public License (GPL), http://www.gnu.org/copyleft/gpl.html
  * @author Agel_Nash <Agel_Nash@xaker.ru>, kabachello <kabachnik@hotmail.com>
  */
-class site_contentDocLister extends DocLister
-{
+class site_contentDocLister extends DocLister

+{

     /**
      * Экземпляр экстендера TV
      *
@@ -32,8 +32,8 @@ 
      * @param array $cfg
      * @param null $startTime
      */
-    public function __construct($modx, $cfg = array(), $startTime = null)
-    {
+    public function __construct($modx, $cfg = array(), $startTime = null)

+    {

         parent::__construct($modx, $cfg, $startTime);
         $this->extTV = $this->getExtender('tv', true, true);
     }
@@ -41,35 +41,35 @@ 
     /**
      * @absctract
      */
-    public function getDocs($tvlist = '')
-    {
-        if ($tvlist == '') {
+    public function getDocs($tvlist = '')

+    {

+        if ($tvlist == '') {

             $tvlist = $this->getCFGDef('tvList', '');
         }
 
         $this->extTV->getAllTV_Name();
 
-        if ($this->extPaginate = $this->getExtender('paginate')) {
+        if ($this->extPaginate = $this->getExtender('paginate')) {

             $this->extPaginate->init($this);
-        } else {
+        } else {

             $this->setConfig(array('start' => 0));
         }
         $type = $this->getCFGDef('idType', 'parents');
         $this->_docs = ($type == 'parents') ? $this->getChildrenList() : $this->getDocList();
-        if ($tvlist != '' && count($this->_docs) > 0) {
+        if ($tvlist != '' && count($this->_docs) > 0) {

             $tv = $this->extTV->getTVList(array_keys($this->_docs), $tvlist);
-            if (!is_array($tv)) {
+            if (!is_array($tv)) {

                 $tv = array();
             }
-            foreach ($tv as $docID => $TVitem) {
-                if (isset($this->_docs[$docID]) && is_array($this->_docs[$docID])) {
+            foreach ($tv as $docID => $TVitem) {

+                if (isset($this->_docs[$docID]) && is_array($this->_docs[$docID])) {

                     $this->_docs[$docID] = array_merge($this->_docs[$docID], $TVitem);
-                } else {
+                } else {

                     unset($this->_docs[$docID]);
                 }
             }
         }
-        if (1 == $this->getCFGDef('tree', '0')) {
+        if (1 == $this->getCFGDef('tree', '0')) {

             $this->treeBuild('id', 'parent');
         }
 
@@ -80,24 +80,24 @@ 
      * @param string $tpl
      * @return string
      */
-    public function _render($tpl = '')
-    {
+    public function _render($tpl = '')

+    {

         $out = '';
-        if ($tpl == '') {
+        if ($tpl == '') {

             $tpl = $this->getCFGDef('tpl', '@CODE:<a href="[+url+]">[+pagetitle+]</a><br />');
         }
-        if ($tpl != '') {
+        if ($tpl != '') {

             $date = $this->getCFGDef('dateSource', 'pub_date');
 
             $this->toPlaceholders(count($this->_docs), 1, "display"); // [+display+] - сколько показано на странице.
 
             $i = 1;
             $sysPlh = $this->renameKeyArr($this->_plh, $this->getCFGDef("sysKey", "dl"));
-            if (count($this->_docs) > 0) {
+            if (count($this->_docs) > 0) {

                 /**
                  * @var $extUser user_DL_Extender
                  */
-                if ($extUser = $this->getExtender('user')) {
+                if ($extUser = $this->getExtender('user')) {

                     $extUser->init($this, array('fields' => $this->getCFGDef("userFields", "")));
                 }
 
@@ -116,20 +116,20 @@ 
                  */
                 $extJotCount = $this->getCFGdef('jotcount', 0) ? $this->getExtender('jotcount', true) : null;
 
-                if ($extJotCount) {
+                if ($extJotCount) {

                     $comments = $extJotCount->countComments(array_keys($this->_docs));
                 }
 
                 $this->skippedDocs = 0;
-                foreach ($this->_docs as $item) {
+                foreach ($this->_docs as $item) {

                     $this->renderTPL = $tpl;
-                    if ($extUser) {
+                    if ($extUser) {

                         $item = $extUser->setUserData($item); //[+user.id.createdby+], [+user.fullname.publishedby+], [+dl.user.publishedby+]....
                     }
 
                     $item['summary'] = $extSummary ? $this->getSummary($item, $extSummary, 'introtext', 'content') : '';
 
-                    if ($extJotCount) {
+                    if ($extJotCount) {

                         $item['jotcount'] = APIHelpers::getkey($comments, $item['id'], 0);
                     }
 
@@ -139,53 +139,53 @@ 
 
                     $item['title'] = ($item['menutitle'] == '' ? $item['pagetitle'] : $item['menutitle']);
 
-                    if ($this->getCFGDef('makeUrl', 1)) {
-                        if ($item['type'] == 'reference') {
+                    if ($this->getCFGDef('makeUrl', 1)) {

+                        if ($item['type'] == 'reference') {

                             $item['url'] = is_numeric($item['content']) ? $this->modx->makeUrl($item['content'], '', '',
                                 $this->getCFGDef('urlScheme', '')) : $item['content'];
-                        } else {
+                        } else {

                             $item['url'] = $this->modx->makeUrl($item['id'], '', '', $this->getCFGDef('urlScheme', ''));
                         }
                     }
 
                     $item['date'] = (isset($item[$date]) && $date != 'createdon' && $item[$date] != 0 && $item[$date] == (int)$item[$date]) ? $item[$date] : $item['createdon'];
                     $item['date'] = $item['date'] + $this->modx->config['server_offset_time'];
-                    if ($this->getCFGDef('dateFormat', '%d.%b.%y %H:%M') != '') {
+                    if ($this->getCFGDef('dateFormat', '%d.%b.%y %H:%M') != '') {

                         $item['date'] = strftime($this->getCFGDef('dateFormat', '%d.%b.%y %H:%M'), $item['date']);
                     }
 
                     $findTpl = $this->renderTPL;
                     $tmp = $this->uniformPrepare($item, $i);
                     extract($tmp, EXTR_SKIP);
-                    if ($this->renderTPL == '') {
+                    if ($this->renderTPL == '') {

                         $this->renderTPL = $findTpl;
                     }
 
-                    if ($extPrepare) {
+                    if ($extPrepare) {

                         $item = $extPrepare->init($this, array(
                             'data'      => $item,
                             'nameParam' => 'prepare'
                         ));
-                        if (is_bool($item) && $item === false) {
+                        if (is_bool($item) && $item === false) {

                             $this->skippedDocs++;
                             continue;
                         }
                     }
                     $tmp = $this->parseChunk($this->renderTPL, $item);
 
-                    if ($this->getCFGDef('contentPlaceholder', 0) !== 0) {
+                    if ($this->getCFGDef('contentPlaceholder', 0) !== 0) {

                         $this->toPlaceholders($tmp, 1,
                             "item[" . $i . "]"); // [+item[x]+] – individual placeholder for each iteration documents on this page
                     }
                     $out .= $tmp;
                     $i++;
                 }
-            } else {
+            } else {

                 $noneTPL = $this->getCFGDef("noneTPL", "");
                 $out = ($noneTPL != '') ? $this->parseChunk($noneTPL, $sysPlh) : '';
             }
             $out = $this->renderWrap($out);
-        } else {
+        } else {

             $out = 'no template';
         }
 
@@ -198,8 +198,8 @@ 
      * @param array $array
      * @return string
      */
-    public function getJSON($data, $fields, $array = array())
-    {
+    public function getJSON($data, $fields, $array = array())

+    {

         $out = array();
         $fields = is_array($fields) ? $fields : explode(",", $fields);
         $date = $this->getCFGDef('dateSource', 'pub_date');
@@ -219,38 +219,38 @@ 
          */
         $extE = $this->getExtender('e', true, true);
 
-        foreach ($data as $num => $item) {
+        foreach ($data as $num => $item) {

             $row = $item;
-            if ((array('1') == $fields || in_array('summary', $fields)) && $extSummary) {
+            if ((array('1') == $fields || in_array('summary', $fields)) && $extSummary) {

                 $row['summary'] = $this->getSummary($this->_docs[$num], $extSummary, 'introtext', 'content');
             }
-            if (array('1') == $fields || in_array('date', $fields)) {
+            if (array('1') == $fields || in_array('date', $fields)) {

                 $tmp = (isset($this->_docs[$num][$date]) && $date != 'createdon' && $this->_docs[$num][$date] != 0 && $this->_docs[$num][$date] == (int)$this->_docs[$num][$date]) ? $this->_docs[$num][$date] : $this->_docs[$num]['createdon'];
                 $row['date'] = strftime($this->getCFGDef('dateFormat', '%d.%b.%y %H:%M'),
                     $tmp + $this->modx->config['server_offset_time']);
             }
-            if (array('1') == $fields || in_array(array('menutitle', 'pagetitle'), $fields)) {
+            if (array('1') == $fields || in_array(array('menutitle', 'pagetitle'), $fields)) {

                 $row['title'] = ($row['menutitle'] == '' ? $row['pagetitle'] : $row['menutitle']);
             }
             if ((bool)$this->getCFGDef('makeUrl', 1) && (array('1') == $fields || in_array(array('content', 'type'),
                         $fields))
-            ) {
-                if ($row['type'] == 'reference') {
+            ) {

+                if ($row['type'] == 'reference') {

                     $row['url'] = is_numeric($row['content']) ? $this->modx->makeUrl($row['content'], '', '',
                         $this->getCFGDef('urlScheme', '')) : $row['content'];
-                } else {
+                } else {

                     $row['url'] = $this->modx->makeUrl($row['id'], '', '', $this->getCFGDef('urlScheme', ''));
                 }
             }
-            if ($extE && $tmp = $extE->init($this, array('data' => $row))) {
-                if (is_array($tmp)) {
+            if ($extE && $tmp = $extE->init($this, array('data' => $row))) {

+                if (is_array($tmp)) {

                     $row = $tmp;
                 }
             }
 
-            if ($extPrepare) {
+            if ($extPrepare) {

                 $row = $extPrepare->init($this, array('data' => $row));
-                if (is_bool($row) && $row === false) {
+                if (is_bool($row) && $row === false) {

                     continue;
                 }
             }
@@ -263,31 +263,31 @@ 
     /**
      * @abstract
      */
-    public function getChildrenCount()
-    {
+    public function getChildrenCount()

+    {

         $out = 0;
         $sanitarInIDs = $this->sanitarIn($this->IDs);
-        if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {
+        if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {

             $where = $this->getCFGDef('addWhereList', '');
             $where = sqlHelper::trimLogicalOp($where);
             $where = ($where ? $where . ' AND ' : '') . $this->_filters['where'];
-            if ($where != '' && $this->_filters['where'] != '') {
+            if ($where != '' && $this->_filters['where'] != '') {

                 $where .= " AND ";
             }
             $where = sqlHelper::trimLogicalOp($where);
 
             $where = "WHERE {$where}";
             $whereArr = array();
-            if (!$this->getCFGDef('showNoPublish', 0)) {
+            if (!$this->getCFGDef('showNoPublish', 0)) {

                 $whereArr[] = "c.deleted=0 AND c.published=1";
             }
 
             $tbl_site_content = $this->getTable('site_content', 'c');
 
-            if ($sanitarInIDs != "''") {
-                switch ($this->getCFGDef('idType', 'parents')) {
+            if ($sanitarInIDs != "''") {

+                switch ($this->getCFGDef('idType', 'parents')) {

                     case 'parents':
-                        switch ($this->getCFGDef('showParent', '0')) {
+                        switch ($this->getCFGDef('showParent', '0')) {

                             case '-1':
                                 $tmpWhere = "c.parent IN (" . $sanitarInIDs . ")";
                                 break;
@@ -299,10 +299,10 @@ 
                                 $tmpWhere = "(c.parent IN ({$sanitarInIDs}) OR c.id IN({$sanitarInIDs}))";
                                 break;
                         }
-                        if (($addDocs = $this->getCFGDef('documents', '')) != '') {
+                        if (($addDocs = $this->getCFGDef('documents', '')) != '') {

                             $addDocs = $this->sanitarIn($this->cleanIDs($addDocs));
                             $whereArr[] = "((" . $tmpWhere . ") OR c.id IN({$addDocs}))";
-                        } else {
+                        } else {

                             $whereArr[] = $tmpWhere;
                         }
 
@@ -315,14 +315,14 @@ 
             $from = $tbl_site_content . " " . $this->_filters['join'];
             $where = sqlHelper::trimLogicalOp($where);
 
-            if (trim($where) != 'WHERE') {
+            if (trim($where) != 'WHERE') {

                 $where .= " AND ";
             }
 
             $where .= implode(" AND ", $whereArr);
             $where = sqlHelper::trimLogicalOp($where);
 
-            if (trim($where) == 'WHERE') {
+            if (trim($where) == 'WHERE') {

                 $where = '';
             }
             $group = $this->getGroupSQL($this->getCFGDef('groupBy', 'c.id'));
@@ -339,11 +339,11 @@ 
     /**
      * @return array
      */
-    protected function getDocList()
-    {
+    protected function getDocList()

+    {

         $out = array();
         $sanitarInIDs = $this->sanitarIn($this->IDs);
-        if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {
+        if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {

             $where = $this->getCFGDef('addWhereList', '');
             $where = sqlHelper::trimLogicalOp($where);
 
@@ -351,21 +351,21 @@ 
             $where = sqlHelper::trimLogicalOp($where);
 
             $tbl_site_content = $this->getTable('site_content', 'c');
-            if ($sanitarInIDs != "''") {
+            if ($sanitarInIDs != "''") {

                 $where .= ($where ? " AND " : "") . "c.id IN ({$sanitarInIDs}) AND";
             }
             $where = sqlHelper::trimLogicalOp($where);
 
-            if ($this->getCFGDef('showNoPublish', 0)) {
-                if ($where != '') {
+            if ($this->getCFGDef('showNoPublish', 0)) {

+                if ($where != '') {

                     $where = "WHERE {$where}";
-                } else {
+                } else {

                     $where = '';
                 }
-            } else {
-                if ($where != '') {
+            } else {

+                if ($where != '') {

                     $where = "WHERE {$where} AND ";
-                } else {
+                } else {

                     $where = "WHERE {$where} ";
                 }
                 $where .= "c.deleted=0 AND c.published=1";
@@ -384,7 +384,7 @@ 
 
             $rows = $this->modx->db->makeArray($rs);
 
-            foreach ($rows as $item) {
+            foreach ($rows as $item) {

                 $out[$item['id']] = $item;
             }
         }
@@ -396,19 +396,19 @@ 
      * @param string $id
      * @return array
      */
-    public function getChildrenFolder($id)
-    {
+    public function getChildrenFolder($id)

+    {

         $where = $this->getCFGDef('addWhereFolder', '');
         $where = sqlHelper::trimLogicalOp($where);
-        if ($where != '') {
+        if ($where != '') {

             $where .= " AND ";
         }
 
         $tbl_site_content = $this->getTable('site_content', 'c');
         $sanitarInIDs = $this->sanitarIn($id);
-        if ($this->getCFGDef('showNoPublish', 0)) {
+        if ($this->getCFGDef('showNoPublish', 0)) {

             $where = "WHERE {$where} c.parent IN ({$sanitarInIDs}) AND c.isfolder=1";
-        } else {
+        } else {

             $where = "WHERE {$where} c.parent IN ({$sanitarInIDs}) AND c.deleted=0 AND c.published=1 AND c.isfolder=1";
         }
 
@@ -416,7 +416,7 @@ 
 
         $rows = $this->modx->db->makeArray($rs);
         $out = array();
-        foreach ($rows as $item) {
+        foreach ($rows as $item) {

             $out[] = $item['id'];
         }
 
@@ -428,10 +428,10 @@ 
      * @param $sort
      * @return array
      */
-    protected function injectSortByTV($table, $sort)
-    {
+    protected function injectSortByTV($table, $sort)

+    {

         $out = $this->getExtender('tv', true, true)->injectSortByTV($table, $sort);
-        if (!is_array($out) || empty($out)) {
+        if (!is_array($out) || empty($out)) {

             $out = array($table, $sort);
         }
 
@@ -441,19 +441,19 @@ 
     /**
      * @return array
      */
-    protected function getChildrenList()
-    {
+    protected function getChildrenList()

+    {

         $where = array();
         $out = array();
 
         $tmpWhere = $this->getCFGDef('addWhereList', '');
         $tmpWhere = sqlHelper::trimLogicalOp($tmpWhere);
-        if (!empty($tmpWhere)) {
+        if (!empty($tmpWhere)) {

             $where[] = $tmpWhere;
         }
 
         $tmpWhere = sqlHelper::trimLogicalOp($this->_filters['where']);
-        if (!empty($tmpWhere)) {
+        if (!empty($tmpWhere)) {

             $where[] = $tmpWhere;
         }
 
@@ -464,8 +464,8 @@ 
         $sanitarInIDs = $this->sanitarIn($this->IDs);
 
         $tmpWhere = null;
-        if ($sanitarInIDs != "''") {
-            switch ($this->getCFGDef('showParent', '0')) {
+        if ($sanitarInIDs != "''") {

+            switch ($this->getCFGDef('showParent', '0')) {

                 case '-1':
                     $tmpWhere = "c.parent IN (" . $sanitarInIDs . ")";
                     break;
@@ -478,29 +478,29 @@ 
                     break;
             }
         }
-        if (($addDocs = $this->getCFGDef('documents', '')) != '') {
+        if (($addDocs = $this->getCFGDef('documents', '')) != '') {

             $addDocs = $this->sanitarIn($this->cleanIDs($addDocs));
-            if (empty($tmpWhere)) {
+            if (empty($tmpWhere)) {

                 $tmpWhere = "c.id IN({$addDocs})";
-            } else {
+            } else {

                 $tmpWhere = "((" . $tmpWhere . ") OR c.id IN({$addDocs}))";
             }
         }
-        if (!empty($tmpWhere)) {
+        if (!empty($tmpWhere)) {

             $where[] = $tmpWhere;
         }
-        if (!$this->getCFGDef('showNoPublish', 0)) {
+        if (!$this->getCFGDef('showNoPublish', 0)) {

             $where[] = "c.deleted=0 AND c.published=1";
         }
-        if (!empty($where)) {
+        if (!empty($where)) {

             $where = "WHERE " . implode(" AND ", $where);
-        } else {
+        } else {

             $where = '';
         }
         $fields = $this->getCFGDef('selectFields', 'c.*');
         $group = $this->getGroupSQL($this->getCFGDef('groupBy', 'c.id'));
 
-        if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {
+        if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {

             $sql = $this->dbQuery("SELECT {$fields} FROM " . $from . " " . $where . " " .
                 $group . " " .
                 $sort . " " .
@@ -509,7 +509,7 @@ 
 
             $rows = $this->modx->db->makeArray($sql);
 
-            foreach ($rows as $item) {
+            foreach ($rows as $item) {

                 $out[$item['id']] = $item;
             }
         }
@@ -522,10 +522,10 @@ 
      * @param string $type
      * @return string
      */
-    public function changeSortType($field, $type)
-    {
+    public function changeSortType($field, $type)

+    {

         $type = trim($type);
-        switch (strtoupper($type)) {
+        switch (strtoupper($type)) {

             case 'TVDATETIME':
                 $field = "STR_TO_DATE(" . $field . ",'%d-%m-%Y %H:%i:%s')";
                 break;

Upper-Lower-Casing +8 added lines, -8 removed lines

@@ -276,7 +276,7 @@ 
             }
             $where = sqlHelper::trimLogicalOp($where);
 
-            $where = "WHERE {$where}";
+            $where = "where {$where}";
             $whereArr = array();
             if (!$this->getCFGDef('showNoPublish', 0)) {
                 $whereArr[] = "c.deleted=0 AND c.published=1";
@@ -358,15 +358,15 @@ 
 
             if ($this->getCFGDef('showNoPublish', 0)) {
                 if ($where != '') {
-                    $where = "WHERE {$where}";
+                    $where = "where {$where}";
                 } else {
                     $where = '';
                 }
             } else {
                 if ($where != '') {
-                    $where = "WHERE {$where} AND ";
+                    $where = "where {$where} AND ";
                 } else {
-                    $where = "WHERE {$where} ";
+                    $where = "where {$where} ";
                 }
                 $where .= "c.deleted=0 AND c.published=1";
             }
@@ -380,7 +380,7 @@ 
 
             $limit = $this->LimitSQL($this->getCFGDef('queryLimit', 0));
 
-            $rs = $this->dbQuery("SELECT {$fields} FROM {$tbl_site_content} {$where} {$group} {$sort} {$limit}");
+            $rs = $this->dbQuery("select {$fields} FROM {$tbl_site_content} {$where} {$group} {$sort} {$limit}");
 
             $rows = $this->modx->db->makeArray($rs);
 
@@ -407,9 +407,9 @@ 
         $tbl_site_content = $this->getTable('site_content', 'c');
         $sanitarInIDs = $this->sanitarIn($id);
         if ($this->getCFGDef('showNoPublish', 0)) {
-            $where = "WHERE {$where} c.parent IN ({$sanitarInIDs}) AND c.isfolder=1";
+            $where = "where {$where} c.parent IN ({$sanitarInIDs}) AND c.isfolder=1";
         } else {
-            $where = "WHERE {$where} c.parent IN ({$sanitarInIDs}) AND c.deleted=0 AND c.published=1 AND c.isfolder=1";
+            $where = "where {$where} c.parent IN ({$sanitarInIDs}) AND c.deleted=0 AND c.published=1 AND c.isfolder=1";
         }
 
         $rs = $this->dbQuery("SELECT id FROM {$tbl_site_content} {$where}");
@@ -501,7 +501,7 @@ 
         $group = $this->getGroupSQL($this->getCFGDef('groupBy', 'c.id'));
 
         if ($sanitarInIDs != "''" || $this->getCFGDef('ignoreEmpty', '0')) {
-            $sql = $this->dbQuery("SELECT {$fields} FROM " . $from . " " . $where . " " .
+            $sql = $this->dbQuery("select {$fields} FROM " . $from . " " . $where . " " .
                 $group . " " .
                 $sort . " " .
                 $this->LimitSQL($this->getCFGDef('queryLimit', 0))

assets/snippets/DocLister/core/extender/prepare.extender.inc

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     private $_store = array();

 

     /**

-     * @param $name

+     * @param string $name

      * @param $val

      */

     public function setStore($name,$val){

@@ -24,7 +24,7 @@ 
     }

 

     /**

-     * @param $name

+     * @param string $name

      * @return mixed

      */

     public function getStore($name){

Spacing +2 added lines, -2 removed lines

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

-if (!defined('MODX_BASE_PATH')) {

+if ( ! defined('MODX_BASE_PATH')) {

     die('HACK???');

 }

 

@@ -59,7 +59,7 @@ 
             $out = $params['data'];

         }

 

-        return (!empty($ret) && is_scalar($ret) && isset($out[$ret])) ? $out[$ret] : $out;

+        return ( ! empty($ret) && is_scalar($ret) && isset($out[$ret])) ? $out[$ret] : $out;

     }

 

     /**

assets/snippets/DocLister/lib/DLpaginate.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -52,7 +52,7 @@ 
     private $pagination;
 
     /**
-     * @param $mode
+     * @param string $mode
      * @param array $config
      * @return $this
      */
@@ -64,7 +64,7 @@ 
 
     #Total items
     /**
-     * @param $value
+     * @param integer $value
      * @return $this
      */
     public function items($value) {
@@ -94,7 +94,7 @@ 
 
     #Current page
     /**
-     * @param $value
+     * @param integer $value
      * @return $this
      */
     public function currentPage($value) {
@@ -238,7 +238,7 @@ 
 
     /**
      * @param $id
-     * @return mixed|string
+     * @return string
      */
     public function get_pagenum_link($id) {
         $flag = (strpos($this->target, '?') === false);
@@ -367,7 +367,7 @@ 
     }
 
     /**
-     * @param $tpl
+     * @param string $tpl
      * @param $num
      * @return mixed
      */

Spacing +5 added lines, -5 removed lines

@@ -251,7 +251,7 @@ 
     public function getOutput()
     {
         $out = '';
-        if (!$this->calculate && $this->calculate() && !empty($this->pagination)) {
+        if ( ! $this->calculate && $this->calculate() && ! empty($this->pagination)) {
             $out = str_replace(array("[+class+]", "[+wrap+]"), array($this->className, $this->pagination),
                     $this->mainTpl) . "\n";
         }
@@ -288,7 +288,7 @@ 
     {
         $flag = (strpos($this->target, '?') === false);
         $value = $this->getPageQuery($id);
-        if ($flag && !empty($this->urlF)) {
+        if ($flag && ! empty($this->urlF)) {
             $out = str_replace($this->urlF, $value, $this->target);
         } else {
             $out = $this->target;
@@ -309,12 +309,12 @@ 
         $this->calculate = true;
         $error = false;
 
-        if (!empty($this->urlF) && is_scalar($this->urlF) && $this->urlF != '%' && strpos($this->target,
+        if ( ! empty($this->urlF) && is_scalar($this->urlF) && $this->urlF != '%' && strpos($this->target,
                 $this->urlF) === false
         ) {
             //Es necesario especificar el comodin para sustituir
             $error = true;
-        } elseif (!empty($this->urlF) && is_scalar($this->urlF) && $this->urlF == '%' && strpos($this->target,
+        } elseif ( ! empty($this->urlF) && is_scalar($this->urlF) && $this->urlF == '%' && strpos($this->target,
                 $this->urlF) === false
         ) {
             $error = true;
@@ -323,7 +323,7 @@ 
         if ($this->total_pages < 0) {
             $error = true;
         }
-        if (!is_int($this->limit)) {
+        if ( ! is_int($this->limit)) {
             $error = true;
         }
         if ($error) {

Braces +74 added lines, -72 removed lines

@@ -3,8 +3,8 @@ 
 /**
  * Class DLpaginate
  */
-class DLpaginate
-{
+class DLpaginate

+{

     /**
      * Script Name: *Digg Style Paginator Class
      * Script URI: http://www.mis-algoritmos.com/2007/05/27/digg-style-pagination-class/
@@ -57,8 +57,8 @@ 
      * @param array $config
      * @return $this
      */
-    public function setMode($mode, array $config = array())
-    {
+    public function setMode($mode, array $config = array())

+    {

         $this->mode = $mode;
         $this->modeConfig = $config;
 
@@ -71,8 +71,8 @@ 
      * @param $value
      * @return $this
      */
-    public function items($value)
-    {
+    public function items($value)

+    {

         $this->total_pages = (int)$value;
 
         return $this;
@@ -84,8 +84,8 @@ 
      * @param $value
      * @return $this
      */
-    public function limit($value)
-    {
+    public function limit($value)

+    {

         $this->limit = (int)$value;
 
         return $this;
@@ -97,8 +97,8 @@ 
      * @param $value
      * @return $this
      */
-    public function target($value)
-    {
+    public function target($value)

+    {

         $this->target = $value;
 
         return $this;
@@ -110,8 +110,8 @@ 
      * @param $value
      * @return $this
      */
-    public function currentPage($value)
-    {
+    public function currentPage($value)

+    {

         $this->page = (int)$value;
 
         return $this;
@@ -123,8 +123,8 @@ 
      * @param $value
      * @return $this
      */
-    public function adjacents($value)
-    {
+    public function adjacents($value)

+    {

         $this->adjacents = (int)$value;
 
         return $this;
@@ -136,8 +136,8 @@ 
      * @param string $value
      * @return $this
      */
-    public function showCounter($value = "")
-    {
+    public function showCounter($value = "")

+    {

         $this->showCounter = ($value === true) ? true : false;
 
         return $this;
@@ -149,8 +149,8 @@ 
      * @param string $value
      * @return $this
      */
-    public function changeClass($value = "")
-    {
+    public function changeClass($value = "")

+    {

         $this->className = $value;
 
         return $this;
@@ -160,8 +160,8 @@ 
      * @param $value
      * @return $this
      */
-    public function mainTpl($value)
-    {
+    public function mainTpl($value)

+    {

         $this->mainTpl = $value;
 
         return $this;
@@ -171,8 +171,8 @@ 
      * @param $value
      * @return $this
      */
-    public function nextLabel($value)
-    {
+    public function nextLabel($value)

+    {

         $this->nextT = $value;
 
         return $this;
@@ -182,8 +182,8 @@ 
      * @param $value
      * @return $this
      */
-    public function nextIcon($value)
-    {
+    public function nextIcon($value)

+    {

         $this->nextI = $value;
 
         return $this;
@@ -193,8 +193,8 @@ 
      * @param $value
      * @return $this
      */
-    public function prevLabel($value)
-    {
+    public function prevLabel($value)

+    {

         $this->prevT = $value;
 
         return $this;
@@ -204,8 +204,8 @@ 
      * @param $value
      * @return $this
      */
-    public function prevIcon($value)
-    {
+    public function prevIcon($value)

+    {

         $this->prevI = $value;
 
         return $this;
@@ -217,8 +217,8 @@ 
      * @param string $value
      * @return $this
      */
-    public function parameterName($value = "")
-    {
+    public function parameterName($value = "")

+    {

         $this->parameterName = $value;
 
         return $this;
@@ -230,9 +230,9 @@ 
      * @param string $value
      * @return $this
      */
-    public function urlFriendly($value = "%")
-    {
-        if (preg_match('/^\s/', $value)) {
+    public function urlFriendly($value = "%")

+    {

+        if (preg_match('/^\s/', $value)) {

             $this->urlF = false;
         }
         $this->urlF = $value;
@@ -240,18 +240,18 @@ 
         return $this;
     }
 
-    public function show()
-    {
+    public function show()

+    {

         echo $this->getOutput();
     }
 
     /**
      * @return string
      */
-    public function getOutput()
-    {
+    public function getOutput()

+    {

         $out = '';
-        if (!$this->calculate && $this->calculate() && !empty($this->pagination)) {
+        if (!$this->calculate && $this->calculate() && !empty($this->pagination)) {

             $out = str_replace(array("[+class+]", "[+wrap+]"), array($this->className, $this->pagination),
                     $this->mainTpl) . "\n";
         }
@@ -263,9 +263,9 @@ 
      * @param $page
      * @return int|mixed
      */
-    protected function getPageQuery($page)
-    {
-        switch ($this->mode) {
+    protected function getPageQuery($page)

+    {

+        switch ($this->mode) {

             case 'offset':
                 $display = isset($this->modeConfig['display']) ? $this->modeConfig['display'] : 0;
                 $out = $display * ($page - 1);
@@ -284,15 +284,15 @@ 
      * @param $id
      * @return mixed|string
      */
-    public function get_pagenum_link($id)
-    {
+    public function get_pagenum_link($id)

+    {

         $flag = (strpos($this->target, '?') === false);
         $value = $this->getPageQuery($id);
-        if ($flag && !empty($this->urlF)) {
+        if ($flag && !empty($this->urlF)) {

             $out = str_replace($this->urlF, $value, $this->target);
-        } else {
+        } else {

             $out = $this->target;
-            if ($id > 1) {
+            if ($id > 1) {

                 $out .= ($flag ? "?" : "&") . $this->parameterName . "=" . $value;
             }
         }
@@ -303,30 +303,30 @@ 
     /**
      * @return bool
      */
-    public function calculate()
-    {
+    public function calculate()

+    {

         $this->pagination = "";
         $this->calculate = true;
         $error = false;
 
         if (!empty($this->urlF) && is_scalar($this->urlF) && $this->urlF != '%' && strpos($this->target,
                 $this->urlF) === false
-        ) {
+        ) {

             //Es necesario especificar el comodin para sustituir
             $error = true;
         } elseif (!empty($this->urlF) && is_scalar($this->urlF) && $this->urlF == '%' && strpos($this->target,
                 $this->urlF) === false
-        ) {
+        ) {

             $error = true;
         }
 
-        if ($this->total_pages < 0) {
+        if ($this->total_pages < 0) {

             $error = true;
         }
-        if (!is_int($this->limit)) {
+        if (!is_int($this->limit)) {

             $error = true;
         }
-        if ($error) {
+        if ($error) {

             return false;
         }
 
@@ -342,26 +342,28 @@ 
                 Now we apply our rules and draw the pagination object.
                 We're actually saving the code to a variable in case we want to draw it more than once.
         */
-        if ($lastpage > 1) {
-            if ($this->page) {
-                if ($this->page > 1) {
+        if ($lastpage > 1) {

+            if ($this->page) {

+                if ($this->page > 1) {

                     $this->pagination .= $this->firstT ? $this->renderItemTPL($this->firstT, 0) : '';
                     $this->pagination .= $this->prevT ? $this->renderItemTPL($this->prevT, $prev) : '';
-                } else {
+                } else {

                     $this->pagination .= $this->firstI ? $this->renderItemTPL($this->firstI, 0) : '';
                     $this->pagination .= $this->prevI ? $this->renderItemTPL($this->prevI, $prev) : '';
                 }
             }
             //pages
-            if ($lastpage < 7 + ($this->adjacents * 2)) { //not enough pages to bother breaking it up
-                for ($counter = 1; $counter <= $lastpage; $counter++) {
+            if ($lastpage < 7 + ($this->adjacents * 2)) {

+//not enough pages to bother breaking it up
+                for ($counter = 1; $counter <= $lastpage; $counter++) {

                     $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                     $this->pagination .= $this->renderItemTPL($tpl, $counter);
                 }
-            } elseif ($lastpage > 5 + ($this->adjacents * 2)) { //enough pages to hide some
+            } elseif ($lastpage > 5 + ($this->adjacents * 2)) {

+//enough pages to hide some
                 //close to beginning; only hide later pages
-                if ($this->page < 1 + ($this->adjacents * 2)) {
-                    for ($counter = 1; $counter < 4 + ($this->adjacents * 2); $counter++) {
+                if ($this->page < 1 + ($this->adjacents * 2)) {

+                    for ($counter = 1; $counter < 4 + ($this->adjacents * 2); $counter++) {

                         $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                         $this->pagination .= $this->renderItemTPL($tpl, $counter);
                     }
@@ -369,12 +371,12 @@ 
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lpm1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lastpage);
                 } //in middle; hide some front and some back
-                elseif ($lastpage - ($this->adjacents * 2) > $this->page && $this->page > ($this->adjacents * 2)) {
+                elseif ($lastpage - ($this->adjacents * 2) > $this->page && $this->page > ($this->adjacents * 2)) {

                     $this->pagination .= $this->renderItemTPL($this->numberT, 1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, 2);
                     $this->pagination .= $this->renderItemTPL($this->dotsT, 3);
 
-                    for ($counter = $this->page - $this->adjacents; $counter <= $this->page + $this->adjacents; $counter++) {
+                    for ($counter = $this->page - $this->adjacents; $counter <= $this->page + $this->adjacents; $counter++) {

                         $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                         $this->pagination .= $this->renderItemTPL($tpl, $counter);
                     }
@@ -382,27 +384,27 @@ 
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lpm1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, $lastpage);
                 } //close to end; only hide early pages
-                else {
+                else {

                     $this->pagination .= $this->renderItemTPL($this->numberT, 1);
                     $this->pagination .= $this->renderItemTPL($this->numberT, 2);
                     $this->pagination .= $this->renderItemTPL($this->dotsT, 3);
 
-                    for ($counter = $lastpage - (2 + ($this->adjacents * 2)); $counter <= $lastpage; $counter++) {
+                    for ($counter = $lastpage - (2 + ($this->adjacents * 2)); $counter <= $lastpage; $counter++) {

                         $tpl = ($counter == $this->page) ? $this->currentT : $this->numberT;
                         $this->pagination .= $this->renderItemTPL($tpl, $counter);
                     }
                 }
             }
-            if ($this->page) {
-                if ($this->page < $counter - 1) {
+            if ($this->page) {

+                if ($this->page < $counter - 1) {

                     $this->pagination .= $this->nextT ? $this->renderItemTPL($this->nextT, $next) : '';
                     $this->pagination .= $this->lastT ? $this->renderItemTPL($this->lastT, $lastpage) : '';
-                } else {
+                } else {

                     $this->pagination .= $this->nextI ? $this->renderItemTPL($this->nextI, $next) : '';
                     $this->pagination .= $this->lastI ? $this->renderItemTPL($this->lastI, $lastpage) : '';
                 }
 
-                if ($this->showCounter) {
+                if ($this->showCounter) {

                     $this->pagination .= "<div class=\"pagination_data\">($this->total_pages Pages)</div>";
                 }
             }
@@ -416,8 +418,8 @@ 
      * @param $num
      * @return mixed
      */
-    protected function renderItemTPL($tpl, $num)
-    {
+    protected function renderItemTPL($tpl, $num)

+    {

         return str_replace(array('[+num+]', '[+link+]'), array($num, $this->get_pagenum_link($num)), $tpl);
     }
 }

assets/snippets/DocLister/lib/DLphx.class.php

Doc Comments +19 added lines, -19 removed lines

@@ -73,7 +73,7 @@ 
     // Parser: Preparation, cleaning and checkup
     /**
      * @param string $template
-     * @return mixed|string
+     * @return string
      */
     public function Parse($template = '')
     {
@@ -221,7 +221,7 @@ 
     // Parser: modifier detection and eXtended processing if needed
     /**
      * @param $input
-     * @param $modifiers
+     * @param string $modifiers
      * @return mixed|null|string
      */
     public function Filter($input, $modifiers)
@@ -553,8 +553,8 @@ 
     // positive userid = manager, negative integer = webuser
     /**
      * @param $userid
-     * @param $field
-     * @return mixed
+     * @param string $field
+     * @return string
      */
     public function ModUser($userid, $field)
     {
@@ -609,7 +609,7 @@ 
 
     // Returns the value of a PHx/MODx placeholder.
     /**
-     * @param $name
+     * @param string $name
      * @return mixed
      */
     public function getPHxVariable($name)
@@ -627,8 +627,8 @@ 
 
     // Sets a placeholder variable which can only be access by PHx
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      */
     public function setPHxVariable($name, $value)
     {
@@ -637,9 +637,9 @@ 
 
     //mbstring
     /**
-     * @param $str
-     * @param $s
-     * @param null $l
+     * @param string $str
+     * @param integer $s
+     * @param integer $l
      * @return string
      */
     public function substr($str, $s, $l = null)
@@ -649,7 +649,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return int
      */
     public function strlen($str)
@@ -659,7 +659,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function strtolower($str)
@@ -669,7 +669,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function strtoupper($str)
@@ -679,7 +679,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function ucfirst($str)
@@ -690,7 +690,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function lcfirst($str)
@@ -701,7 +701,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function ucwords($str)
@@ -712,7 +712,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function strrev($str)
@@ -722,7 +722,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return string
      */
     public function str_shuffle($str)
@@ -733,7 +733,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return int
      */
     public function str_word_count($str)

Braces +119 added lines, -117 removed lines

@@ -15,8 +15,8 @@ 
 /**
  * Class DLphx
  */
-class DLphx
-{
+class DLphx

+{

     public $placeholders = array();
     public $name = 'PHx';
     public $version = '2.2.0';
@@ -43,8 +43,8 @@ 
      * @param int $debug
      * @param int $maxpass
      */
-    public function __construct($debug = 0, $maxpass = 50)
-    {
+    public function __construct($debug = 0, $maxpass = 50)

+    {

         global $modx;
         $this->user["mgrid"] = isset($_SESSION['mgrInternalKey']) ? intval($_SESSION['mgrInternalKey']) : 0;
         $this->user["usrid"] = isset($_SESSION['webInternalKey']) ? intval($_SESSION['webInternalKey']) : 0;
@@ -55,14 +55,14 @@ 
         $this->maxPasses = ($maxpass != '') ? $maxpass : 50;
 
         $modx->setPlaceholder("phx", "&_PHX_INTERNAL_&");
-        if (function_exists('mb_internal_encoding')) {
+        if (function_exists('mb_internal_encoding')) {

             mb_internal_encoding($modx->config['modx_charset']);
         }
     }
 
     // Plugin event hook for MODx
-    public function OnParseDocument()
-    {
+    public function OnParseDocument()

+    {

         global $modx;
         // Get document output from MODx
         $template = $modx->documentOutput;
@@ -77,11 +77,11 @@ 
      * @param string $template
      * @return mixed|string
      */
-    public function Parse($template = '')
-    {
+    public function Parse($template = '')

+    {

         global $modx;
         // If we already reached max passes don't get at it again.
-        if ($this->curPass == $this->maxPasses) {
+        if ($this->curPass == $this->maxPasses) {

             return $template;
         }
         // Set template pre-process hash
@@ -92,7 +92,7 @@ 
         $template = $this->ParseValues($template);
         // clean up unused placeholders that have modifiers attached (MODx can't clean them)
         preg_match_all('~(?:=`[^`@]*?)(\[\+([^:\+\[\]]+)([^\[\]]*?)\+\])~s', $template, $matches);
-        if ($matches[0]) {
+        if ($matches[0]) {

             $template = str_replace($matches[1], '', $template);
             $this->Log("Cleaning unsolved tags: \n" . implode("\n", $matches[2]));
         }
@@ -101,11 +101,11 @@ 
         // Set template post-process hash
         $et = md5($template);
         // If template has changed, parse it once more...
-        if ($st != $et) {
+        if ($st != $et) {

             $template = $this->Parse($template);
         }
         // Write an event log if debugging is enabled and there is something to log
-        if ($this->debug && $this->debugLog) {
+        if ($this->debug && $this->debugLog) {

             $modx->logEvent($this->curPass, 1, $this->createEventLog(), $this->name . ' ' . $this->version);
             $this->debugLog = false;
         }
@@ -119,8 +119,8 @@ 
      * @param string $template
      * @return mixed|string
      */
-    public function ParseValues($template = '')
-    {
+    public function ParseValues($template = '')

+    {

         global $modx;
 
         $this->curPass = $this->curPass + 1;
@@ -129,12 +129,12 @@ 
         $this->LogPass();
 
         // MODX Chunks
-        if (preg_match_all('~(?<!(?:then|else)=`){{([^:\+{}]+)([^{}]*?)}}~s', $template, $matches)) {
+        if (preg_match_all('~(?<!(?:then|else)=`){{([^:\+{}]+)([^{}]*?)}}~s', $template, $matches)) {

             $this->Log('MODX Chunks -> Merging all chunk tags');
             $count = count($matches[0]);
             $var_search = array();
             $var_replace = array();
-            for ($i = 0; $i < $count; $i++) {
+            for ($i = 0; $i < $count; $i++) {

                 $var_search[] = $matches[0][$i];
                 $input = $matches[1][$i];
                 $this->Log('MODX Chunk: ' . $input);
@@ -146,13 +146,13 @@ 
 
         // MODx Snippets
         //if ( preg_match_all('~\[(\[|!)([^\[]*?)(!|\])\]~s',$template, $matches)) {
-        if (preg_match_all('~(?<!(?:then|else)=`)\[(\[)([^\[]*?)(\])\]~s', $template, $matches)) {
+        if (preg_match_all('~(?<!(?:then|else)=`)\[(\[)([^\[]*?)(\])\]~s', $template, $matches)) {

             $count = count($matches[0]);
             $var_search = array();
             $var_replace = array();
 
             // for each detected snippet
-            for ($i = 0; $i < $count; $i++) {
+            for ($i = 0; $i < $count; $i++) {

                 $snippet = $matches[2][$i]; // snippet call
                 $this->Log("MODx Snippet -> " . $snippet);
 
@@ -168,7 +168,7 @@ 
         }
 
         // PHx / MODx Tags
-        if (preg_match_all('~\[(\+|\*|\()([^:\+\[\]]+)([^\[\]]*?)(\1|\))\]~s', $template, $matches)) {
+        if (preg_match_all('~\[(\+|\*|\()([^:\+\[\]]+)([^\[\]]*?)(\1|\))\]~s', $template, $matches)) {

 
             //$matches[0] // Complete string that's need to be replaced
             //$matches[1] // Type
@@ -179,11 +179,11 @@ 
             $count = count($matches[0]);
             $var_search = array();
             $var_replace = array();
-            for ($i = 0; $i < $count; $i++) {
+            for ($i = 0; $i < $count; $i++) {

                 $input = $matches[2][$i];
                 $modifiers = $matches[3][$i];
                 $var_search[] = $matches[0][$i];
-                switch ($matches[1][$i]) {
+                switch ($matches[1][$i]) {

                     // Document / Template Variable eXtended
                     case "*":
                         $this->Log("MODx TV/DV: " . $input);
@@ -202,10 +202,10 @@ 
                         // Check if placeholder is set
                         if (!array_key_exists($input, $this->placeholders) && !array_key_exists($input,
                                 $modx->placeholders)
-                        ) {
+                        ) {

                             // not set so try again later.
                             $input = '';
-                        } else {
+                        } else {

                             // is set, get value and run filter
                             $input = $this->getPHxVariable($input);
                         }
@@ -219,11 +219,11 @@ 
         $et = md5($template); // Post-process template hash
 
         // Log an event if this was the maximum pass
-        if ($this->curPass == $this->maxPasses) {
+        if ($this->curPass == $this->maxPasses) {

             $this->Log("Max passes reached. infinite loop protection so exiting.\n If you need the extra passes set the max passes to the highest count of nested tags in your template.");
         }
         // If this pass is not at maximum passes and the template hash is not the same, get at it again.
-        if (($this->curPass < $this->maxPasses) && ($st != $et)) {
+        if (($this->curPass < $this->maxPasses) && ($st != $et)) {

             $template = $this->ParseValues($template);
         }
 
@@ -236,23 +236,23 @@ 
      * @param $modifiers
      * @return mixed|null|string
      */
-    public function Filter($input, $modifiers)
-    {
+    public function Filter($input, $modifiers)

+    {

         global $modx;
         $output = $input;
         $this->Log("  |--- Input = '" . $output . "'");
-        if (preg_match_all('~:([^:=]+)(?:=`(.*?)`(?=:[^:=]+|$))?~s', $modifiers, $matches)) {
+        if (preg_match_all('~:([^:=]+)(?:=`(.*?)`(?=:[^:=]+|$))?~s', $modifiers, $matches)) {

             $modifier_cmd = $matches[1]; // modifier command
             $modifier_value = $matches[2]; // modifier value
             $count = count($modifier_cmd);
             $condition = array();
-            for ($i = 0; $i < $count; $i++) {
+            for ($i = 0; $i < $count; $i++) {

                 $output = trim($output);
                 $this->Log("  |--- Modifier = '" . $modifier_cmd[$i] . "'");
-                if ($modifier_value[$i] != '') {
+                if ($modifier_value[$i] != '') {

                     $this->Log("  |--- Options = '" . $modifier_value[$i] . "'");
                 }
-                switch ($modifier_cmd[$i]) {
+                switch ($modifier_cmd[$i]) {

                     #####  Conditional Modifiers
                     case "input":
                     case "if":
@@ -294,7 +294,7 @@ 
                     case "ir":
                     case "memberof":
                     case "mo": // Is Member Of  (same as inrole but this one can be stringed as a conditional)
-                        if ($output == "&_PHX_INTERNAL_&") {
+                        if ($output == "&_PHX_INTERNAL_&") {

                             $output = $this->user["id"];
                         }
                         $grps = ($this->strlen($modifier_value[$i]) > 0) ? explode(",", $modifier_value[$i]) : array();
@@ -309,23 +309,23 @@ 
                     case "show":
                         $conditional = implode(' ', $condition);
                         $isvalid = intval(eval("return (" . $conditional . ");"));
-                        if (!$isvalid) {
+                        if (!$isvalid) {

                             $output = null;
                         }
                         break;
                     case "then":
                         $conditional = implode(' ', $condition);
                         $isvalid = intval(eval("return (" . $conditional . ");"));
-                        if ($isvalid) {
+                        if ($isvalid) {

                             $output = $modifier_value[$i];
-                        } else {
+                        } else {

                             $output = null;
                         }
                         break;
                     case "else":
                         $conditional = implode(' ', $condition);
                         $isvalid = intval(eval("return (" . $conditional . ");"));
-                        if (!$isvalid) {
+                        if (!$isvalid) {

                             $output = $modifier_value[$i];
                         }
                         break;
@@ -333,7 +333,7 @@ 
                         $raw = explode("&", $modifier_value[$i]);
                         $map = array();
                         $count = count($raw);
-                        for ($m = 0; $m < $count; $m++) {
+                        for ($m = 0; $m < $count; $m++) {

                             $mi = explode("=", $raw[$m]);
                             $map[$mi[0]] = $mi[1];
                         }
@@ -414,13 +414,13 @@ 
                         $output = eval("return " . $filter . ";");
                         break;
                     case "isnotempty":
-                        if (!empty($output)) {
+                        if (!empty($output)) {

                             $output = $modifier_value[$i];
                         }
                         break;
                     case "isempty":
                     case "ifempty":
-                        if (empty($output)) {
+                        if (empty($output)) {

                             $output = $modifier_value[$i];
                         }
                         break;
@@ -432,12 +432,12 @@ 
                         break;
                     case "set":
                         $c = $i + 1;
-                        if ($count > $c && $modifier_cmd[$c] == "value") {
+                        if ($count > $c && $modifier_cmd[$c] == "value") {

                             $output = preg_replace("~([^a-zA-Z0-9])~", "", $modifier_value[$i]);
                         }
                         break;
                     case "value":
-                        if ($i > 0 && $modifier_cmd[$i - 1] == "set") {
+                        if ($i > 0 && $modifier_cmd[$i - 1] == "set") {

                             $modx->SetPlaceholder("phx." . $output, $modifier_value[$i]);
                         }
                         $output = null;
@@ -446,13 +446,13 @@ 
                         $output = md5($output);
                         break;
                     case "userinfo":
-                        if ($output == "&_PHX_INTERNAL_&") {
+                        if ($output == "&_PHX_INTERNAL_&") {

                             $output = $this->user["id"];
                         }
                         $output = $this->ModUser($output, $modifier_value[$i]);
                         break;
                     case "inrole": // deprecated
-                        if ($output == "&_PHX_INTERNAL_&") {
+                        if ($output == "&_PHX_INTERNAL_&") {

                             $output = $this->user["id"];
                         }
                         $grps = ($this->strlen($modifier_value[$i]) > 0) ? explode(",", $modifier_value[$i]) : array();
@@ -464,19 +464,21 @@ 
                         $snippet = '';
                         // modified by Anton Kuzmin (23.06.2010) //
                         $snippetName = 'phx:' . $modifier_cmd[$i];
-                        if (isset($modx->snippetCache[$snippetName])) {
+                        if (isset($modx->snippetCache[$snippetName])) {

                             $snippet = $modx->snippetCache[$snippetName];
-                        } else { // not in cache so let's check the db
+                        } else {

+// not in cache so let's check the db
                             $sql = "SELECT snippet FROM " . $modx->getFullTableName("site_snippets") . " WHERE " . $modx->getFullTableName("site_snippets") . ".name='" . $modx->db->escape($snippetName) . "';";
                             $result = $modx->dbQuery($sql);
-                            if ($modx->recordCount($result) == 1) {
+                            if ($modx->recordCount($result) == 1) {

                                 $row = $modx->fetchRow($result);
                                 $snippet = $modx->snippetCache[$row['name']] = $row['snippet'];
                                 $this->Log("  |--- DB -> Custom Modifier");
-                            } else {
-                                if ($modx->recordCount($result) == 0) { // If snippet not found, look in the modifiers folder
+                            } else {

+                                if ($modx->recordCount($result) == 0) {

+// If snippet not found, look in the modifiers folder
                                     $filename = $modx->config['rb_base_dir'] . 'plugins/phx/modifiers/' . $modifier_cmd[$i] . '.phx.php';
-                                    if (@file_exists($filename)) {
+                                    if (@file_exists($filename)) {

                                         $file_contents = @file_get_contents($filename);
                                         $file_contents = str_replace('<' . '?php', '', $file_contents);
                                         $file_contents = str_replace('?' . '>', '', $file_contents);
@@ -484,7 +486,7 @@ 
                                         $snippet = $modx->snippetCache[$snippetName] = $file_contents;
                                         $modx->snippetCache[$snippetName . 'Props'] = '';
                                         $this->Log("  |--- File ($filename) -> Custom Modifier");
-                                    } else {
+                                    } else {

                                         $this->Log("  |--- PHX Error:  {$modifier_cmd[$i]} could not be found");
                                     }
                                 }
@@ -493,19 +495,19 @@ 
                         $cm = $snippet;
                         // end //
 
-                        if (!empty($cm)) {
+                        if (!empty($cm)) {

                             ob_start();
                             $options = $modifier_value[$i];
                             $custom = eval($cm);
                             $msg = ob_get_contents();
                             $output = $msg . $custom;
                             ob_end_clean();
-                        } else {
+                        } else {

                             $output = '';
                         }
                         break;
                 }
-                if (count($condition)) {
+                if (count($condition)) {

                     $this->Log("  |--- Condition = '" . $condition[count($condition) - 1] . "'");
                 }
                 $this->Log("  |--- Output = '" . $output . "'");
@@ -519,9 +521,9 @@ 
     /**
      * @return string
      */
-    public function createEventLog()
-    {
-        if (!empty($this->console)) {
+    public function createEventLog()

+    {

+        if (!empty($this->console)) {

             $console = implode("\n", $this->console);
             $this->console = array();
 
@@ -534,8 +536,8 @@ 
      * @param $string
      * @return array|mixed|string
      */
-    public function LogClean($string)
-    {
+    public function LogClean($string)

+    {

         $string = preg_replace("/&amp;(#[0-9]+|[a-z]+);/i", "&$1;", $string);
         $string = APIHelpers::sanitarTag($string);
 
@@ -546,9 +548,9 @@ 
     /**
      * @param $string
      */
-    public function Log($string)
-    {
-        if ($this->debug) {
+    public function Log($string)

+    {

+        if ($this->debug) {

             $this->debugLog = true;
             $this->console[] = (count($this->console) + 1 - $this->curPass) . " [" . strftime("%H:%M:%S",
                     time()) . "] " . $this->LogClean($string);
@@ -559,9 +561,9 @@ 
     /**
      * @param $string
      */
-    public function LogSnippet($string)
-    {
-        if ($this->debug) {
+    public function LogSnippet($string)

+    {

+        if ($this->debug) {

             $this->debugLog = true;
             $this->console[] = (count($this->console) + 1 - $this->curPass) . " [" . strftime("%H:%M:%S",
                     time()) . "] " . "  |--- Returns: <div style='margin: 10px;'>" . $this->LogClean($string) . "</div>";
@@ -569,8 +571,8 @@ 
     }
 
     // Log pass
-    public function LogPass()
-    {
+    public function LogPass()

+    {

         $this->console[] = "<div style='margin: 2px;margin-top: 5px;border-bottom: 1px solid black;'>Pass " . $this->curPass . "</div>";
     }
 
@@ -578,8 +580,8 @@ 
     /**
      * @param $string
      */
-    public function LogSource($string)
-    {
+    public function LogSource($string)

+    {

         $this->console[] = "<div style='margin: 2px;margin-top: 5px;border-bottom: 1px solid black;'>Source:</div>" . $this->LogClean($string);
     }
 
@@ -591,17 +593,17 @@ 
      * @param $field
      * @return mixed
      */
-    public function ModUser($userid, $field)
-    {
+    public function ModUser($userid, $field)

+    {

         global $modx;
-        if (!array_key_exists($userid, $this->cache["ui"])) {
-            if (intval($userid) < 0) {
+        if (!array_key_exists($userid, $this->cache["ui"])) {

+            if (intval($userid) < 0) {

                 $user = $modx->getWebUserInfo(-($userid));
-            } else {
+            } else {

                 $user = $modx->getUserInfo($userid);
             }
             $this->cache["ui"][$userid] = $user;
-        } else {
+        } else {

             $user = $this->cache["ui"][$userid];
         }
 
@@ -614,32 +616,32 @@ 
      * @param array $groupNames
      * @return bool
      */
-    public function isMemberOfWebGroupByUserId($userid = 0, $groupNames = array())
-    {
+    public function isMemberOfWebGroupByUserId($userid = 0, $groupNames = array())

+    {

         global $modx;
 
         // if $groupNames is not an array return false
-        if (!is_array($groupNames)) {
+        if (!is_array($groupNames)) {

             return false;
         }
 
         // if the user id is a negative number make it positive
-        if (intval($userid) < 0) {
+        if (intval($userid) < 0) {

             $userid = -($userid);
         }
 
         // Creates an array with all webgroups the user id is in
-        if (!array_key_exists($userid, $this->cache["mo"])) {
+        if (!array_key_exists($userid, $this->cache["mo"])) {

             $tbl = $modx->getFullTableName("webgroup_names");
             $tbl2 = $modx->getFullTableName("web_groups");
             $sql = "SELECT wgn.name FROM $tbl wgn INNER JOIN $tbl2 wg ON wg.webgroup=wgn.id AND wg.webuser='" . $userid . "'";
             $this->cache["mo"][$userid] = $grpNames = $modx->db->getColumn("name", $sql);
-        } else {
+        } else {

             $grpNames = $this->cache["mo"][$userid];
         }
         // Check if a supplied group matches a webgroup from the array we just created
-        foreach ($groupNames as $k => $v) {
-            if (in_array(trim($v), $grpNames)) {
+        foreach ($groupNames as $k => $v) {

+            if (in_array(trim($v), $grpNames)) {

                 return true;
             }
         }
@@ -653,14 +655,14 @@ 
      * @param $name
      * @return mixed|string
      */
-    public function getPHxVariable($name)
-    {
+    public function getPHxVariable($name)

+    {

         global $modx;
         // Check if this variable is created by PHx
-        if (array_key_exists($name, $this->placeholders)) {
+        if (array_key_exists($name, $this->placeholders)) {

             // Return the value from PHx
             return $this->placeholders[$name];
-        } else {
+        } else {

             // Return the value from MODx
             return $modx->getPlaceholder($name);
         }
@@ -671,9 +673,9 @@ 
      * @param $name
      * @param $value
      */
-    public function setPHxVariable($name, $value)
-    {
-        if ($name != "phx") {
+    public function setPHxVariable($name, $value)

+    {

+        if ($name != "phx") {

             $this->placeholders[$name] = $value;
         }
     }
@@ -685,9 +687,9 @@ 
      * @param null $l
      * @return string
      */
-    public function substr($str, $s, $l = null)
-    {
-        if (function_exists('mb_substr')) {
+    public function substr($str, $s, $l = null)

+    {

+        if (function_exists('mb_substr')) {

             return mb_substr($str, $s, $l);
         }
 
@@ -698,9 +700,9 @@ 
      * @param $str
      * @return int
      */
-    public function strlen($str)
-    {
-        if (function_exists('mb_strlen')) {
+    public function strlen($str)

+    {

+        if (function_exists('mb_strlen')) {

             return mb_strlen($str);
         }
 
@@ -711,9 +713,9 @@ 
      * @param $str
      * @return string
      */
-    public function strtolower($str)
-    {
-        if (function_exists('mb_strtolower')) {
+    public function strtolower($str)

+    {

+        if (function_exists('mb_strtolower')) {

             return mb_strtolower($str);
         }
 
@@ -724,9 +726,9 @@ 
      * @param $str
      * @return string
      */
-    public function strtoupper($str)
-    {
-        if (function_exists('mb_strtoupper')) {
+    public function strtoupper($str)

+    {

+        if (function_exists('mb_strtoupper')) {

             return mb_strtoupper($str);
         }
 
@@ -737,9 +739,9 @@ 
      * @param $str
      * @return string
      */
-    public function ucfirst($str)
-    {
-        if (function_exists('mb_strtoupper') && function_exists('mb_substr') && function_exists('mb_strlen')) {
+    public function ucfirst($str)

+    {

+        if (function_exists('mb_strtoupper') && function_exists('mb_substr') && function_exists('mb_strlen')) {

             return mb_strtoupper(mb_substr($str, 0, 1)) . mb_substr($str, 1, mb_strlen($str));
         }
 
@@ -750,9 +752,9 @@ 
      * @param $str
      * @return string
      */
-    public function lcfirst($str)
-    {
-        if (function_exists('mb_strtolower') && function_exists('mb_substr') && function_exists('mb_strlen')) {
+    public function lcfirst($str)

+    {

+        if (function_exists('mb_strtolower') && function_exists('mb_substr') && function_exists('mb_strlen')) {

             return mb_strtolower(mb_substr($str, 0, 1)) . mb_substr($str, 1, mb_strlen($str));
         }
 
@@ -763,9 +765,9 @@ 
      * @param $str
      * @return string
      */
-    public function ucwords($str)
-    {
-        if (function_exists('mb_convert_case')) {
+    public function ucwords($str)

+    {

+        if (function_exists('mb_convert_case')) {

             return mb_convert_case($str, MB_CASE_TITLE);
         }
 
@@ -776,8 +778,8 @@ 
      * @param $str
      * @return string
      */
-    public function strrev($str)
-    {
+    public function strrev($str)

+    {

         preg_match_all('/./us', $str, $ar);
 
         return implode(array_reverse($ar[0]));
@@ -787,8 +789,8 @@ 
      * @param $str
      * @return string
      */
-    public function str_shuffle($str)
-    {
+    public function str_shuffle($str)

+    {

         preg_match_all('/./us', $str, $ar);
         shuffle($ar[0]);
 
@@ -799,8 +801,8 @@ 
      * @param $str
      * @return int
      */
-    public function str_word_count($str)
-    {
+    public function str_word_count($str)

+    {

         return count(preg_split('~[^\p{L}\p{N}\']+~u', $str));
     }
 }

Spacing +10 added lines, -10 removed lines

@@ -200,7 +200,7 @@ 
                     default:
                         $this->Log("MODx / PHx placeholder variable: " . $input);
                         // Check if placeholder is set
-                        if (!array_key_exists($input, $this->placeholders) && !array_key_exists($input,
+                        if ( ! array_key_exists($input, $this->placeholders) && ! array_key_exists($input,
                                 $modx->placeholders)
                         ) {
                             // not set so try again later.
@@ -309,7 +309,7 @@ 
                     case "show":
                         $conditional = implode(' ', $condition);
                         $isvalid = intval(eval("return (" . $conditional . ");"));
-                        if (!$isvalid) {
+                        if ( ! $isvalid) {
                             $output = null;
                         }
                         break;
@@ -325,7 +325,7 @@ 
                     case "else":
                         $conditional = implode(' ', $condition);
                         $isvalid = intval(eval("return (" . $conditional . ");"));
-                        if (!$isvalid) {
+                        if ( ! $isvalid) {
                             $output = $modifier_value[$i];
                         }
                         break;
@@ -391,7 +391,7 @@ 
                         break;
                     case "wordwrap": // default: 70
                         $wrapat = intval($modifier_value[$i]) ? intval($modifier_value[$i]) : 70;
-                        $output = preg_replace_callback("@(\b\w+\b)@",function($m) use($wrapat) {return wordwrap($m[1],$wrapat,' ',1);},$output);
+                        $output = preg_replace_callback("@(\b\w+\b)@", function($m) use($wrapat) {return wordwrap($m[1], $wrapat, ' ', 1); },$output);
                         break;
                     case "limit": // default: 100
                         $limit = intval($modifier_value[$i]) ? intval($modifier_value[$i]) : 100;
@@ -414,7 +414,7 @@ 
                         $output = eval("return " . $filter . ";");
                         break;
                     case "isnotempty":
-                        if (!empty($output)) {
+                        if ( ! empty($output)) {
                             $output = $modifier_value[$i];
                         }
                         break;
@@ -493,7 +493,7 @@ 
                         $cm = $snippet;
                         // end //
 
-                        if (!empty($cm)) {
+                        if ( ! empty($cm)) {
                             ob_start();
                             $options = $modifier_value[$i];
                             $custom = eval($cm);
@@ -521,7 +521,7 @@ 
      */
     public function createEventLog()
     {
-        if (!empty($this->console)) {
+        if ( ! empty($this->console)) {
             $console = implode("\n", $this->console);
             $this->console = array();
 
@@ -594,7 +594,7 @@ 
     public function ModUser($userid, $field)
     {
         global $modx;
-        if (!array_key_exists($userid, $this->cache["ui"])) {
+        if ( ! array_key_exists($userid, $this->cache["ui"])) {
             if (intval($userid) < 0) {
                 $user = $modx->getWebUserInfo(-($userid));
             } else {
@@ -619,7 +619,7 @@ 
         global $modx;
 
         // if $groupNames is not an array return false
-        if (!is_array($groupNames)) {
+        if ( ! is_array($groupNames)) {
             return false;
         }
 
@@ -629,7 +629,7 @@ 
         }
 
         // Creates an array with all webgroups the user id is in
-        if (!array_key_exists($userid, $this->cache["mo"])) {
+        if ( ! array_key_exists($userid, $this->cache["mo"])) {
             $tbl = $modx->getFullTableName("webgroup_names");
             $tbl2 = $modx->getFullTableName("web_groups");
             $sql = "SELECT wgn.name FROM $tbl wgn INNER JOIN $tbl2 wg ON wg.webgroup=wgn.id AND wg.webuser='" . $userid . "'";

assets/lib/class.summary.php

Doc Comments +5 added lines, -5 removed lines

@@ -69,7 +69,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getCut()
     {
@@ -149,8 +149,8 @@ 
     /**
      * @param $resource
      * @param $truncLen
-     * @param $truncOffset
-     * @param $truncChars
+     * @param integer $truncOffset
+     * @param boolean $truncChars
      * @param string $splitter
      * @return array|mixed|string
      */
@@ -242,7 +242,7 @@ 
      */
     /**
      * @param $string
-     * @param $limit
+     * @param integer $limit
      * @param string $break
      * @return string
      */
@@ -265,7 +265,7 @@ 
     }
 
     /**
-     * @param $str
+     * @param string $str
      * @return mixed
      */
     protected function rTriming($str)

Spacing +7 added lines, -7 removed lines

@@ -83,10 +83,10 @@ 
      */
     protected function dotted($scheme = 0)
     {
-        if (($scheme == 1 && ($this->_useCut || $this->_useSubstr)) || ($scheme == 2 && $this->_useSubstr && !$this->_useCut)) {
+        if (($scheme == 1 && ($this->_useCut || $this->_useSubstr)) || ($scheme == 2 && $this->_useSubstr && ! $this->_useCut)) {
             $this->_cfg['content'] .= '…'; //...
         } else {
-            if ($scheme && (!$this->_useCut || $scheme != 2)) {
+            if ($scheme && ( ! $this->_useCut || $scheme != 2)) {
                 $this->_cfg['content'] .= '.';
             }
         }
@@ -115,13 +115,13 @@ 
                         $this->_cfg['content'] = APIhelpers::sanitarTag($this->_cfg['content']);
                         break;
                     case 'chars':
-                        if (!(isset($process[1]) && $process[1] > 0)) {
+                        if ( ! (isset($process[1]) && $process[1] > 0)) {
                             $process[1] = 200;
                         }
                         $this->_cfg['content'] = APIhelpers::mb_trim_word($this->_cfg['content'], $process[1]);
                         break;
                     case 'len':
-                        if (!(isset($process[1]) && $process[1] > 0)) {
+                        if ( ! (isset($process[1]) && $process[1] > 0)) {
                             $process[1] = 200;
                         }
                         $this->_cfg['content'] = $this->summary($this->_cfg['content'], $process[1], 50, true,
@@ -208,7 +208,7 @@ 
                 } else {
                     $next_char = "";
                 }
-                if (!$quotes_on) {
+                if ( ! $quotes_on) {
                     // Check if it's a tag
                     // On a "<" add 3 if it's an opening tag (like <a href...)
                     // or add only 1 if it's an ending tag (like </a>)
@@ -295,7 +295,7 @@ 
     protected function rTriming($str)
     {
         $str = preg_replace('/[\r\n]++/', ' ', $str);
-        if (!$this->_useCut || $this->_dotted != 2) {
+        if ( ! $this->_useCut || $this->_dotted != 2) {
             $str = preg_replace("/(([\.,\-:!?;\s])|(&\w+;))+$/ui", "", $str);
         }
 
@@ -348,7 +348,7 @@ 
                 if (mb_strstr($tag, ' ', 'UTF-8')) {
                     $tag = mb_substr($tag, 0, strpos($tag, ' '), 'UTF-8');
                 }
-                if (!mb_stristr($tag, 'br', 'UTF-8') && !mb_stristr($tag, 'img', 'UTF-8') && !empty ($tag)) {
+                if ( ! mb_stristr($tag, 'br', 'UTF-8') && ! mb_stristr($tag, 'img', 'UTF-8') && ! empty ($tag)) {
                     $endTags .= '</' . $tag . '>';
                 }
             }

Braces +69 added lines, -69 removed lines

@@ -17,8 +17,8 @@ 
 /**
  * Class SummaryText
  */
-class SummaryText
-{
+class SummaryText

+{

     /**
      * @var array
      */
@@ -45,8 +45,8 @@ 
      * @param $action
      * @param null $break
      */
-    public function __construct($text, $action, $break = null)
-    {
+    public function __construct($text, $action, $break = null)

+    {

         $this->_cfg['content'] = is_scalar($text) ? $text : '';
         $this->_cfg['original'] = $this->_cfg['content'];
         $this->_cfg['summary'] = is_scalar($action) ? $action : '';
@@ -57,12 +57,12 @@ 
      * @param $cut
      * @return bool
      */
-    public function setCut($cut)
-    {
-        if (is_scalar($cut) && $cut != '') {
+    public function setCut($cut)

+    {

+        if (is_scalar($cut) && $cut != '') {

             $this->_cfg['cut'] = $cut;
             $flag = true;
-        } else {
+        } else {

             $flag = false;
         }
 
@@ -72,8 +72,8 @@ 
     /**
      * @return mixed
      */
-    public function getCut()
-    {
+    public function getCut()

+    {

         return \APIHelpers::getkey($this->_cfg, 'cut', '<cut/>');
     }
 
@@ -81,12 +81,12 @@ 
      * @param int $scheme
      * @return mixed
      */
-    protected function dotted($scheme = 0)
-    {
-        if (($scheme == 1 && ($this->_useCut || $this->_useSubstr)) || ($scheme == 2 && $this->_useSubstr && !$this->_useCut)) {
+    protected function dotted($scheme = 0)

+    {

+        if (($scheme == 1 && ($this->_useCut || $this->_useSubstr)) || ($scheme == 2 && $this->_useSubstr && !$this->_useCut)) {

             $this->_cfg['content'] .= '&hellip;'; //...
-        } else {
-            if ($scheme && (!$this->_useCut || $scheme != 2)) {
+        } else {

+            if ($scheme && (!$this->_useCut || $scheme != 2)) {

                 $this->_cfg['content'] .= '.';
             }
         }
@@ -98,16 +98,16 @@ 
      * @param int $dotted
      * @return mixed
      */
-    public function run($dotted = 0)
-    {
+    public function run($dotted = 0)

+    {

         $this->_dotted = $dotted;
-        if (isset($this->_cfg['content'], $this->_cfg['summary']) && $this->_cfg['summary'] != '' && $this->_cfg['content'] != '') {
+        if (isset($this->_cfg['content'], $this->_cfg['summary']) && $this->_cfg['summary'] != '' && $this->_cfg['content'] != '') {

             $param = explode(",", $this->_cfg['summary']);
             $this->_cfg['content'] = $this->beforeCut($this->_cfg['content'], $this->getCut());
-            foreach ($param as $doing) {
+            foreach ($param as $doing) {

 
                 $process = explode(":", $doing);
-                switch ($process[0]) {
+                switch ($process[0]) {

                     case 'notags':
                         $this->_cfg['content'] = strip_tags($this->_cfg['content']);
                         break;
@@ -115,13 +115,13 @@ 
                         $this->_cfg['content'] = APIhelpers::sanitarTag($this->_cfg['content']);
                         break;
                     case 'chars':
-                        if (!(isset($process[1]) && $process[1] > 0)) {
+                        if (!(isset($process[1]) && $process[1] > 0)) {

                             $process[1] = 200;
                         }
                         $this->_cfg['content'] = APIhelpers::mb_trim_word($this->_cfg['content'], $process[1]);
                         break;
                     case 'len':
-                        if (!(isset($process[1]) && $process[1] > 0)) {
+                        if (!(isset($process[1]) && $process[1] > 0)) {

                             $process[1] = 200;
                         }
                         $this->_cfg['content'] = $this->summary($this->_cfg['content'], $process[1], 50, true,
@@ -139,15 +139,15 @@ 
      * @param string $splitter
      * @return array|mixed
      */
-    protected function beforeCut($resource, $splitter = '')
-    {
-        if ($splitter !== '') {
+    protected function beforeCut($resource, $splitter = '')

+    {

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

             $summary = str_replace('<p>' . $splitter . '</p>', $splitter,
                 $resource); // For TinyMCE or if it isn't wrapped inside paragraph tags
             $summary = explode($splitter, $summary, 2);
             $this->_useCut = isset($summary[1]);
             $summary = $summary['0'];
-        } else {
+        } else {

             $summary = $resource;
         }
 
@@ -162,18 +162,18 @@ 
      * @param string $splitter
      * @return array|mixed|string
      */
-    protected function summary($resource, $truncLen, $truncOffset, $truncChars, $splitter = '')
-    {
-        if (isset($this->_useCut) && $splitter != '' && mb_strstr($resource, $splitter, 'UTF-8')) {
+    protected function summary($resource, $truncLen, $truncOffset, $truncChars, $splitter = '')

+    {

+        if (isset($this->_useCut) && $splitter != '' && mb_strstr($resource, $splitter, 'UTF-8')) {

             $summary = $this->beforeCut($resource, $splitter);
-        } else {
-            if ($this->_useCut !== true && (mb_strlen($resource, 'UTF-8') > $truncLen)) {
+        } else {

+            if ($this->_useCut !== true && (mb_strlen($resource, 'UTF-8') > $truncLen)) {

 
                 $summary = $this->html_substr($resource, $truncLen, $truncOffset, $truncChars);
-                if ($resource != $summary) {
+                if ($resource != $summary) {

                     $this->_useSubstr = true;
                 }
-            } else {
+            } else {

                 $summary = $resource;
             }
         }
@@ -194,60 +194,60 @@ 
      * @param bool $truncChars
      * @return string
      */
-    protected function html_substr($posttext, $minimum_length = 200, $length_offset = 100, $truncChars = false)
-    {
+    protected function html_substr($posttext, $minimum_length = 200, $length_offset = 100, $truncChars = false)

+    {

         $tag_counter = 0;
         $quotes_on = false;
-        if (mb_strlen($posttext) > $minimum_length && $truncChars !== true) {
+        if (mb_strlen($posttext) > $minimum_length && $truncChars !== true) {

             $c = 0;
             $len = mb_strlen($posttext, 'UTF-8');
-            for ($i = 0; $i < $len; $i++) {
+            for ($i = 0; $i < $len; $i++) {

                 $current_char = mb_substr($posttext, $i, 1, 'UTF-8');
-                if ($i < mb_strlen($posttext, 'UTF-8') - 1) {
+                if ($i < mb_strlen($posttext, 'UTF-8') - 1) {

                     $next_char = mb_substr($posttext, $i + 1, 1, 'UTF-8');
-                } else {
+                } else {

                     $next_char = "";
                 }
-                if (!$quotes_on) {
+                if (!$quotes_on) {

                     // Check if it's a tag
                     // On a "<" add 3 if it's an opening tag (like <a href...)
                     // or add only 1 if it's an ending tag (like </a>)
-                    if ($current_char == '<') {
-                        if ($next_char == '/') {
+                    if ($current_char == '<') {

+                        if ($next_char == '/') {

                             $tag_counter += 1;
-                        } else {
+                        } else {

                             $tag_counter += 3;
                         }
                     }
                     // Slash signifies an ending (like </a> or ... />)
                     // substract 2
-                    if ($current_char == '/' && $tag_counter <> 0) {
+                    if ($current_char == '/' && $tag_counter <> 0) {

                         $tag_counter -= 2;
                     }
                     // On a ">" substract 1
-                    if ($current_char == '>') {
+                    if ($current_char == '>') {

                         $tag_counter -= 1;
                     }
                     // If quotes are encountered, start ignoring the tags
                     // (for directory slashes)
-                    if ($current_char == '"') {
+                    if ($current_char == '"') {

                         $quotes_on = true;
                     }
-                } else {
+                } else {

                     // IF quotes are encountered again, turn it back off
-                    if ($current_char == '"') {
+                    if ($current_char == '"') {

                         $quotes_on = false;
                     }
                 }
 
                 // Count only the chars outside html tags
-                if ($tag_counter == 2 || $tag_counter == 0) {
+                if ($tag_counter == 2 || $tag_counter == 0) {

                     $c++;
                 }
 
                 // Check if the counter has reached the minimum length yet,
                 // then wait for the tag_counter to become 0, and chop the string there
-                if ($c > $minimum_length - $length_offset && $tag_counter == 0) {
+                if ($c > $minimum_length - $length_offset && $tag_counter == 0) {

                     $posttext = mb_substr($posttext, 0, $i + 1, 'UTF-8');
 
                     return $posttext;
@@ -267,20 +267,20 @@ 
      * @param string $break
      * @return string
      */
-    protected function textTrunc($string, $limit, $break = ". ")
-    {
+    protected function textTrunc($string, $limit, $break = ". ")

+    {

         // Original PHP code from The Art of Web: www.the-art-of-web.com
 
         // return with no change if string is shorter than $limit
-        if (mb_strlen($string, 'UTF-8') < $limit) {
+        if (mb_strlen($string, 'UTF-8') < $limit) {

             return $string;
         }
 
         $string = mb_substr($string, 0, $limit, 'UTF-8');
-        if (false !== ($breakpoint = mb_strrpos($string, $break, 'UTF-8'))) {
+        if (false !== ($breakpoint = mb_strrpos($string, $break, 'UTF-8'))) {

             $string = mb_substr($string, 0, $breakpoint + 1, 'UTF-8');
-        } else {
-            if ($break != ' ') {
+        } else {

+            if ($break != ' ') {

                 $string = $this->textTrunc($string, $limit, " ");
             }
         }
@@ -292,10 +292,10 @@ 
      * @param $str
      * @return mixed
      */
-    protected function rTriming($str)
-    {
+    protected function rTriming($str)

+    {

         $str = preg_replace('/[\r\n]++/', ' ', $str);
-        if (!$this->_useCut || $this->_dotted != 2) {
+        if (!$this->_useCut || $this->_dotted != 2) {

             $str = preg_replace("/(([\.,\-:!?;\s])|(&\w+;))+$/ui", "", $str);
         }
 
@@ -308,8 +308,8 @@ 
      * @param $text
      * @return string
      */
-    private function closeTags($text)
-    {
+    private function closeTags($text)

+    {

         $openPattern = "/<([^\/].*?)>/";
         $closePattern = "/<\/(.*?)>/";
         $endTags = '';
@@ -319,15 +319,15 @@ 
 
         $c = 0;
         $loopCounter = count($closeTags[1]); //used to prevent an infinite loop if the html is malformed
-        while ($c < count($closeTags[1]) && $loopCounter) {
+        while ($c < count($closeTags[1]) && $loopCounter) {

             $i = 0;
-            while ($i < count($openTags[1])) {
+            while ($i < count($openTags[1])) {

                 $tag = trim($openTags[1][$i]);
 
-                if (mb_strstr($tag, ' ', 'UTF-8')) {
+                if (mb_strstr($tag, ' ', 'UTF-8')) {

                     $tag = mb_substr($tag, 0, strpos($tag, ' '), 'UTF-8');
                 }
-                if ($tag == $closeTags[1][$c]) {
+                if ($tag == $closeTags[1][$c]) {

                     $openTags[1][$i] = '';
                     $c++;
                     break;
@@ -339,16 +339,16 @@ 
 
         $results = $openTags[1];
 
-        if (is_array($results)) {
+        if (is_array($results)) {

             $results = array_reverse($results);
 
-            foreach ($results as $tag) {
+            foreach ($results as $tag) {

                 $tag = trim($tag);
 
-                if (mb_strstr($tag, ' ', 'UTF-8')) {
+                if (mb_strstr($tag, ' ', 'UTF-8')) {

                     $tag = mb_substr($tag, 0, strpos($tag, ' '), 'UTF-8');
                 }
-                if (!mb_stristr($tag, 'br', 'UTF-8') && !mb_stristr($tag, 'img', 'UTF-8') && !empty ($tag)) {
+                if (!mb_stristr($tag, 'br', 'UTF-8') && !mb_stristr($tag, 'img', 'UTF-8') && !empty ($tag)) {

                     $endTags .= '</' . $tag . '>';
                 }
             }