Skip to content
This repository was archived by the owner on May 24, 2024. It is now read-only.

Commit fe60437

Browse files
committed
Document the return values of setters.
1 parent f791c2a commit fe60437

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

src/Model/ZoneEntityInterface.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,48 +10,62 @@ interface ZoneEntityInterface extends ZoneInterface
1010
* Sets the zone id.
1111
*
1212
* @param string $id The zone id.
13+
*
14+
* @return self
1315
*/
1416
public function setId($id);
1517

1618
/**
1719
* Sets the zone name.
1820
*
1921
* @param string $name The zone name.
22+
*
23+
* @return self
2024
*/
2125
public function setName($name);
2226

2327
/**
2428
* Sets the zone scope.
2529
*
2630
* @param string $scope The zone scope.
31+
*
32+
* @return self
2733
*/
2834
public function setScope($scope);
2935

3036
/**
3137
* Sets the zone priority.
3238
*
3339
* @param int $priority The zone priority.
40+
*
41+
* @return self
3442
*/
3543
public function setPriority($priority);
3644

3745
/**
3846
* Sets the zone members.
3947
*
4048
* @param ZoneMemberEntityInterface[] $members The zone members.
49+
*
50+
* @return self
4151
*/
4252
public function setMembers(Collection $members);
4353

4454
/**
4555
* Adds a zone member.
4656
*
4757
* @param ZoneMemberEntityInterface $member The zone member.
58+
*
59+
* @return self
4860
*/
4961
public function addMember(ZoneMemberEntityInterface $member);
5062

5163
/**
5264
* Removes a zone member.
5365
*
5466
* @param ZoneMemberEntityInterface $member The zone member.
67+
*
68+
* @return self
5569
*/
5670
public function removeMember(ZoneMemberEntityInterface $member);
5771

src/Model/ZoneMemberCountry.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ public function getCountryCode()
7373
* Sets the country code.
7474
*
7575
* @param string $countryCode The country code.
76+
*
77+
* @return self
7678
*/
7779
public function setCountryCode($countryCode)
7880
{
@@ -95,6 +97,8 @@ public function getAdministrativeArea()
9597
* Sets the administrative area.
9698
*
9799
* @param string|null $administrativeArea The administrative area.
100+
*
101+
* @return self
98102
*/
99103
public function setAdministrativeArea($administrativeArea = null)
100104
{
@@ -117,6 +121,8 @@ public function getLocality()
117121
* Sets the locality.
118122
*
119123
* @param string|null $locality The locality.
124+
*
125+
* @return self
120126
*/
121127
public function setLocality($locality = null)
122128
{
@@ -139,6 +145,8 @@ public function getDependentLocality()
139145
* Sets the dependent locality.
140146
*
141147
* @param string|null $dependentLocality The dependent locality.
148+
*
149+
* @return self
142150
*/
143151
public function setDependentLocality($dependentLocality = null)
144152
{
@@ -161,6 +169,8 @@ public function getIncludedPostalCodes()
161169
* Sets the included postal codes.
162170
*
163171
* @param string $includedPostalCodes The included postal codes.
172+
*
173+
* @return self
164174
*/
165175
public function setIncludedPostalCodes($includedPostalCodes)
166176
{
@@ -183,6 +193,8 @@ public function getExcludedPostalCodes()
183193
* Sets the excluded postal codes.
184194
*
185195
* @param string $excludedPostalCodes The excluded postal codes.
196+
*
197+
* @return self
186198
*/
187199
public function setExcludedPostalCodes($excludedPostalCodes)
188200
{

src/Model/ZoneMemberEntityInterface.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,26 @@ interface ZoneMemberEntityInterface extends ZoneMemberInterface
1010
* Sets the zone member id.
1111
*
1212
* @param string $id The zone member id.
13+
*
14+
* @return self
1315
*/
1416
public function setId($id);
1517

1618
/**
1719
* Sets the zone member name.
1820
*
1921
* @param string $name The zone member name.
22+
*
23+
* @return self
2024
*/
2125
public function setName($name);
2226

2327
/**
2428
* Sets the parent zone.
2529
*
2630
* @param ZoneEntityInterface|null $parentZone The parent zone.
31+
*
32+
* @return self
2733
*/
2834
public function setParentZone(ZoneEntityInterface $parentZone = null);
2935
}

src/Model/ZoneMemberZone.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ public function getZone()
3838
* Sets the zone.
3939
*
4040
* @param ZoneEntityInterface $zone The zone matched by the zone member.
41+
*
42+
* @return self
4143
*/
4244
public function setZone(ZoneEntityInterface $zone)
4345
{

0 commit comments

Comments
 (0)