Skip to content

Commit 9ed1ea5

Browse files
author
Chris Zuber
authored
Merge pull request #29 from superuserdev/chore/typehint
Return `$this` for all set methods
2 parents fc0eda6 + 48635eb commit 9ed1ea5

44 files changed

Lines changed: 709 additions & 659 deletions

Some content is hidden

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

‎action.php‎

Lines changed: 62 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,45 +22,68 @@
2222
/**
2323
* @see https://schema.org/Action
2424
*/
25+
use \InvalidArgumentException;
2526
class Action extends Thing
2627
{
2728
use Traits\DateTime;
2829

29-
final public function setActionStatus(ActionStatusType $status)
30+
/**
31+
* [setActionStatus description]
32+
* @param ActionStatusType $status [description]
33+
*/
34+
final public function setActionStatus(ActionStatusType $status): self
3035
{
31-
$this->_set('actionStatus', $status);
36+
return $this->_set('actionStatus', $status);
3237
}
3338

34-
final public function setAgent(Thing $agent)
39+
/**
40+
* [setAgent description]
41+
* @param Thing $agent [description]
42+
*/
43+
final public function setAgent(Thing $agent): self
3544
{
3645
if ($agent instanceof Person or $agent instanceof Organization) {
37-
$this->_set('agent', $agent);
46+
return $this->_set('agent', $agent);
3847
} else {
39-
throw new \InvalidArgumentException(sprintf(
48+
throw new InvalidArgumentException(sprintf(
4049
'Author must be an instance of Person or Organization. Instance of %s given',
4150
$agent::getType()
4251
));
4352
}
4453
}
4554

55+
/**
56+
* [setEndDate description]
57+
* @param String $date [description]
58+
* @param boolean $use_date [description]
59+
* @param boolean $use_time [description]
60+
*/
4661
final public function setEndDate(
4762
String $date,
4863
Bool $use_date = true,
4964
Bool $use_time = true
50-
)
65+
): self
5166
{
52-
$this->_set('endDate', static::formatDateTime($date, $use_date, $use_time));
67+
return $this->_set('endDate', static::formatDateTime($date, $use_date, $use_time));
5368
}
5469

55-
final public function setError(Thing $error)
70+
/**
71+
* [setError description]
72+
* @param Thing $error [description]
73+
*/
74+
final public function setError(Thing $error): self
5675
{
57-
$this->_set('error', $error);
76+
return $this->_set('error', $error);
5877
}
5978

60-
final public function setLocation(Thing $location)
79+
/**
80+
* [setLocation description]
81+
* @param Thing $location [description]
82+
*/
83+
final public function setLocation(Thing $location): self
6184
{
6285
if ($location instanceof PostalAddress or $location instanceof Place) {
63-
$this->_set('location', $location);
86+
return $this->_set('location', $location);
6487
} else {
6588
throw new InvalidArgumentException(sprintf(
6689
'Location must be an instance of PostalAddress or Place. Instance of %s given.',
@@ -69,15 +92,23 @@ final public function setLocation(Thing $location)
6992
}
7093
}
7194

72-
final public function setObject(Thing $object)
95+
/**
96+
* [setObject description]
97+
* @param Thing $object [description]
98+
*/
99+
final public function setObject(Thing $object): self
73100
{
74-
$this->_set('object', $object);
101+
return $this->_set('object', $object);
75102
}
76103

104+
/**
105+
* [setParticipant description]
106+
* @param Thing $participant [description]
107+
*/
77108
final public function setParticipant(Thing $participant)
78109
{
79110
if ($participant instanceof Person or $participant instanceof Organization) {
80-
$this->_set('participant', $participant);
111+
return $this->_set('participant', $participant);
81112
} else {
82113
throw new InvalidArgumentException(sprintf(
83114
'Participant must be an instance of Person or Organization. Instance of %s given.',
@@ -86,22 +117,36 @@ final public function setParticipant(Thing $participant)
86117
}
87118
}
88119

120+
/**
121+
* [setResult description]
122+
* @param Thing $result [description]
123+
*/
89124
final public function setResult(Thing $result)
90125
{
91-
$this->_set('result', $result);
126+
return $this->_set('result', $result);
92127
}
93128

129+
/**
130+
* [setStartDate description]
131+
* @param String $date [description]
132+
* @param boolean $use_date [description]
133+
* @param boolean $use_time [description]
134+
*/
94135
final public function setStartDate(
95136
String $date,
96137
Bool $use_date = true,
97138
Bool $use_time = true
98139
)
99140
{
100-
$this->_set('startDate', static::formatDateTime($date, $use_date, $use_time));
141+
return $this->_set('startDate', static::formatDateTime($date, $use_date, $use_time));
101142
}
102143

144+
/**
145+
* [setTarget description]
146+
* @param EntryPoint $target [description]
147+
*/
103148
final public function setTarget(EntryPoint $target)
104149
{
105-
$this->_set('target', $target);
150+
return $this->_set('target', $target);
106151
}
107152
}

‎aggregaterating.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@
2424
*/
2525
class AggregateRating extends Rating
2626
{
27-
final public function setItemReviewed(Thing $item)
27+
final public function setItemReviewed(Thing $item): self
2828
{
29-
$this->_set('itemReviewed', $item);
29+
return $this->_set('itemReviewed', $item);
3030
}
3131

32-
final public function setRatingCount(Int $count)
32+
final public function setRatingCount(Int $count): self
3333
{
34-
$this->_set('ratingCount', $count);
34+
return $this->_set('ratingCount', $count);
3535
}
3636

37-
final public function setReviewCount(Int $count)
37+
final public function setReviewCount(Int $count): self
3838
{
39-
$this->_set('reviewCount', $count);
39+
return $this->_set('reviewCount', $count);
4040
}
4141
}

‎alignmentobject.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,30 +25,30 @@
2525

2626
class AlignmentObject extends Intangible
2727
{
28-
final public function setAlignmantType(String $type)
28+
final public function setAlignmantType(String $type): self
2929
{
30-
$this->_set('alignmentType', $type);
30+
return $this->_set('alignmentType', $type);
3131
}
3232

33-
final public function setEducationalFramework(String $framework)
33+
final public function setEducationalFramework(String $framework): self
3434
{
35-
$this->_set('educatonalFramework', $framework);
35+
return $this->_set('educatonalFramework', $framework);
3636
}
3737

38-
final public function setTargetDescription(String $description)
38+
final public function setTargetDescription(String $description): self
3939
{
40-
$this->_set('targetDescription', $description);
40+
return $this->_set('targetDescription', $description);
4141
}
4242

43-
final public function setTargetName(String $name)
43+
final public function setTargetName(String $name): self
4444
{
45-
$this->_set('targetName', $name);
45+
return $this->_set('targetName', $name);
4646
}
4747

48-
final public function setTargetUrl(String $url)
48+
final public function setTargetUrl(String $url): self
4949
{
5050
if (static::_isURL($url)) {
51-
$this->_set('targetUrl', $url);
51+
return $this->_set('targetUrl', $url);
5252
} else {
5353
throw new \InvalidArgumentException("{$url} is not a valid URL");
5454
}

‎article.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,33 +24,33 @@
2424
*/
2525
class Article extends CreativeWork
2626
{
27-
final public function setArticleBody(String $body)
27+
final public function setArticleBody(String $body): self
2828
{
29-
$this->_set('articleBody', $body);
29+
return $this->_set('articleBody', $body);
3030
}
3131

32-
final public function setArticleSection(String $section)
32+
final public function setArticleSection(String $section): self
3333
{
34-
$this->_set('articleSection', $section);
34+
return $this->_set('articleSection', $section);
3535
}
3636

37-
final public function setPageEnd(Int $end)
37+
final public function setPageEnd(Int $end): self
3838
{
39-
$this->_set('pageEnd', $end);
39+
return $this->_set('pageEnd', $end);
4040
}
4141

42-
final public function setPageStart(Int $start)
42+
final public function setPageStart(Int $start): self
4343
{
44-
$this->_set('pageStart', $start);
44+
return $this->_set('pageStart', $start);
4545
}
4646

47-
final public function setPagination(String $pagination)
47+
final public function setPagination(String $pagination): self
4848
{
49-
$this->_set('pagination', $pagination);
49+
return $this->_set('pagination', $pagination);
5050
}
5151

52-
final public function setWordCount(Int $words)
52+
final public function setWordCount(Int $words): self
5353
{
54-
$this->_set('wordCount', $words);
54+
return $this->_set('wordCount', $words);
5555
}
5656
}

‎audience.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@
2323
*/
2424
class Audience extends Intangible
2525
{
26-
final public function setAudienceType(String $type)
26+
final public function setAudienceType(String $type): self
2727
{
28-
$this->_set('audienceType', $type);
28+
return $this->_set('audienceType', $type);
2929
}
3030

31-
final public function setGeographicArea(AdministrativeArea $area)
31+
final public function setGeographicArea(AdministrativeArea $area): self
3232
{
33-
$this->_set('geographicArea', $area);
33+
return $this->_set('geographicArea', $area);
3434
}
3535
}

‎audioobject.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
*/
2525
class AudioObject extends MediaObject
2626
{
27-
final public function setTranscript(String $transcript)
27+
final public function setTranscript(String $transcript): self
2828
{
29-
$this->_set('transcript', $transcript);
29+
return $this->_set('transcript', $transcript);
3030
}
3131
}

‎book.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,54 +28,54 @@ class Book extends CreativeWork
2828
* [setAbridged description]
2929
* @param Bool $is_abridged [description]
3030
*/
31-
final public function setAbridged(Bool $is_abridged)
31+
final public function setAbridged(Bool $is_abridged): self
3232
{
33-
$this->_set('abridged', $is_abridged);
33+
return $this->_set('abridged', $is_abridged);
3434
}
3535

3636
/**
3737
* [setBookEdition description]
3838
* @param String $edition [description]
3939
*/
40-
final public function setBookEdition(String $edition)
40+
final public function setBookEdition(String $edition): self
4141
{
42-
$this->_set('bookEdition', $edition);
42+
return $this->_set('bookEdition', $edition);
4343
}
4444

4545
/**
4646
* [setBookFormat description]
4747
* @param BookFormatType $format [description]
4848
*/
49-
final public function setBookFormat(BookFormatType $format)
49+
final public function setBookFormat(BookFormatType $format): self
5050
{
51-
$this->_set('bookFormat', $format);
51+
return $this->_set('bookFormat', $format);
5252
}
5353

5454
/**
5555
* [setIllustrator description]
5656
* @param Person $illustrator [description]
5757
*/
58-
final public function setIllustrator(Person $illustrator)
58+
final public function setIllustrator(Person $illustrator): self
5959
{
60-
$this->_set('illustrator', $illustrator);
60+
return $this->_set('illustrator', $illustrator);
6161
}
6262

6363
/**
6464
* [setIsbn description]
6565
* @param String $isbn [description]
6666
* @todo Validate ISBN
6767
*/
68-
final public function setIsbn(String $isbn)
68+
final public function setIsbn(String $isbn): self
6969
{
70-
$this->_set('isbn', $isbn);
70+
return $this->_set('isbn', $isbn);
7171
}
7272

7373
/**
7474
* [setNumberOfPages description]
7575
* @param Int $pages [description]
7676
*/
77-
final public function setNumberOfPages(Int $pages)
77+
final public function setNumberOfPages(Int $pages): self
7878
{
79-
$this->_set('numberOfPages', $pages);
79+
return $this->_set('numberOfPages', $pages);
8080
}
8181
}

‎brand.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@
2323
*/
2424
class Brand extends Intangible
2525
{
26-
final public function setAggregateRating(AggregateRating $rating)
26+
final public function setAggregateRating(AggregateRating $rating): self
2727
{
28-
$this->_set('addregateRating', $rating);
28+
return $this->_set('addregateRating', $rating);
2929
}
3030

31-
final public function setLogo(ImageObject $logo)
31+
final public function setLogo(ImageObject $logo): self
3232
{
33-
$this->_set('logo', $logo);
33+
return $this->_set('logo', $logo);
3434
}
3535

36-
final public function setReview(Review $review)
36+
final public function setReview(Review $review): self
3737
{
38-
$this->_set('review', $review);
38+
return $this->_set('review', $review);
3939
}
4040
}

0 commit comments

Comments
 (0)