Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing PHPDoc's #100

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Api/Consumer/MessageInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ interface MessageInterface
public function setProductId(int $productId);

/**
* @return int
* @return int|null
*/
public function getProductId(): ?int;
}
7 changes: 3 additions & 4 deletions Api/Data/CategoryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

interface CategoryInterface
{

/**
* @param string $id
* @return void
Expand All @@ -30,12 +29,12 @@ public function setLeaf(bool $leaf);
public function setParent(string $parent);

/**
* @return string
* @return string|null
*/
public function getId(): ?string;

/**
* @return string
* @return string|null
*/
public function getName(): ?string;

Expand All @@ -45,7 +44,7 @@ public function getName(): ?string;
public function getLeaf(): bool;

/**
* @return string
* @return string|null
*/
public function getParent(): ?string;

Expand Down
12 changes: 11 additions & 1 deletion Api/Data/CheckoutForm/AmountInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@

interface AmountInterface
{

/**
* @param float $amount
* @return void
*/
public function setAmount(float $amount);

/**
* @return float|null
*/
public function getAmount(): ?float;

/**
* @param array $rawData
* @return void
*/
public function setRawData(array $rawData);
}
35 changes: 34 additions & 1 deletion Api/Data/CheckoutForm/BuyerInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,48 @@

interface BuyerInterface
{

/**
* @param string $firstName
* @return void
*/
public function setFirstName(string $firstName);

/**
* @param string $lastName
* @return void
*/
public function setLastName(string $lastName);

/**
* @param string $email
* @return void
*/
public function setEmail(string $email);

/**
* @param string $login
* @return void
*/
public function setLogin(string $login);

/**
* @return string|null
*/
public function getFirstName(): ?string;

/**
* @return string|null
*/
public function getLastName(): ?string;

/**
* @return string|null
*/
public function getEmail(): ?string;

/**
* @return string|null
*/
public function getLogin(): ?string;

/**
Expand Down
77 changes: 75 additions & 2 deletions Api/Data/CheckoutForm/Delivery/AddressInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,103 @@

interface AddressInterface
{

/**
* @param string $firstName
* @return void
*/
public function setFirstName(string $firstName);

/**
* @param string $lastName
* @return void
*/
public function setLastName(string $lastName);

/**
* @param string $phoneNumber
* @return void
*/
public function setPhoneNumber(string $phoneNumber);

/**
* @param string $zipCode
* @return void
*/
public function setZipCode(string $zipCode);

/**
* @param string $city
* @return void
*/
public function setCity(string $city);

/**
* @param string $city
* @return void
*/
public function setStreet(string $city);

/**
* @param string $countryCode
* @return void
*/
public function setCountryCode(string $countryCode);

/**
* @param string $companyName
* @return void
*/
public function setCompanyName(string $companyName);

/**
* @return string|null
*/
public function getFirstName(): ?string;

/**
* @return string|null
*/
public function getLastName(): ?string;

/**
* @return string|null
*/
public function getPhoneNumber(): ?string;

/**
* @return string|null
*/
public function getZipCode(): ?string;

/**
* @return string|null
*/
public function getCity(): ?string;

/**
* @return string|null
*/
public function getStreet(): ?string;

/**
* @return string|null
*/
public function getCountryCode(): ?string;

/**
* @return string|null
*/
public function getCompanyName(): ?string;

/**
* @param array $rawData
* @return void
*/
public function setRawData(array $rawData);

/**
* @param OrderAddressInterface|QuoteAddressInterface $address
* @return void
*/
public function fillAddress($address);
public function fillAddress(OrderAddressInterface|QuoteAddressInterface $address);
}
12 changes: 11 additions & 1 deletion Api/Data/CheckoutForm/Delivery/CostInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@

interface CostInterface
{

/**
* @param float $amount
* @return void
*/
public function setAmount(float $amount);

/**
* @return float|null
*/
public function getAmount(): ?float;

/**
* @param array $rawData
* @return void
*/
public function setRawData(array $rawData);
}
3 changes: 1 addition & 2 deletions Api/Data/CheckoutForm/Delivery/MethodInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@

interface MethodInterface
{

/**
* @param string $id
* @return void
*/
public function setId(string $id);

/**
* @return string
* @return string|null
*/
public function getId(): ?string;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

interface AddressInterface
{

/**
* @param string $street
* @return void
Expand Down
1 change: 0 additions & 1 deletion Api/Data/CheckoutForm/Delivery/PickupPointInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

interface PickupPointInterface
{

/**
* @param string $id
* @return void
Expand Down
3 changes: 1 addition & 2 deletions Api/Data/CheckoutForm/DeliveryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

interface DeliveryInterface
{

/**
* @param MethodInterface $method
* @return void
Expand All @@ -30,7 +29,7 @@ public function setCost(CostInterface $cost);

/**
* @param PickupPointInterface $pickupPoint
* @return mixed
* @return void
*/
public function setPickupPoint(PickupPointInterface $pickupPoint);

Expand Down
21 changes: 20 additions & 1 deletion Api/Data/CheckoutForm/Invoice/Address/CompanyInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,31 @@

interface CompanyInterface
{

/**
* @param string $name
* @return void
*/
public function setName(string $name);

/**
* @param string $vatId
* @return void
*/
public function setVatId(string $vatId);

/**
* @return string|null
*/
public function getName(): ?string;

/**
* @return string|null
*/
public function getVatId(): ?string;

/**
* @param array $rawData
* @return void
*/
public function setRawData(array $rawData);
}
21 changes: 20 additions & 1 deletion Api/Data/CheckoutForm/Invoice/Address/NaturalPersonInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,31 @@

interface NaturalPersonInterface
{

/**
* @param string $firstName
* @return void
*/
public function setFirstName(string $firstName);

/**
* @param string $lastName
* @return void
*/
public function setLastName(string $lastName);

/**
* @return string|null
*/
public function getFirstName(): ?string;

/**
* @return string|null
*/
public function getLastName(): ?string;

/**
* @param array $rawData
* @return void
*/
public function setRawData(array $rawData);
}
Loading