Skip to content

Commit 11a7f77

Browse files
committed
Merge pull request #599 from wmde/propertyType
More specific data type documentation in Property
2 parents f5279b1 + f4597a1 commit 11a7f77

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

src/Entity/Property.php

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class Property extends Entity implements StatementListHolder {
3333
private $fingerprint;
3434

3535
/**
36-
* @var string
36+
* @var string The data type of the property.
3737
*/
3838
private $dataTypeId;
3939

@@ -47,7 +47,8 @@ class Property extends Entity implements StatementListHolder {
4747
*
4848
* @param PropertyId|null $id
4949
* @param Fingerprint|null $fingerprint
50-
* @param string $dataTypeId
50+
* @param string $dataTypeId The data type of the property. Not to be confused with the data
51+
* value type.
5152
* @param StatementList|null $statements Since 1.1
5253
*/
5354
public function __construct(
@@ -144,13 +145,14 @@ public function setAliases( $languageCode, array $aliases ) {
144145
/**
145146
* @since 0.4
146147
*
147-
* @param string $dataTypeId
148+
* @param string $dataTypeId The data type of the property. Not to be confused with the data
149+
* value type.
148150
*
149151
* @throws InvalidArgumentException
150152
*/
151153
public function setDataTypeId( $dataTypeId ) {
152154
if ( !is_string( $dataTypeId ) ) {
153-
throw new InvalidArgumentException( '$dataTypeId must be a string; got ' . gettype( $dataTypeId ) );
155+
throw new InvalidArgumentException( '$dataTypeId must be a string' );
154156
}
155157

156158
$this->dataTypeId = $dataTypeId;
@@ -159,7 +161,8 @@ public function setDataTypeId( $dataTypeId ) {
159161
/**
160162
* @since 0.4
161163
*
162-
* @return string
164+
* @return string Returns the data type of the property (property type). Not to be confused with
165+
* the data value type.
163166
*/
164167
public function getDataTypeId() {
165168
return $this->dataTypeId;
@@ -179,7 +182,8 @@ public function getType() {
179182
/**
180183
* @since 0.3
181184
*
182-
* @param string $dataTypeId
185+
* @param string $dataTypeId The data type of the property. Not to be confused with the data
186+
* value type.
183187
*
184188
* @return Property
185189
*/

0 commit comments

Comments
 (0)