Skip to content

Add method annotation to the interface #122

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.

Sign up for GitHub

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

Open
VincentLanglet wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add method annotation to the interface #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions src/Negotiation/AcceptHeader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

namespace Negotiation;

/**
* TODO: Add this methods in interface for next major version.
*
* @method string getNormalizedValue()
* @method string getValue()
* @method string getType()
* @method float getQuality()
* @method array<string, string> getParameters()
* @method string|null getParameter(string $key, string|null $default = null)
* @method bool hasParameter(string $key)
*/
interface AcceptHeader
{
}
18 changes: 9 additions & 9 deletions src/Negotiation/BaseAccept.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ abstract class BaseAccept
private $value;

/**
* @var array
* @var array<string, string>
*/
private $parameters;

Expand Down Expand Up @@ -82,18 +82,18 @@ public function getQuality()
}

/**
* @return array
* @return array<string, string>
*/
public function getParameters()
{
return $this->parameters;
}

/**
* @param string $key
* @param mixed $default
* @param string $key
* @param string|null $default
*
* @return string|null
* @return string|null
*/
public function getParameter($key, $default = null)
{
Expand All @@ -103,17 +103,17 @@ public function getParameter($key, $default = null)
/**
* @param string $key
*
* @return boolean
* @return bool
*/
public function hasParameter($key)
{
return isset($this->parameters[$key]);
}

/**
* @param string|null $acceptPart
*
* @param string|null $acceptPart
* @return array
* @return array{string, array<string, string>}
*/
private function parseParameters($acceptPart)
{
Expand All @@ -140,7 +140,7 @@ private function parseParameters($acceptPart)
}

/**
* @param string $parameters
* @param array<string, string> $parameters
*
* @return string
*/
Expand Down