Skip to content

Commit f3ab251

Browse files
xabbuhxabbuh
committed
use scalar and return type hints
1 parent 105acf6 commit f3ab251

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+297
-313
lines changed

‎src/Account.php

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ final class Account
2828
*/
2929
private $homePage;
3030

31-
/**
32-
* @param string $name
33-
* @param IRL $homePage
34-
*/
35-
public function __construct($name, IRL $homePage)
31+
public function __construct(string $name, IRL $homePage)
3632
{
3733
$this->name = $name;
3834
$this->homePage = $homePage;
@@ -43,7 +39,7 @@ public function __construct($name, IRL $homePage)
4339
*
4440
* @return string The user name
4541
*/
46-
public function getName()
42+
public function getName(): string
4743
{
4844
return $this->name;
4945
}
@@ -53,7 +49,7 @@ public function getName()
5349
*
5450
* @return IRL The home page
5551
*/
56-
public function getHomePage()
52+
public function getHomePage(): IRL
5753
{
5854
return $this->homePage;
5955
}
@@ -67,7 +63,7 @@ public function getHomePage()
6763
*
6864
* @return bool True if the accounts are equal, false otherwise
6965
*/
70-
public function equals(Account $account)
66+
public function equals(Account $account): bool
7167
{
7268
if ($this->name !== $account->name) {
7369
return false;

‎src/Activity.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ final class Activity extends StatementObject
2424
private $id;
2525

2626
/**
27-
* @var Definition The Activity's {@link Definition}
27+
* @var Definition|null The Activity's {@link Definition}
2828
*/
2929
private $definition;
3030

3131
/**
32-
* @param IRI $id
33-
* @param Definition $definition
32+
* @param IRI $id
33+
* @param Definition|null $definition
3434
*/
3535
public function __construct(IRI $id, Definition $definition = null)
3636
{
@@ -43,25 +43,25 @@ public function __construct(IRI $id, Definition $definition = null)
4343
*
4444
* @return IRI The identifier
4545
*/
46-
public function getId()
46+
public function getId(): IRI
4747
{
4848
return $this->id;
4949
}
5050

5151
/**
5252
* Returns the Activity's {@link Definition}.
5353
*
54-
* @return Definition The Definition
54+
* @return Definition|null The Definition
5555
*/
56-
public function getDefinition()
56+
public function getDefinition(): ?Definition
5757
{
5858
return $this->definition;
5959
}
6060

6161
/**
6262
* {@inheritdoc}
6363
*/
64-
public function equals(StatementObject $object)
64+
public function equals(StatementObject $object): bool
6565
{
6666
if ('Xabbuh\XApi\Model\Activity' !== get_class($object)) {
6767
return false;

‎src/ActivityProfile.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,7 @@ final class ActivityProfile extends Profile
2323
*/
2424
private $activity;
2525

26-
/**
27-
* @param string $profileId
28-
* @param Activity $activity
29-
*/
30-
public function __construct($profileId, Activity $activity)
26+
public function __construct(string $profileId, Activity $activity)
3127
{
3228
parent::__construct($profileId);
3329

@@ -39,7 +35,7 @@ public function __construct($profileId, Activity $activity)
3935
*
4036
* @return Activity The activity
4137
*/
42-
public function getActivity()
38+
public function getActivity(): Activity
4339
{
4440
return $this->activity;
4541
}

‎src/ActivityProfileDocument.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public function __construct(ActivityProfile $profile, DocumentData $data)
3535
*
3636
* @return ActivityProfile The activity profile
3737
*/
38-
public function getActivityProfile()
38+
public function getActivityProfile(): ActivityProfile
3939
{
4040
return $this->profile;
4141
}

‎src/Actor.php

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,7 @@ abstract class Actor extends StatementObject
3131
*/
3232
private $name;
3333

34-
/**
35-
* @param InverseFunctionalIdentifier|null $iri
36-
* @param string|null $name
37-
*/
38-
public function __construct(InverseFunctionalIdentifier $iri = null, $name = null)
34+
public function __construct(InverseFunctionalIdentifier $iri = null, string $name = null)
3935
{
4036
$this->iri = $iri;
4137
$this->name = $name;
@@ -46,7 +42,7 @@ public function __construct(InverseFunctionalIdentifier $iri = null, $name = nul
4642
*
4743
* @return InverseFunctionalIdentifier|null The inverse functional identifier
4844
*/
49-
public function getInverseFunctionalIdentifier()
45+
public function getInverseFunctionalIdentifier(): ?InverseFunctionalIdentifier
5046
{
5147
return $this->iri;
5248
}
@@ -56,7 +52,7 @@ public function getInverseFunctionalIdentifier()
5652
*
5753
* @return string|null The name
5854
*/
59-
public function getName()
55+
public function getName(): ?string
6056
{
6157
return $this->name;
6258
}
@@ -70,7 +66,7 @@ public function getName()
7066
*
7167
* @return bool True if the actors are equal, false otherwise
7268
*/
73-
public function equals(StatementObject $actor)
69+
public function equals(StatementObject $actor): bool
7470
{
7571
if (!parent::equals($actor)) {
7672
return false;

‎src/Agent.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818
*/
1919
final class Agent extends Actor
2020
{
21-
public function __construct(InverseFunctionalIdentifier $iri, $name = null)
21+
public function __construct(InverseFunctionalIdentifier $iri, string $name = null)
2222
{
2323
parent::__construct($iri, $name);
2424
}
2525

2626
/**
2727
* {@inheritdoc}
2828
*/
29-
public function equals(StatementObject $actor)
29+
public function equals(StatementObject $actor): bool
3030
{
3131
if (!parent::equals($actor)) {
3232
return false;

‎src/AgentProfile.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ final class AgentProfile extends Profile
2323
*/
2424
private $agent;
2525

26-
public function __construct($profileId, Agent $agent)
26+
public function __construct(string $profileId, Agent $agent)
2727
{
2828
parent::__construct($profileId);
2929

@@ -35,7 +35,7 @@ public function __construct($profileId, Agent $agent)
3535
*
3636
* @return Agent The agent
3737
*/
38-
public function getAgent()
38+
public function getAgent(): Agent
3939
{
4040
return $this->agent;
4141
}

‎src/AgentProfileDocument.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public function __construct(AgentProfile $profile, DocumentData $data)
3535
*
3636
* @return AgentProfile The agent profile
3737
*/
38-
public function getAgentProfile()
38+
public function getAgentProfile(): AgentProfile
3939
{
4040
return $this->profile;
4141
}

‎src/Attachment.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ final class Attachment
3838
* @param string|null $content The raw attachment content, please note that the content is not validated against
3939
* the given SHA-2 hash
4040
*/
41-
public function __construct(IRI $usageType, $contentType, $length, $sha2, LanguageMap $display, LanguageMap $description = null, IRL $fileUrl = null, $content = null)
41+
public function __construct(IRI $usageType, string $contentType, int $length, string $sha2, LanguageMap $display, LanguageMap $description = null, IRL $fileUrl = null, string $content = null)
4242
{
4343
if (null === $fileUrl && null === $content) {
4444
throw new \InvalidArgumentException('An attachment cannot be created without a file URL or raw content data.');
@@ -54,47 +54,47 @@ public function __construct(IRI $usageType, $contentType, $length, $sha2, Langua
5454
$this->content = $content;
5555
}
5656

57-
public function getUsageType()
57+
public function getUsageType(): IRI
5858
{
5959
return $this->usageType;
6060
}
6161

62-
public function getContentType()
62+
public function getContentType(): string
6363
{
6464
return $this->contentType;
6565
}
6666

67-
public function getLength()
67+
public function getLength(): int
6868
{
6969
return $this->length;
7070
}
7171

72-
public function getSha2()
72+
public function getSha2(): string
7373
{
7474
return $this->sha2;
7575
}
7676

77-
public function getDisplay()
77+
public function getDisplay(): LanguageMap
7878
{
7979
return $this->display;
8080
}
8181

82-
public function getDescription()
82+
public function getDescription(): ?LanguageMap
8383
{
8484
return $this->description;
8585
}
8686

87-
public function getFileUrl()
87+
public function getFileUrl(): ?IRL
8888
{
8989
return $this->fileUrl;
9090
}
9191

92-
public function getContent()
92+
public function getContent(): ?string
9393
{
9494
return $this->content;
9595
}
9696

97-
public function equals(Attachment $attachment)
97+
public function equals(Attachment $attachment): bool
9898
{
9999
if (!$this->usageType->equals($attachment->usageType)) {
100100
return false;

0 commit comments

Comments
 (0)