Skip to content

Commit 275479b

Browse files
umherirrenderWMDE bot
authored andcommitted
Add function documentation to private functions
Bug: T330644 Depends-On: I2914498869ee8dbee20ca8196ac70b7b70e83b44 Depends-On: I69fb434d5840af45977d0fbc8026faab274e3866 Depends-On: I9db4e5fa87a6d84300c5f9f4e3eddf497ec31739 Change-Id: I1c42b94b1b6683b78b2b4d326bdbecc3353935d3
1 parent 010b36b commit 275479b

11 files changed

Lines changed: 74 additions & 0 deletions

src/Deserializers/AliasGroupListDeserializer.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ private function deserializeAliasGroup( array $serialization, $languageCode ) {
7171
return new AliasGroup( (string)$languageCode, $aliases );
7272
}
7373

74+
/**
75+
* @param array $serialization
76+
* @param string $requestedLanguage
77+
*/
7478
private function assertIsValidAliasSerialization( $serialization, $requestedLanguage ) {
7579
if ( !is_array( $serialization ) ) {
7680
throw new DeserializationException( 'Term serializations must be arrays' );
@@ -86,6 +90,10 @@ private function assertIsValidAliasSerialization( $serialization, $requestedLang
8690
$this->assertRequestedAndActualLanguageMatch( $serialization, $requestedLanguage );
8791
}
8892

93+
/**
94+
* @param array $array
95+
* @param string $attributeName
96+
*/
8997
private function requireAttribute( array $array, $attributeName ) {
9098
if ( !array_key_exists( $attributeName, $array ) ) {
9199
throw new MissingAttributeException(
@@ -94,6 +102,10 @@ private function requireAttribute( array $array, $attributeName ) {
94102
}
95103
}
96104

105+
/**
106+
* @param array $array
107+
* @param string $key
108+
*/
97109
private function assertNotAttribute( array $array, $key ) {
98110
if ( array_key_exists( $key, $array ) ) {
99111
throw new InvalidAttributeException(
@@ -104,6 +116,10 @@ private function assertNotAttribute( array $array, $key ) {
104116
}
105117
}
106118

119+
/**
120+
* @param array $serialization
121+
* @param string $requestedLanguage
122+
*/
107123
private function assertRequestedAndActualLanguageMatch(
108124
array $serialization,
109125
$requestedLanguage
@@ -117,10 +133,19 @@ private function assertRequestedAndActualLanguageMatch(
117133
}
118134
}
119135

136+
/**
137+
* @param array $array
138+
* @param string $attributeName
139+
*/
120140
private function assertAttributeIsArray( array $array, $attributeName ) {
121141
$this->assertAttributeInternalType( $array, $attributeName, 'array' );
122142
}
123143

144+
/**
145+
* @param array $array
146+
* @param string $attributeName
147+
* @param string $internalType
148+
*/
124149
private function assertAttributeInternalType( array $array, $attributeName, $internalType ) {
125150
if ( gettype( $array[$attributeName] ) !== $internalType ) {
126151
throw new InvalidAttributeException(

src/Deserializers/ReferenceDeserializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ public function isDeserializerFor( $serialization ) {
3737
return $this->isValidSerialization( $serialization );
3838
}
3939

40+
/**
41+
* @param mixed $serialization
42+
*/
4043
private function isValidSerialization( $serialization ): bool {
4144
return is_array( $serialization ) && array_key_exists( 'snaks', $serialization );
4245
}

src/Deserializers/SiteLinkDeserializer.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ private function getDeserializeBadges( array $serialization ): array {
6666
return $badges;
6767
}
6868

69+
/**
70+
* @param string $serialization
71+
*/
6972
private function deserializeItemId( $serialization ): ItemId {
7073
$itemId = $this->entityIdDeserializer->deserialize( $serialization );
7174

@@ -80,6 +83,9 @@ private function deserializeItemId( $serialization ): ItemId {
8083
return $itemId;
8184
}
8285

86+
/**
87+
* @param array $serialization
88+
*/
8389
private function assertBadgesIsArray( $serialization ) {
8490
if ( !is_array( $serialization['badges'] ) ) {
8591
throw new InvalidAttributeException(
@@ -90,11 +96,18 @@ private function assertBadgesIsArray( $serialization ) {
9096
}
9197
}
9298

99+
/**
100+
* @param array $serialization
101+
*/
93102
private function assertCanDeserialize( $serialization ) {
94103
$this->requireAttribute( $serialization, 'site' );
95104
$this->requireAttribute( $serialization, 'title' );
96105
}
97106

107+
/**
108+
* @param array $serialization
109+
* @param string $attribute
110+
*/
98111
private function requireAttribute( $serialization, $attribute ) {
99112
if ( !is_array( $serialization ) || !array_key_exists( $attribute, $serialization ) ) {
100113
throw new MissingAttributeException( $attribute );

src/Deserializers/SnakDeserializer.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@ private function deserializeDataValue( PropertyId $propertyId, array $serializat
137137
}
138138
}
139139

140+
/**
141+
* @param array $serialization
142+
*/
140143
private function assertValidDataValue( $serialization ): void {
141144
if ( !is_array( $serialization ) || !array_key_exists( DataValueDeserializer::TYPE_KEY, $serialization ) ) {
142145
throw new MissingTypeException( 'Not an array or missing the key "' . DataValueDeserializer::TYPE_KEY . '"' );
@@ -184,6 +187,9 @@ private function deserializePropertyId( string $serialization ): PropertyId {
184187
);
185188
}
186189

190+
/**
191+
* @param array $serialization
192+
*/
187193
private function assertCanDeserialize( $serialization ): void {
188194
if ( !is_array( $serialization ) ) {
189195
throw new DeserializationException( 'The snak serialization should be an array' );

src/Deserializers/TermDeserializer.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ private function assertCanDeserialize( $serialization ) {
5555
$this->assertAttributeIsString( $serialization, 'value' );
5656
}
5757

58+
/**
59+
* @param array $array
60+
* @param string $attributeName
61+
*/
5862
private function assertAttributeIsString( array $array, $attributeName ) {
5963
if ( !is_string( $array[$attributeName] ) ) {
6064
throw new InvalidAttributeException(

src/Deserializers/TermListDeserializer.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ private function getDeserialized( array $serialization ) {
6262
return $termList;
6363
}
6464

65+
/**
66+
* @param array $serialization
67+
* @param string $requestedLanguage
68+
*/
6569
private function assertRequestedAndActualLanguageMatch(
6670
array $serialization,
6771
$requestedLanguage
@@ -75,6 +79,10 @@ private function assertRequestedAndActualLanguageMatch(
7579
}
7680
}
7781

82+
/**
83+
* @param array $array
84+
* @param string $attributeName
85+
*/
7886
private function assertAttributeIsArray( array $array, $attributeName ) {
7987
if ( !is_array( $array[$attributeName] ) ) {
8088
throw new InvalidAttributeException(

src/Serializers/AliasGroupListSerializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ public function serialize( $object ) {
3333
return $this->serializeMap( $this->generateSerializedArrayRepresentation( $object ) );
3434
}
3535

36+
/**
37+
* @param AliasGroupList $object
38+
*/
3639
private function assertIsSerializerFor( $object ) {
3740
if ( !( $object instanceof AliasGroupList ) ) {
3841
throw new UnsupportedObjectException(

src/Serializers/AliasGroupSerializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ public function serialize( $object ) {
2727
return $this->getSerialized( $object );
2828
}
2929

30+
/**
31+
* @param AliasGroup $object
32+
*/
3033
private function assertIsSerializerFor( $object ) {
3134
if ( !( $object instanceof AliasGroup ) ) {
3235
throw new UnsupportedObjectException(

src/Serializers/TermListSerializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ public function serialize( $object ) {
3737
return $this->serializeMap( $this->generateSerializedArrayRepresentation( $object ) );
3838
}
3939

40+
/**
41+
* @param TermList $object
42+
*/
4043
private function assertIsSerializerFor( $object ) {
4144
if ( !( $object instanceof TermList ) ) {
4245
throw new UnsupportedObjectException(

src/Serializers/TermSerializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ public function serialize( $object ) {
2525
return $this->getSerialized( $object );
2626
}
2727

28+
/**
29+
* @param Term $object
30+
*/
2831
private function assertIsSerializerFor( $object ) {
2932
if ( !( $object instanceof Term ) ) {
3033
throw new UnsupportedObjectException(

0 commit comments

Comments
 (0)