evolution-cms / evolution

core/src/Interfaces/ManagerTheme/ControllerInterface.php

Doc Comments +9 added lines

@@ -4,8 +4,14 @@ 
 
 interface ControllerInterface
 {
+    /**
+     * @return void
+     */
     public function __construct(ManagerThemeInterface $managerTheme, array $data = []);
 
+    /**
+     * @return string
+     */
     public function getView() : ?string;
 
     public function setView($view) : bool;
@@ -24,6 +30,9 @@ 
 
     public function render(array $params = []) : string;
 
+    /**
+     * @return void
+     */
     public function setIndex($index) : void;
 
     public function getElementId() : int;

core/src/Interfaces/ManagerThemeInterface.php

Doc Comments +4 added lines

@@ -6,11 +6,15 @@
 
     public function getLang() : string;
 
+    /**
+     * @param string $key
+     */
     public function getStyle($key = null);
 
     /**
      * @param string $message
      * @param bool $lexicon
+     * @return void
      */
     public function alertAndQuit(string $message, $lexicon = true) : void;
 }

core/src/Legacy/Cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
     /**
      * build siteCache file
      * @param Interfaces\CoreInterface $modx
-     * @return boolean success
+     * @return null|boolean success
      */
     public function buildCache($modx)
     {

core/src/Legacy/Modifiers.php

Doc Comments +26 added lines, -1 removed lines

@@ -101,7 +101,7 @@ 
     /**
      * @param string $mode
      * @param string $modifiers
-     * @return bool|string
+     * @return false|string
      */
     public function _getDelim($mode, $modifiers)
     {
@@ -151,6 +151,13 @@ 
         }
     }
 
+    /**
+     * @param string $mode
+     * @param false|string $delim
+     * @param string $modifiers
+     *
+     * @return string
+     */
     public function _getRemainModifiers($mode, $delim, $modifiers)
     {
         if ($delim) {
@@ -187,6 +194,9 @@ 
         return substr($string, strpos($string, $delim) + $len);
     }
 
+    /**
+     * @param string $modifiers
+     */
     public function splitEachModifiers($modifiers)
     {
         $modx = evolutionCMS();
@@ -259,6 +269,10 @@ 
         return $result;
     }
 
+    /**
+     * @param string $key
+     * @param string $value
+     */
     public function parsePhx($key, $value, $modifiers)
     {
         $modx = evolutionCMS();
@@ -340,6 +354,10 @@ 
         }
     }
 
+    /**
+     * @param string $cmd
+     * @param string $opt
+     */
     public function getValueFromPreset($key, $value, $cmd, $opt)
     {
         $modx = evolutionCMS();
@@ -1285,6 +1303,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function includeMdfFile($cmd)
     {
         $modx = evolutionCMS();
@@ -1477,6 +1498,10 @@ 
     }
 
     // Sets a placeholder variable which can only be access by Modifiers
+
+    /**
+     * @param string $value
+     */
     public function setModifiersVariable($key, $value)
     {
         if ($key != 'phx' && $key != 'dummy') {

core/src/ManagerTheme.php

Doc Comments +16 added lines

@@ -270,6 +270,9 @@ 
         return $this->langName;
     }
 
+    /**
+     * @return string
+     */
     public function getTextDir($notEmpty = null)
     {
         return ($notEmpty === null) ? $this->textDir : (empty($this->textDir) ? '' : $notEmpty);
@@ -280,6 +283,9 @@ 
         $this->textDir = $textDir === 'rtl' ? 'rtl' : 'ltr';
     }
 
+    /**
+     * @param string $key
+     */
     public function getLexicon($key = null, $default = '')
     {
         return $key === null ? $this->lexicon : get_by_key($this->lexicon, $key, $default);
@@ -290,6 +296,9 @@ 
         return $this->charset;
     }
 
+    /**
+     * @param string $charset
+     */
     public function setCharset($charset)
     {
         $this->charset = $charset;
@@ -334,6 +343,9 @@ 
         return $key === null ? $this->style : get_by_key($this->style, $key, '');
     }
 
+    /**
+     * @param string $name
+     */
     public function view($name, array $params = [])
     {
         return View::make(
@@ -570,6 +582,10 @@ 
         return $content;
     }
 
+    /**
+     * @param string $name
+     * @param string $config
+     */
     public function makeTemplate($name, $config = null, array $placeholders = [], $clean = true) : string
     {
         $content = $this->getTemplate($name, $config);

core/src/Parser.php

Doc Comments +2 added lines, -2 removed lines

@@ -381,7 +381,7 @@ 
      *

      * @param string $name

      * @param string $tpl

-     * @return null

+     * @return string

      */

     protected function getTwig($name, $tpl)

     {

@@ -448,7 +448,7 @@ 
     /**

      * @param $out

      * @param Core|null $modx

-     * @return mixed|string

+     * @return string

      */

     public function parseDocumentSource($out, $modx = null)

     {

core/src/Providers/ManagerThemeServiceProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
     /**
      * Get the services provided by the provider.
      *
-     * @return array
+     * @return string[]
      */
     public function provides()
     {

core/src/Support/DataGrid.php

Doc Comments +7 added lines

@@ -75,6 +75,10 @@ 
 
     public static $dataGridCnt;
 
+    /**
+     * @param null|string $id
+     * @param string $ds
+     */
     public function __construct($id, $ds, $pageSize = 20, $pageNumber = -1) {
 		// set id
 		self::$dataGridCnt++;
@@ -207,6 +211,9 @@ 
 
 	// format column values
 
+    /**
+     * @param integer $n
+     */
     public function RenderRowFnc($n, $row) {
 		if($this->_alt == 0) {
 			$Style = $this->_itemStyle;

core/src/Support/DataSetPager.php

Doc Comments +6 added lines

@@ -33,6 +33,9 @@ 
     public $renderPagerFncArgs;
     public static $dataSetPagerCnt;
 
+    /**
+     * @param boolean|string $id
+     */
     public function __construct($id, $ds, $pageSize = 10, $pageNumber = -1) {
 		global $_PAGE; // use view state object
 
@@ -77,6 +80,9 @@ 
 		$this->pageSize = $ps;
 	}
 
+    /**
+     * @param DataGrid $fncName
+     */
     public function setRenderRowFnc($fncName, $args = "") {
 		$this->renderRowFnc = &$fncName;
 		$this->renderRowFncArgs = $args;    // extra agruments