Mistralys / application-utils

src/OperationResult.php

Indentation +73 added lines, -73 removed lines

@@ -32,46 +32,46 @@ 
     const TYPE_ERROR = 'error';
     const TYPE_SUCCESS = 'success';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message = '';
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
   
-   /**
-    * @var object
-    */
+    /**
+     * @var object
+     */
     protected $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code = 0;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $counter = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $id;
     
-   /**
-    * The subject being validated.
-    * 
-    * @param object $subject
-    */
+    /**
+     * The subject being validated.
+     * 
+     * @param object $subject
+     */
     public function __construct(object $subject)
     {
         $this->subject = $subject;
@@ -81,21 +81,21 @@ 
         $this->id = self::$counter;
     }
     
-   /**
-    * Retrieves the ID of the result, which is unique within a request.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the ID of the result, which is unique within a request.
+     * 
+     * @return int
+     */
     public function getID() : int
     {
         return $this->id;
     }
     
-   /**
-    * Whether the validation was successful.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the validation was successful.
+     * 
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->valid;
@@ -126,33 +126,33 @@ 
         return $this->type === $type;
     }
     
-   /**
-    * Retrieves the subject that was validated.
-    * 
-    * @return object
-    */
+    /**
+     * Retrieves the subject that was validated.
+     * 
+     * @return object
+     */
     public function getSubject() : object
     {
         return $this->subject;
     }
     
-   /**
-    * Makes the result a succes, with the specified message.
-    * 
-    * @param string $message Should not contain a date, just the system specific info.
-    * @return OperationResult
-    */
+    /**
+     * Makes the result a succes, with the specified message.
+     * 
+     * @param string $message Should not contain a date, just the system specific info.
+     * @return OperationResult
+     */
     public function makeSuccess(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage(self::TYPE_SUCCESS, $message, $code, true);
     }
     
-   /**
-    * Sets the result as an error.
-    * 
-    * @param string $message Should be as detailed as possible.
-    * @return OperationResult
-    */
+    /**
+     * Sets the result as an error.
+     * 
+     * @param string $message Should be as detailed as possible.
+     * @return OperationResult
+     */
     public function makeError(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage(self::TYPE_ERROR, $message, $code, false);
@@ -183,21 +183,21 @@ 
         return $this->type;
     }
     
-   /**
-    * Retrieves the error message, if an error occurred.
-    * 
-    * @return string The error message, or an empty string if no error occurred.
-    */
+    /**
+     * Retrieves the error message, if an error occurred.
+     * 
+     * @return string The error message, or an empty string if no error occurred.
+     */
     public function getErrorMessage() : string
     {
         return $this->getMessage(self::TYPE_ERROR);
     }
     
-   /**
-    * Retrieves the success message, if one has been provided.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the success message, if one has been provided.
+     * 
+     * @return string
+     */
     public function getSuccessMessage() : string
     {
         return $this->getMessage(self::TYPE_SUCCESS);
@@ -213,21 +213,21 @@ 
         return $this->getMessage(self::TYPE_WARNING);
     }
     
-   /**
-    * Whether a specific error/success code has been specified.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether a specific error/success code has been specified.
+     * 
+     * @return bool
+     */
     public function hasCode() : bool
     {
         return $this->code > 0;
     }
     
-   /**
-    * Retrieves the error/success code, if any. 
-    * 
-    * @return int The error code, or 0 if none.
-    */
+    /**
+     * Retrieves the error/success code, if any. 
+     * 
+     * @return int The error code, or 0 if none.
+     */
     public function getCode() : int
     {
         return $this->code;

Spacing +5 added lines, -5 removed lines

@@ -142,7 +142,7 @@ 
     * @param string $message Should not contain a date, just the system specific info.
     * @return OperationResult
     */
-    public function makeSuccess(string $message, int $code=0) : OperationResult
+    public function makeSuccess(string $message, int $code = 0) : OperationResult
     {
         return $this->setMessage(self::TYPE_SUCCESS, $message, $code, true);
     }
@@ -153,7 +153,7 @@ 
     * @param string $message Should be as detailed as possible.
     * @return OperationResult
     */
-    public function makeError(string $message, int $code=0) : OperationResult
+    public function makeError(string $message, int $code = 0) : OperationResult
     {
         return $this->setMessage(self::TYPE_ERROR, $message, $code, false);
     }
@@ -233,11 +233,11 @@ 
         return $this->code;
     }
     
