alphadevx / alpha

Alpha/Controller/Controller.php

Doc Comments +11 added lines, -3 removed lines

@@ -297,7 +297,7 @@ 
     /**
      * Get the record for this controller (if any).
      *
-     * @return mixed
+     * @return ActiveRecord
      *
      * @since 1.0
      */
@@ -632,7 +632,7 @@ 
     /**
      * Getter for the unit of work MAX duration.
      *
-     * @return int
+     * @return Integer
      *
      * @since 1.0
      */
@@ -1179,7 +1179,7 @@ 
     /**
      * Generates the two security fields to prevent remote form processing.
      *
-     * @return array An array containing the two fields
+     * @return string[] An array containing the two fields
      *
      * @since 1.0
      */
@@ -1432,6 +1432,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doHEAD($request)
     {
@@ -1444,6 +1445,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doGET($request)
     {
@@ -1456,6 +1458,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doPOST($request)
     {
@@ -1468,6 +1471,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doPUT($request)
     {
@@ -1480,6 +1484,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doPATCH($request)
     {
@@ -1492,6 +1497,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doDELETE($request)
     {
@@ -1502,6 +1508,7 @@ 
      * {@inheritdoc}
      *
      * @since 2.0
+     * @param Request $request
      */
     public function doOPTIONS($request)
     {
@@ -1529,6 +1536,7 @@ 
      * {@inheritdoc}
      *
      * @since 2.0.2
+     * @param Request $request
      */
     public function doTRACE($request)
     {

Alpha/Controller/ControllerInterface.php

Doc Comments +6 added lines, -7 removed lines

@@ -60,37 +60,36 @@ 
     /**
      * Handles GET HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response|null
      */
     public function doGET($params);
 
     /**
      * Handles POST HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response|null
      */
     public function doPOST($params);
 
     /**
      * Handles PUT HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response
      */
     public function doPUT($params);
 
     /**
      * Handles PATCH HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
@@ -100,30 +99,30 @@ 
     /**
      * Handles DELETE HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response
      */
     public function doDELETE($params);
 
     /**
      * Handles OPTIONS HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response
      */
     public function doOPTIONS($params);
 
     /**
      * Handles TRACE HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 2.0.2
+     * @return \Alpha\Util\Http\Response
      */
     public function doTRACE($params);
 }

Alpha/Controller/InstallController.php

Doc Comments +1 added lines, -1 removed lines

@@ -454,7 +454,7 @@
      * Custom version of the check rights method that only checks for a session for the config admin username/password,
      * when the system database is not set-up.
      *
-     * @return bool
+     * @return boolean|null
      *
      * @since 1.0
      */

Alpha/Model/ActiveRecordProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
      * A static method that attempts to return a ActiveRecordProviderInterface instance
      * based on the name of the provider class supplied.
      *
-     * @param $providerName The fully-qualified class name of the provider class.
+     * @param string $providerName The fully-qualified class name of the provider class.
      * @param $BO The (optional) active record instance to pass to the persistance provider for mapping.
      *
      * @throws \Alpha\Exception\IllegalArguementException

Alpha/Model/Type/Relation.php

Doc Comments +2 added lines, -3 removed lines

@@ -262,7 +262,6 @@ 
     /**
      * Get the name of the business object class that this class is related to.
      *
-     * @param string $RC
      *
      * @return string
      *
@@ -512,7 +511,7 @@ 
     /**
      * Getter for the Relation value.
      *
-     * @return mixed
+     * @return string
      *
      * @since 1.0
      */
@@ -754,7 +753,7 @@ 
      * Set the taggedClass property to the name of the tagged class when building relations
      * to the TagObject BO.
      *
-     * @param $taggedClass
+     * @param string $taggedClass
      *
      * @since 1.0
      */

Alpha/Model/Type/RelationLookup.php

Doc Comments +3 added lines, -2 removed lines

@@ -222,6 +222,7 @@ 
      * (non-PHPdoc)
      *
      * @see Alpha\Model\ActiveRecord::loadAllByAttribute()
+     * @param string $attribute
      */
     public function loadAllByAttribute($attribute, $value, $start = 0, $limit = 0, $orderBy = 'OID', $order = 'ASC', $ignoreClassType = false, $constructorArgs = array())
     {
@@ -312,7 +313,7 @@ 
     /**
      * Returns an array of the OIDs of the related objects.
      *
-     * @return array
+     * @return integer[]
      *
      * @since 1.0
      */
@@ -325,7 +326,7 @@ 
      * Used to set the OIDs of the related objects.  Pass a two-item array of OIDs, the first
      * one being the left object OID, the second being the right.
      *
-     * @param array $OIDs
+     * @param string[] $OIDs
      *
      * @since 1.0
      *

Alpha/Util/Code/Highlight/HighlightProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
      * A static method that attempts to return a HighlightProviderInterface instance
      * based on the name of the provider class supplied.
      *
-     * @param $providerName The fully-qualified class name of the provider class, should implement Alpha\Util\Code\Highlight\HighlightProviderInterface
+     * @param string $providerName The fully-qualified class name of the provider class, should implement Alpha\Util\Code\Highlight\HighlightProviderInterface
      *
      * @throws \Alpha\Exception\IllegalArguementException
      *

Alpha/Util/Email/EmailProviderFactory.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,11 +63,11 @@
      * A static method that attempts to return a EmailProviderInterface instance
      * based on the name of the provider class supplied.
      *
-     * @param $providerName The class name of the provider class (fully qualified).
+     * @param string $providerName The class name of the provider class (fully qualified).
      *
      * @throws \Alpha\Exception\IllegalArguementException
      *
-     * @return \Alpha\Util\Http\Email\EmailProviderInterface
+     * @return EmailProviderInterface|null
      *
      * @since 2.0
      */

Alpha/Util/Http/Request.php

Doc Comments +2 added lines, -2 removed lines

@@ -300,7 +300,7 @@ 
      * @param string $key     The key to search for
      * @param mixed  $default If key is not found, return this instead
      *
-     * @return mixed
+     * @return string
      *
      * @since 2.0
      */
@@ -391,7 +391,7 @@ 
      * @param string $key     The key to search for
      * @param mixed  $default If key is not found, return this instead
      *
-     * @return mixed
+     * @return string
      *
      * @since 2.0
      */