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

Commit

Permalink
Document the return values of setters.
Browse files Browse the repository at this point in the history
  • Loading branch information
bojanz committed Oct 3, 2015
1 parent f791c2a commit fe60437
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/Model/ZoneEntityInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,48 +10,62 @@ interface ZoneEntityInterface extends ZoneInterface
* Sets the zone id.
*
* @param string $id The zone id.
*
* @return self
*/
public function setId($id);

/**
* Sets the zone name.
*
* @param string $name The zone name.
*
* @return self
*/
public function setName($name);

/**
* Sets the zone scope.
*
* @param string $scope The zone scope.
*
* @return self
*/
public function setScope($scope);

/**
* Sets the zone priority.
*
* @param int $priority The zone priority.
*
* @return self
*/
public function setPriority($priority);

/**
* Sets the zone members.
*
* @param ZoneMemberEntityInterface[] $members The zone members.
*
* @return self
*/
public function setMembers(Collection $members);

/**
* Adds a zone member.
*
* @param ZoneMemberEntityInterface $member The zone member.
*
* @return self
*/
public function addMember(ZoneMemberEntityInterface $member);

/**
* Removes a zone member.
*
* @param ZoneMemberEntityInterface $member The zone member.
*
* @return self
*/
public function removeMember(ZoneMemberEntityInterface $member);

Expand Down
12 changes: 12 additions & 0 deletions src/Model/ZoneMemberCountry.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ public function getCountryCode()
* Sets the country code.
*
* @param string $countryCode The country code.
*
* @return self
*/
public function setCountryCode($countryCode)
{
Expand All @@ -95,6 +97,8 @@ public function getAdministrativeArea()
* Sets the administrative area.
*
* @param string|null $administrativeArea The administrative area.
*
* @return self
*/
public function setAdministrativeArea($administrativeArea = null)
{
Expand All @@ -117,6 +121,8 @@ public function getLocality()
* Sets the locality.
*
* @param string|null $locality The locality.
*
* @return self
*/
public function setLocality($locality = null)
{
Expand All @@ -139,6 +145,8 @@ public function getDependentLocality()
* Sets the dependent locality.
*
* @param string|null $dependentLocality The dependent locality.
*
* @return self
*/
public function setDependentLocality($dependentLocality = null)
{
Expand All @@ -161,6 +169,8 @@ public function getIncludedPostalCodes()
* Sets the included postal codes.
*
* @param string $includedPostalCodes The included postal codes.
*
* @return self
*/
public function setIncludedPostalCodes($includedPostalCodes)
{
Expand All @@ -183,6 +193,8 @@ public function getExcludedPostalCodes()
* Sets the excluded postal codes.
*
* @param string $excludedPostalCodes The excluded postal codes.
*
* @return self
*/
public function setExcludedPostalCodes($excludedPostalCodes)
{
Expand Down
6 changes: 6 additions & 0 deletions src/Model/ZoneMemberEntityInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,26 @@ interface ZoneMemberEntityInterface extends ZoneMemberInterface
* Sets the zone member id.
*
* @param string $id The zone member id.
*
* @return self
*/
public function setId($id);

/**
* Sets the zone member name.
*
* @param string $name The zone member name.
*
* @return self
*/
public function setName($name);

/**
* Sets the parent zone.
*
* @param ZoneEntityInterface|null $parentZone The parent zone.
*
* @return self
*/
public function setParentZone(ZoneEntityInterface $parentZone = null);
}
2 changes: 2 additions & 0 deletions src/Model/ZoneMemberZone.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ public function getZone()
* Sets the zone.
*
* @param ZoneEntityInterface $zone The zone matched by the zone member.
*
* @return self
*/
public function setZone(ZoneEntityInterface $zone)
{
Expand Down

0 comments on commit fe60437

Please sign in to comment.