evolution-cms / evolution

core/src/AbstractLaravel.php

Doc Comments +14 added lines, -1 removed lines

@@ -119,12 +119,18 @@ 
 
     protected $evolutionProperty = [];
 
+    /**
+     * @param string $data
+     */
     abstract public function getVersionData($data = null);
+
+    /**
+     * @param integer $default
+     */
     abstract public function getConfig($name = '', $default = null);
     abstract public function bootstrapPath($path = '');
 
     /**
-     * @param array $classes
      */
     public function __construct()
     {
@@ -168,6 +174,10 @@ 
         $this->boot();
     }
 
+    /**
+     * @param Repository $config
+     * @param string $dir
+     */
     protected function loadConfiguration($config, $dir)
     {
         $files = [];
@@ -562,6 +572,9 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     public function getService($name)
     {
         return $this->get($name);

core/src/AliasLoader.php

Doc Comments -1 removed lines

@@ -41,7 +41,6 @@
      * Get or create the singleton alias loader instance.
      *
      * @param  array  $aliases
-     * @param string $cachedPath
      * @return AliasLoader
      */
     public static function getInstance(array $aliases = [])

core/src/Console/VendorPublishCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -106,7 +106,7 @@
     /**
      * The choices available via the prompt.
      *
-     * @return array
+     * @return string[]
      */
     protected function publishableChoices()
     {

core/src/Controllers/AbstractController.php

Doc Comments +1 added lines

@@ -43,6 +43,7 @@
 
     /**
      * {@inheritdoc}
+     * @param string $view
      */
     public function setView($view) : bool
     {

core/src/Controllers/Frame.php

Doc Comments +3 added lines

@@ -399,6 +399,9 @@
         return $this;

     }

 

+    /**
+     * @param integer $tab
+     */
     protected function menuElementTemplates($tab)

     {

         if ($this->managerTheme->getCore()->hasPermission('edit_template')) {

core/src/Controllers/MoveDocument.php

Doc Comments +4 added lines, -1 removed lines

@@ -135,7 +135,7 @@ 
     }

 

     /**

-     * @param string|int $id

+     * @param integer $id

      * @return Models\SiteContent

      */

     protected function getDocument($id) : Models\SiteContent

@@ -153,6 +153,9 @@ 
         return $document;

     }

 

+    /**
+     * @param integer $id
+     */
     protected function checkNewParentPermission($id)

     {

         $udperms = new Permissions;

core/src/Core.php

Doc Comments +24 added lines, -21 removed lines

@@ -132,7 +132,6 @@ 
     public $urlProcessor;
 
     /**
-     * @param array $services
      */
     public function __construct()
     {
@@ -317,7 +316,7 @@ 
      * @param int $count_attempts
      * @param string $type $type
      * @param string $responseCode
-     * @return bool|null
+     * @return false|null
      * @global string $base_url
      * @global string $site_url
      */
@@ -804,7 +803,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1652,7 +1651,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1853,7 +1852,7 @@ 
     /**
      * Run snippets as per the tags in $documentSource and replace the tags with the returned values.
      *
-     * @param $content
+     * @param string $content
      * @return string
      * @internal param string $documentSource
      */
@@ -2298,6 +2297,7 @@ 
 
     /**
      * @deprecated use UrlProcessor::rewriteUrls()
+     * @return string
      */
     public function rewriteUrls($documentSource)
     {
@@ -2761,7 +2761,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -2809,7 +2809,7 @@ 
     /**
      * @param $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3206,7 +3206,7 @@ 
      *
      * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role
      * @param int $id Element- / Resource-id
-     * @return bool
+     * @return false|null
      */
     public function lockElement($type, $id)
     {
@@ -3229,7 +3229,7 @@ 
      * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role
      * @param int $id Element- / Resource-id
      * @param bool $includeAllUsers true = Deletes not only own user-locks
-     * @return bool
+     * @return false|null
      */
     public function unlockElement($type, $id, $includeAllUsers = false)
     {
@@ -3784,7 +3784,7 @@ 
      *                     Default: 1
      * @param string $fields List of fields
      *                       Default: id, pagetitle, description, alias
-     * @return boolean|array
+     * @return string
      */
     public function getPageInfo($pageid = -1, $active = 1, $fields = 'id, pagetitle, description, alias')
     {
@@ -3883,7 +3883,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -3926,6 +3926,7 @@ 
 
     /**
      * @deprecated use UrlProcessor::makeUrl()
+     * @return string
      */
     public function makeUrl($id, $alias = '', $args = '', $scheme = '')
     {
@@ -4020,7 +4021,7 @@ 
     }
 
     /**
-     * @param string|object $processor
+     * @param string $processor
      * @return bool
      */
     public function isChunkProcessor($processor)
@@ -4446,9 +4447,9 @@ 
      * Elements representing a TV consist of an array representing a db row including the fields specified in $fields.
      *
      * @param string|array $idnames {array; '*'} - Which TVs to fetch. Can relate to the TV ids in the db (array elements should be numeric only) or the TV names (array elements should be names only). @required
-     * @param string|array $fields {comma separated string; '*'} - Fields names in the TV table of MODx database. Default: '*'
+     * @param string $fields {comma separated string; '*'} - Fields names in the TV table of MODx database. Default: '*'
      * @param int|string $docid {integer; ''} - Id of a document to get. Default: an empty string which indicates the current document.
-     * @param int|string $published {0; 1; 'all'} - Document publication status. Once the parameter equals 'all', the result will be returned regardless of whether the ducuments are published or they are not. Default: 1.
+     * @param integer $published {0; 1; 'all'} - Document publication status. Once the parameter equals 'all', the result will be returned regardless of whether the ducuments are published or they are not. Default: 1.
      * @param string $sort {comma separated string} - Fields of the TV table to sort by. Default: 'rank'.
      * @param string $dir {'ASC'; 'DESC'} - How to sort the result array (direction). Default: 'ASC'.
      *
@@ -5098,7 +5099,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5150,7 +5151,7 @@ 
      *
      * @param string $evtName
      * @param array $extParams Parameters available to plugins. Each array key will be the PHP variable name, and the array value will be the variable value.
-     * @return boolean|array
+     * @return false|null
      */
     public function invokeEvent($evtName, $extParams = array())
     {
@@ -5463,6 +5464,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $type
      */
     public function findElements($type, $scanPath, array $ext)
     {
@@ -5604,7 +5606,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -5655,8 +5657,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -5812,7 +5814,7 @@ 
      * @param string $text Error message
      * @param string $file File where the error was detected
      * @param string $line Line number within $file
-     * @return boolean
+     * @return boolean|null
      * @deprecated
      */
     public function phpError($nr, $text, $file, $line)
@@ -5908,6 +5910,7 @@ 
 
     /**
      * @deprecated use UrlProcessor::getIdFromAlias()
+     * @param string $alias
      */
     public function getIdFromAlias($alias)
     {
@@ -5916,7 +5919,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {

core/src/Event.php

Doc Comments +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
     }
 
     /**
-     * @param mixed $data
+     * @param string $data
      */
     public function addOutput($data)
     {
@@ -90,7 +90,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getOutput()
     {

core/src/ExceptionHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
      * @param string $text Error message
      * @param string $file File where the error was detected
      * @param string $line Line number within $file
-     * @return boolean
+     * @return boolean|null
      */
     public function phpError($nr, $text, $file, $line)
     {
@@ -148,7 +148,7 @@ 
      * @param string $text
      * @param string $line
      * @param string $output
-     * @return bool
+     * @return null|boolean
      */
     public function messageQuit(
         $msg = 'unspecified error',