PhpDoc: Fix incorrect @param and @return type hints

This commit is contained in:
Sukhwinder Dhillon 2023-08-16 11:30:23 +02:00 committed by raviks789
parent 8d55385e38
commit ee9d139a3a
25 changed files with 30 additions and 35 deletions

View File

@ -295,7 +295,7 @@ class ResourceConfigForm extends ConfigForm
* *
* @param Form $form * @param Form $form
* *
* @return Inspection * @return ?Inspection
*/ */
public static function inspectResource(Form $form) public static function inspectResource(Form $form)
{ {

View File

@ -321,7 +321,7 @@ abstract class RepositoryForm extends Form
/** /**
* Apply the requested mode on the repository * Apply the requested mode on the repository
* *
* @return bool * @return ?bool
*/ */
public function onSuccess() public function onSuccess()
{ {

View File

@ -78,7 +78,6 @@ class Benchmark
* you prefer to show either time or memory or both in your output * you prefer to show either time or memory or both in your output
* *
* @param ?int $what Whether to get time and/or memory summary * @param ?int $what Whether to get time and/or memory summary
* @return string
*/ */
public static function dump($what = null) public static function dump($what = null)
{ {

View File

@ -260,7 +260,7 @@ class Platform
/** /**
* Return the username PHP is running as * Return the username PHP is running as
* *
* @return string * @return ?string
*/ */
public static function getPhpUser() public static function getPhpUser()
{ {

View File

@ -98,7 +98,7 @@ class BarGraph extends Styleable implements Drawable
* @param array $point The * @param array $point The
* @param string $fill The fill color to use * @param string $fill The fill color to use
* @param $strokeWidth * @param $strokeWidth
* @param null $index * @param ?int $index
* *
* @return Rect * @return Rect
*/ */

View File

@ -151,7 +151,7 @@ class DateFormatter
* @param bool $timeOnly * @param bool $timeOnly
* @param bool $requireTime * @param bool $requireTime
* *
* @return string * @return ?string
*/ */
public static function timeAgo($time, $timeOnly = false, $requireTime = false) public static function timeAgo($time, $timeOnly = false, $requireTime = false)
{ {
@ -190,7 +190,7 @@ class DateFormatter
* @param bool $timeOnly * @param bool $timeOnly
* @param bool $requireTime * @param bool $requireTime
* *
* @return string * @return ?string
*/ */
public static function timeSince($time, $timeOnly = false, $requireTime = false) public static function timeSince($time, $timeOnly = false, $requireTime = false)
{ {
@ -228,7 +228,7 @@ class DateFormatter
* @param bool $timeOnly * @param bool $timeOnly
* @param bool $requireTime * @param bool $requireTime
* *
* @return string * @return ?string
*/ */
public static function timeUntil($time, $timeOnly = false, $requireTime = false) public static function timeUntil($time, $timeOnly = false, $requireTime = false)
{ {

View File

@ -94,7 +94,7 @@ class Discovery
/** /**
* Discover LDAP servers on the given domain * Discover LDAP servers on the given domain
* *
* @param string $domain The object containing the form elements * @param ?string $domain The object containing the form elements
* *
* @return Discovery True when the discovery was successful, false when the configuration was guessed * @return Discovery True when the discovery was successful, false when the configuration was guessed
*/ */

View File

@ -200,8 +200,6 @@ abstract class IniRepository extends Repository implements Extensible, Updatable
* *
* @param string $table * @param string $table
* @param ConfigObject $old * @param ConfigObject $old
*
* @return ConfigObject
*/ */
public function onDelete($table, ConfigObject $old) public function onDelete($table, ConfigObject $old)
{ {
@ -217,7 +215,7 @@ abstract class IniRepository extends Repository implements Extensible, Updatable
* @param string $table The table name for which to return a trigger method * @param string $table The table name for which to return a trigger method
* @param string $event The name of the event type * @param string $event The name of the event type
* *
* @return string * @return ?string
*/ */
protected function getTrigger($table, $event) protected function getTrigger($table, $event)
{ {

View File

@ -55,7 +55,7 @@ abstract class LdapRepository extends Repository
/** /**
* Return the given attribute name normed to known LDAP enviroments, if possible * Return the given attribute name normed to known LDAP enviroments, if possible
* *
* @param string $name * @param ?string $name
* *
* @return string * @return string
*/ */

View File

@ -783,7 +783,7 @@ abstract class Repository implements Selectable
* @param RepositoryQuery $query An optional query to pass as context * @param RepositoryQuery $query An optional query to pass as context
* (unused by the base implementation) * (unused by the base implementation)
* *
* @return string * @return ?string
* *
* @throws ProgrammingError In case a conversion rule is found but not any conversion method * @throws ProgrammingError In case a conversion rule is found but not any conversion method
*/ */
@ -930,7 +930,7 @@ abstract class Repository implements Selectable
* *
* @param string|null $value * @param string|null $value
* *
* @return int * @return ?int
* *
* @see https://tools.ietf.org/html/rfc4517#section-3.3.13 * @see https://tools.ietf.org/html/rfc4517#section-3.3.13
*/ */

View File

@ -156,7 +156,7 @@ class Controller extends ModuleActionController
/** /**
* Get the page size configured via user preferences or return the default value * Get the page size configured via user preferences or return the default value
* *
* @param int $default * @param ?int $default
* *
* @return int * @return int
*/ */

View File

@ -17,7 +17,7 @@ class FormDescriptions extends Zend_Form_Decorator_Abstract
* *
* @param string $content The html rendered so far * @param string $content The html rendered so far
* *
* @return string The updated html * @return ?string The updated html
*/ */
public function render($content = '') public function render($content = '')
{ {

View File

@ -41,7 +41,7 @@ class FormHints extends Zend_Form_Decorator_Abstract
* *
* @param string $content The html rendered so far * @param string $content The html rendered so far
* *
* @return string The updated html * @return ?string The updated html
*/ */
public function render($content = '') public function render($content = '')
{ {

View File

@ -18,7 +18,7 @@ class FormNotifications extends Zend_Form_Decorator_Abstract
* *
* @param string $content The html rendered so far * @param string $content The html rendered so far
* *
* @return string The updated html * @return ?string The updated html
*/ */
public function render($content = '') public function render($content = '')
{ {

View File

@ -72,7 +72,7 @@ class Help extends Zend_Form_Decorator_Abstract
* *
* @param string $content The html rendered so far * @param string $content The html rendered so far
* *
* @return string The updated html * @return ?string The updated html
*/ */
public function render($content = '') public function render($content = '')
{ {

View File

@ -27,7 +27,7 @@ class Spinner extends Zend_Form_Decorator_Abstract
* *
* @param string $content The html rendered so far * @param string $content The html rendered so far
* *
* @return string The updated html * @return ?string The updated html
*/ */
public function render($content = '') public function render($content = '')
{ {

View File

@ -346,7 +346,7 @@ class Navigation implements ArrayAccess, Countable, IteratorAggregate
* *
* @param string $name * @param string $name
* *
* @return NavigationItem * @return ?NavigationItem
*/ */
public function findItem($name) public function findItem($name)
{ {

View File

@ -243,7 +243,7 @@ class Url
* *
* @param string $url The url to apply the new filter to * @param string $url The url to apply the new filter to
* @param Filter $filter The base filter * @param Filter $filter The base filter
* @param Filter $optional The optional filter * @param ?Filter $optional The optional filter
* *
* @return static The altered URL containing the new filter * @return static The altered URL containing the new filter
* @throws ProgrammingError * @throws ProgrammingError

View File

@ -11,7 +11,7 @@ class IcingawebController extends DocController
/** /**
* Get the path to Icinga Web 2's documentation * Get the path to Icinga Web 2's documentation
* *
* @return string * @return ?string
* *
* @throws \Icinga\Exception\Http\HttpNotFoundException If Icinga Web 2's documentation is not available * @throws \Icinga\Exception\Http\HttpNotFoundException If Icinga Web 2's documentation is not available
*/ */

View File

@ -79,7 +79,7 @@ class SearchController extends DocController
/** /**
* Get the path to Icinga Web 2's documentation * Get the path to Icinga Web 2's documentation
* *
* @return string * @return ?string
*/ */
protected function getWebPath() protected function getWebPath()
{ {

View File

@ -223,7 +223,7 @@ class EventController extends Controller
* *
* @param string $eventType * @param string $eventType
* *
* @return string[] * @return ?string[]
*/ */
protected function getIconAndLabel($eventType) protected function getIconAndLabel($eventType)
{ {
@ -263,7 +263,7 @@ class EventController extends Controller
* @param string $type * @param string $type
* @param int $id * @param int $id
* *
* @return Queryable * @return ?Queryable
*/ */
protected function query($type, $id) protected function query($type, $id)
{ {
@ -358,7 +358,7 @@ class EventController extends Controller
* @param string $type * @param string $type
* @param \stdClass $event * @param \stdClass $event
* *
* @return string[][] * @return ?string[][]
*/ */
protected function getDetails($type, $event) protected function getDetails($type, $event)
{ {

View File

@ -64,8 +64,6 @@ class IcingaApiCommandRenderer implements IcingaCommandRendererInterface
* *
* @param array $data * @param array $data
* @param MonitoredObject $object * @param MonitoredObject $object
*
* @return array
*/ */
protected function applyFilter(array &$data, MonitoredObject $object) protected function applyFilter(array &$data, MonitoredObject $object)
{ {

View File

@ -101,7 +101,7 @@ class TimeRange implements Iterator
* *
* @param DateTime $dateTime The date and time for which to search the timeframe * @param DateTime $dateTime The date and time for which to search the timeframe
* @param bool $asTimestamp Whether the start of the timeframe should be returned as timestamp * @param bool $asTimestamp Whether the start of the timeframe should be returned as timestamp
* @return stdClass|int An object with a ´start´ and ´end´ property or a timestamp * @return stdClass|int|null An object with a ´start´ and ´end´ property or a timestamp
*/ */
public function findTimeframe(DateTime $dateTime, $asTimestamp = false) public function findTimeframe(DateTime $dateTime, $asTimestamp = false)
{ {

View File

@ -25,7 +25,7 @@ abstract class Step
/** /**
* Return a textual summary of all configuration changes made * Return a textual summary of all configuration changes made
* *
* @return array * @return ?array
*/ */
abstract public function getReport(); abstract public function getReport();
} }

View File

@ -558,7 +558,7 @@ class DbTool
* @param string $username The login name for which to check the privileges, * @param string $username The login name for which to check the privileges,
* if NULL the current login is used * if NULL the current login is used
* *
* @return bool * @return ?bool
*/ */
public function checkPrivileges(array $privileges, array $context = null, $username = null) public function checkPrivileges(array $privileges, array $context = null, $username = null)
{ {
@ -574,7 +574,7 @@ class DbTool
* *
* @param array $privileges The privileges that should be grantable * @param array $privileges The privileges that should be grantable
* *
* @return bool * @return ?bool
*/ */
public function isGrantable($privileges) public function isGrantable($privileges)
{ {
@ -680,7 +680,7 @@ class DbTool
* *
* @param string $username The username to search * @param string $username The username to search
* *
* @return bool * @return ?bool
*/ */
public function hasLogin($username) public function hasLogin($username)
{ {