cross-solution / YAWIK

module/Core/src/Entity/AddressInterface.php

Doc Comments -1 removed lines

@@ -55,7 +55,6 @@
      * Two-letter codes from the ISO 3166 standard as implemented by The Internet Assigned
      * Numbers Authority.
      *
-     * @param string $postalCode {'AC'|'AD'|'AE'|'AF'|'AG'|'AI'|'AL'|'AM'|'AN'|'AO'|'AQ'|'AR'|'AS'|'AT'|'AU'|'AW'|'AX'|'AZ'|'BA'|'BB'|'BD'|'BE'|'BF'|'BG'|'BH'|'BI'|'BJ'|'BL'|'BM'|'BN'|'BO'|'BR'|'BS'|'BT'|'BV'|'BW'|'BY'|'BZ'|'CA'|'CC'|'CD'|'CF'|'CG'|'CH'|'CI'|'CK'|'CL'|'CM'|'CN'|'CO'|'CR'|'CU'|'CV'|'CX'|'CY'|'CZ'|'DE'|'DJ'|'DK'|'DM'|'DO'|'DZ'|'EC'|'EE'|'EG'|'EH'|'ER'|'ES'|'ET'|'EU'|'FI'|'FJ'|'FK'|'FM'|'FO'|'FR'|'GA'|'GB'|'GD'|'GE'|'GF'|'GG'|'GH'|'GI'|'GL'|'GM'|'GN'|'GP'|'GQ'|'GR'|'GS'|'GT'|'GU'|'GW'|'GY'|'HK'|'HM'|'HN'|'HR'|'HT'|'HU'|'ID'|'IE'|'IL'|'IM'|'IN'|'IO'|'IQ'|'IR'|'IS'|'IT'|'JE'|'JM'|'JO'|'JP'|'KE'|'KG'|'KH'|'KI'|'KM'|'KN'|'KP'|'KR'|'KW'|'KY'|'KZ'|'LA'|'LB'|'LC'|'LI'|'LK'|'LR'|'LS'|'LT'|'LU'|'LV'|'LY'|'MA'|'MC'|'MD'|'ME'|'MF'|'MG'|'MH'|'MK'|'ML'|'MM'|'MN'|'MO'|'MP'|'MQ'|'MR'|'MS'|'MT'|'MU'|'MV'|'MW'|'MX'|'MY'|'MZ'|'NA'|'NC'|'NE'|'NF'|'NG'|'NI'|'NL'|'NO'|'NP'|'NR'|'NU'|'NZ'|'OM'|'PA'|'PE'|'PF'|'PG'|'PH'|'PK'|'PL'|'PM'|'PN'|'PR'|'PS'|'PT'|'PW'|'PY'|'QA'|'RE'|'RO'|'RS'|'RU'|'RW'|'SA'|'SB'|'SC'|'SD'|'SE'|'SG'|'SH'|'SI'|'SJ'|'SK'|'SL'|'SM'|'SN'|'SO'|'SR'|'ST'|'SU'|'SV'|'SY'|'SZ'|'TC'|'TD'|'TF'|'TG'|'TH'|'TJ'|'TK'|'TL'|'TM'|'TN'|'TO'|'TP'|'TR'|'TT'|'TV'|'TW'|'TZ'|'UA'|'UG'|'UK'|'UM'|'US'|'UY'|'UZ'|'VA'|'VC'|'VE'|'VG'|'VI'|'VN'|'VU'|'WF'|'WS'|'YE'|'YT'|'YU'|'ZA'|'ZM'|'ZW'}
      * @return AddressInterface
      */
     public function setCountryCode($countryCode);

module/Core/src/Entity/AttachableEntityInterface.php

Doc Comments +1 added lines

@@ -22,6 +22,7 @@
     /**
      * @param AttachableEntityManager $attachableEntityManager
      * @throws \LogicException If attachable entity manager is already set
+     * @return AttachableEntityTrait
      */
     public function setAttachableEntityManager(AttachableEntityManager $attachableEntityManager);
 

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";

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)
     {

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) {

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);