cross-solution / YAWIK

module/Core/src/Entity/EntityTrait.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
  */
 trait EntityTrait
 {
+    /**
+     * @param string $property
+     */
     public function notEmpty($property, array $args=[])
     {
         $method = "get$property";

Spacing +3 added lines, -3 removed lines

@@ -20,16 +20,16 @@
  */
 trait EntityTrait
 {
-    public function notEmpty($property, array $args=[])
+    public function notEmpty($property, array $args = [])
     {
         $method = "get$property";
 
         if (!method_exists($this, $method)) {
-            throw new OutOfBoundsException("'$property' is not a valid property of '" . get_class($this) . "'");
+            throw new OutOfBoundsException("'$property' is not a valid property of '".get_class($this)."'");
         }
 
         $value = count($args)
-            ? call_user_func_array([ $this, $method ], $args)
+            ? call_user_func_array([$this, $method], $args)
             : $this->$method();
 
         if (null === $value) { // is_scalar does not consider 'null' to be scalar value.

module/Core/src/Entity/FileEntity.php

Doc Comments +3 added lines, -3 removed lines

@@ -129,7 +129,7 @@ 
     /**
      * Gets the name of a file
      *
-     * @return mixed
+     * @return string
      */
     public function getName()
     {
@@ -197,7 +197,7 @@ 
     /**
      * Gets the uploaded date of a file
      *
-     * @return mixed
+     * @return null|\DateTime
      */
     public function getDateUploaded()
     {
@@ -233,7 +233,7 @@ 
     /**
      * Gets the length of the file
      *
-     * @return mixed
+     * @return string|null
      */
     public function getLength()
     {

Spacing +4 added lines, -4 removed lines

@@ -146,18 +146,18 @@
         $size = $this->getLength();
         
         if ($size >= 1073741824) {
-            return round($size / 1073741824, 2) . ' GB';
+            return round($size / 1073741824, 2).' GB';
         }
         
         if ($size >= 1048576) {
-            return round($size / 1048576, 2) . ' MB';
+            return round($size / 1048576, 2).' MB';
         }
         
         if ($size >= 1024) {
-            return round($size / 1024, 2) . ' kB';
+            return round($size / 1024, 2).' kB';
         }
         
-        return (string)$size;
+        return (string) $size;
     }
 
     /**

module/Core/src/Entity/Hydrator/EntityHydrator.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
     /**
      * exclude methods from the automatism
      *
-     * @param $methods
+     * @param string[] $methods
      */
     public function setExcludeMethods($methods)
     {

Spacing +3 added lines, -3 removed lines

@@ -32,9 +32,9 @@ 
         
         $getters = array_filter(
             get_class_methods($object),
-            function ($methodName) use ($object) {
+            function($methodName) use ($object) {
                 return "get" === substr($methodName, 0, 3)
-                && method_exists($object, 's' . substr($methodName, 1));
+                && method_exists($object, 's'.substr($methodName, 1));
             }
         );
 
@@ -61,7 +61,7 @@ 
         }
         $setters = array_filter(
             get_class_methods($object),
-            function ($methodName) {
+            function($methodName) {
                 return "set" === substr($methodName, 0, 3);
             }
         );

module/Core/src/Entity/ImageSetInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * @param array                $images
      * @param PermissionsInterface $permissions
      *
-     * @return mixed
+     * @return ImageSet
      */
     public function setImages(array $images, PermissionsInterface $permissions = null);
 

module/Core/src/Entity/LocationInterface.php

Doc Comments +11 added lines, -10 removed lines

@@ -20,14 +20,14 @@ 
      * Sets the Postal Code of a location
      *
      * @param   string $postalCode
-     * @return mixed
+     * @return AbstractLocation
      */
     public function setPostalCode($postalCode);
 
     /**
      * Gets the Postal Code of a location
      *
-     * @return mixed
+     * @return string
      */
     public function getPostalCode();
 
@@ -44,6 +44,7 @@ 
      *
      * @param GeoJson $coordinates
      * @internal param $point
+     * @return AbstractLocation
      */
     public function setCoordinates(GeoJson $coordinates);
 
@@ -51,7 +52,7 @@ 
      * Sets the city name of a Location
      *
      * @param $city
-     * @return mixed
+     * @return AbstractLocation
      */
     public function setCity($city);
 
@@ -66,14 +67,14 @@ 
      * Sets the country of a location
      *
      * @param $country
-     * @return mixed
+     * @return AbstractLocation
      */
     public function setCountry($country);
 
     /**
      * Gets the country of a location
      *
-     * @return mixed
+     * @return string
      */
     public function getCountry();
 
@@ -81,7 +82,7 @@ 
      * Sets the region of a location. Eg. "Hessen" is a region in "Germany"
      *
      * @param $region
-     * @return mixed
+     * @return AbstractLocation
      */
     public function setRegion($region);
 
@@ -96,14 +97,14 @@ 
      * Sets the Streetname of a location
      *
      * @param $street
-     * @return mixed
+     * @return AbstractLocation
      */
     public function setStreetname($street);
 
     /**
      * Gets the streetname of a location
      *
-     * @return mixed
+     * @return string
      */
     public function getStreetname();
 
@@ -111,14 +112,14 @@ 
      * Sets the Streetnumber of a location
      *
      * @param $number
-     * @return mixed
+     * @return AbstractLocation
      */
     public function setStreetnumber($number);
 
     /**
      * Gets the streetnumber of a location
      *
-     * @return mixeed
+     * @return string
      */
     public function getStreetnumber();
 }

module/Core/src/Entity/Permissions.php

Doc Comments +3 added lines

@@ -353,6 +353,9 @@
         return $this;
     }
     
+    /**
+     * @param string $permission
+     */
     private function checkIsGranted($userId, $permission)
     {
         if (!$userId) {

Spacing +8 added lines, -8 removed lines

@@ -149,21 +149,21 @@ 
         }
 
         if (preg_match('~^is(View|Change|None|All)Granted$~', $method, $match)) {
-            $permission = constant('self::PERMISSION_' . strtoupper($match[1]));
+            $permission = constant('self::PERMISSION_'.strtoupper($match[1]));
             return $this->isGranted($params[0], $permission);
         }
         
         if (preg_match('~^grant(View|Change|None|All)$~', $method, $match)) {
-            $permission = constant('self::PERMISSION_' . strtoupper($match[1]));
+            $permission = constant('self::PERMISSION_'.strtoupper($match[1]));
             return $this->grant($params[0], $permission);
         }
         
         if (preg_match('~^revoke(View|Change|None|All)$~', $method, $match)) {
-            $permission = constant('self::PERMISSION_' . strtoupper($match[1]));
+            $permission = constant('self::PERMISSION_'.strtoupper($match[1]));
             return $this->revoke($params[0], $permission);
         }
         
-        throw new \BadMethodCallException('Unknown method "' . $method . '"');
+        throw new \BadMethodCallException('Unknown method "'.$method.'"');
     }
 
     /**
@@ -311,7 +311,7 @@ 
         if ($build) {
             $this->build();
         }
-        $this->hasChanged= true;
+        $this->hasChanged = true;
 
         // restore orginial permissions type
         $this->type = $oldType;
@@ -444,10 +444,10 @@ 
         }
         
         if ($resource instanceof UserInterface) {
-            return 'user:' . $resource->getId();
+            return 'user:'.$resource->getId();
         }
         
-        return 'user:' . $resource;
+        return 'user:'.$resource;
     }
 
     /**
@@ -467,7 +467,7 @@ 
         );
         if (!in_array($permission, $perms)) {
             throw new \InvalidArgumentException(
-                'Invalid permission. Must be one of ' . implode(', ', $perms)
+                'Invalid permission. Must be one of '.implode(', ', $perms)
             );
         }
     }

module/Core/src/Entity/Snapshot.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 {
     /**
      * @param $data
-     * @return mixed
+     * @return Snapshot
      * @ODM\PreUpdate
      */
     public function __invoke($data)

module/Core/src/Entity/SnapshotTrait.php

Doc Comments +9 added lines

@@ -77,6 +77,9 @@ 
         return $return === $entity ? $this : $return;
     }
 
+    /**
+     * @param string $method
+     */
     protected function proxyClone($method, ...$args)
     {
         $value = $this->proxy($method, ...$args);
@@ -85,6 +88,9 @@ 
         return $return;
     }
 
+    /**
+     * @param string $property
+     */
     protected function inaccessible($property)
     {
         throw new \DomainException(sprintf(
@@ -93,6 +99,9 @@ 
         ));
     }
 
+    /**
+     * @param string $property
+     */
     protected function immutable($property)
     {
         throw new ImmutablePropertyException($property, $this);

Indentation +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
         if (!is_callable($callback)) {
             throw new \BadMethodCallException(sprintf(
                 'Proxy error: Method "%s" does not exist in proxied "%s"',
-                 $method,
+                    $method,
                 get_class($entity)
             ));
         }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
             : SnapshotMeta::class;
 
         $this->snapshotMeta = new $snapshotMetaClass();
-        $this->snapshotEntity       = $source;
+        $this->snapshotEntity = $source;
     }
 
     public function getOriginalEntity()

module/Core/src/Entity/Tree/Node.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
      */
     protected $parent;
 
+    /**
+     * @param string $value
+     */
     final public static function filterValue($value)
     {
         $value = mb_strtolower($value);

Spacing +1 added lines, -1 removed lines

@@ -153,7 +153,7 @@
 
     public function getValueWithParents($withRoot = false, $useNames = false)
     {
-        $parts = [ ($useNames ? $this->getName() : $this->getValue()) ];
+        $parts = [($useNames ? $this->getName() : $this->getValue())];
         $item = $this;
 
         while ($item = $item->getParent()) {