-    public function getMessage(string $type='') : string
+    public function getMessage(string $type = '') : string
     {
-        if(!empty($type))
+        if (!empty($type))
         {
-            if($this->type === $type)
+            if ($this->type === $type)
             {
                 return $this->message;
             }

src/OperationResult/Collection.php

Indentation +6 added lines, -6 removed lines

@@ -26,9 +26,9 @@ 
  */
 class OperationResult_Collection extends OperationResult
 {
-   /**
-    * @var OperationResult[]
-    */
+    /**
+     * @var OperationResult[]
+     */
     protected $results = array();
     
     public function makeError(string $message, int $code=0) : OperationResult
@@ -106,9 +106,9 @@ 
         return $this;
     }
     
-   /**
-    * @return OperationResult[]
-    */
+    /**
+     * @return OperationResult[]
+     */
     public function getResults() : array
     {
         return $this->results;

Spacing +26 added lines, -26 removed lines

@@ -31,27 +31,27 @@ 
     */
     protected $results = array();
     
-    public function makeError(string $message, int $code=0) : OperationResult
+    public function makeError(string $message, int $code = 0) : OperationResult
     {
         return $this->add('makeError', $message, $code);
     }
     
-    public function makeSuccess(string $message, int $code=0) : OperationResult
+    public function makeSuccess(string $message, int $code = 0) : OperationResult
     {
         return $this->add('makeSuccess', $message, $code);
     }
 
-    public function makeWarning(string $message, int $code=0) : OperationResult
+    public function makeWarning(string $message, int $code = 0) : OperationResult
     {
         return $this->add('makeWarning', $message, $code);
     }
     
-    public function makeNotice(string $message, int $code=0) : OperationResult
+    public function makeNotice(string $message, int $code = 0) : OperationResult
     {
         return $this->add('makeNotice', $message, $code);
     }
     
-    protected function add(string $method, string $message, int $code=0) : OperationResult
+    protected function add(string $method, string $message, int $code = 0) : OperationResult
     {
         $result = new OperationResult($this->subject);
         $result->$method($message, $code);
@@ -63,7 +63,7 @@ 
     
     public function addResult(OperationResult $result) : OperationResult_Collection
     {
-        if($result instanceof OperationResult_Collection)
+        if ($result instanceof OperationResult_Collection)
         {
             return $this->importCollection($result);
         }
@@ -75,7 +75,7 @@ 
     {
         $results = $collection->getResults();
         
-        foreach($results as $result)
+        foreach ($results as $result)
         {
             $this->addResult($result);
         }
@@ -92,7 +92,7 @@ 
         // the subjects are the same, this is actually the better way.
         $new = new OperationResult($this->subject);
         
-        if($result->isValid())
+        if ($result->isValid())
         {
             $new->makeSuccess($result->getSuccessMessage(), $result->getCode());
         }
@@ -116,9 +116,9 @@ 
     
     public function isValid() : bool
     {
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if(!$result->isValid())
+            if (!$result->isValid())
             {
                 return false;
             }
@@ -129,9 +129,9 @@ 
     
     public function hasCode() : bool
     {
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if($result->hasCode())
+            if ($result->hasCode())
             {
                 return true;
             }
@@ -142,9 +142,9 @@ 
     
     public function getCode() : int
     {
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if($result->hasCode())
+            if ($result->hasCode())
             {
                 return $result->getCode();
             }
@@ -153,13 +153,13 @@ 
         return 0;
     }
     
-    public function getMessage(string $type='') : string
+    public function getMessage(string $type = '') : string
     {
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
             $msg = $result->getMessage($type);
             
-            if(!empty($msg))
+            if (!empty($msg))
             {
                 return $msg;
             }
@@ -170,9 +170,9 @@ 
     
     public function containsCode(int $code) : bool
     {
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if($result->getCode() === $code)
+            if ($result->getCode() === $code)
             {
                 return true;
             }
@@ -205,9 +205,9 @@ 
     {
         $amount = 0;
         
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if($result->isType($type))
+            if ($result->isType($type))
             {
                 $amount++;
             }
@@ -245,9 +245,9 @@ 
     {
         $results = array();
         
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if($result->isType($type))
+            if ($result->isType($type))
             {
                 $results[] = $result;
             }
@@ -258,9 +258,9 @@ 
     
     public function isType(string $type) : bool
     {
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
-            if($result->isType($type))
+            if ($result->isType($type))
             {
                 return true;
             }
@@ -276,7 +276,7 @@ 
         $lines[] = 'Collection #'.$this->getID();
         $lines[] = 'Subject: '.get_class($this->subject);
         
-        foreach($this->results as $result)
+        foreach ($this->results as $result)
         {
             $lines[] = ' - '.$result->getType().' #'.$result->getCode().' "'.$result->getMessage($result->getType()).'"';
         }

Braces +1 added lines, -2 removed lines

@@ -95,8 +95,7 @@
         if($result->isValid())
         {
             $new->makeSuccess($result->getSuccessMessage(), $result->getCode());
-        }
-        else
+        } else
         {
             $new->makeError($result->getErrorMessage(), $result->getCode());
         }