aboutsummaryrefslogtreecommitdiff
path: root/lib/Minz/Extension.php
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2022-01-01 11:26:56 +0100
committerGravatar GitHub <noreply@github.com> 2022-01-01 11:26:56 +0100
commit3f6aa42b817145a3b00f4d615f87728b55c4413a (patch)
treee5b31941b0acc3a2f4c47e4846afcfe987b9852f /lib/Minz/Extension.php
parent77e9877316fcfacb26799afdf32d94c8411da80e (diff)
Fix most PHPDocs errors (#4107)
Contributes to https://github.com/FreshRSS/FreshRSS/issues/4103 https://phpstan.org/writing-php-code/phpdoc-types
Diffstat (limited to 'lib/Minz/Extension.php')
-rw-r--r--lib/Minz/Extension.php25
1 files changed, 11 insertions, 14 deletions
diff --git a/lib/Minz/Extension.php b/lib/Minz/Extension.php
index 6637ab895..82f9a0631 100644
--- a/lib/Minz/Extension.php
+++ b/lib/Minz/Extension.php
@@ -34,7 +34,7 @@ abstract class Minz_Extension {
* - version: a version for the current extension.
* - type: "system" or "user" (default).
*
- * @param $meta_info contains information about the extension.
+ * @param array<string> $meta_info contains information about the extension.
*/
final public function __construct($meta_info) {
$this->name = $meta_info['name'];
@@ -51,8 +51,7 @@ abstract class Minz_Extension {
/**
* Used when installing an extension (e.g. update the database scheme).
*
- * @return true if the extension has been installed or a string explaining
- * the problem.
+ * @return string|true true if the extension has been installed or a string explaining the problem.
*/
public function install() {
return true;
@@ -62,8 +61,7 @@ abstract class Minz_Extension {
* Used when uninstalling an extension (e.g. revert the database scheme to
* cancel changes from install).
*
- * @return true if the extension has been uninstalled or a string explaining
- * the problem.
+ * @return string|true true if the extension has been uninstalled or a string explaining the problem.
*/
public function uninstall() {
return true;
@@ -85,7 +83,7 @@ abstract class Minz_Extension {
/**
* Return if the extension is currently enabled.
*
- * @return true if extension is enabled, false else.
+ * @return string|true true if extension is enabled, false otherwise.
*/
public function isEnabled() {
return $this->is_enabled;
@@ -94,7 +92,7 @@ abstract class Minz_Extension {
/**
* Return the content of the configure view for the current extension.
*
- * @return string html content from ext_dir/configure.phtml, false if it does not exist.
+ * @return string|false html content from ext_dir/configure.phtml, false if it does not exist.
*/
public function getConfigureView() {
$filename = $this->path . '/configure.phtml';
@@ -146,9 +144,9 @@ abstract class Minz_Extension {
/**
* Return the url for a given file.
*
- * @param $filename name of the file to serve.
- * @param $type the type (js or css) of the file to serve.
- * @param $isStatic indicates if the file is a static file or a user file. Default is static.
+ * @param string $filename name of the file to serve.
+ * @param string $type the type (js or css) of the file to serve.
+ * @param bool $isStatic indicates if the file is a static file or a user file. Default is static.
* @return string url corresponding to the file.
*/
public function getFileUrl($filename, $type, $isStatic = true) {
@@ -169,8 +167,7 @@ abstract class Minz_Extension {
/**
* Register a controller in the Dispatcher.
*
- * @param @base_name the base name of the controller. Final name will be:
- * FreshExtension_<base_name>_Controller.
+ * @param string $base_name the base name of the controller. Final name will be FreshExtension_<base_name>_Controller.
*/
public function registerController($base_name) {
Minz_Dispatcher::registerController($base_name, $this->path);
@@ -194,8 +191,8 @@ abstract class Minz_Extension {
/**
* Register a new hook.
*
- * @param $hook_name the hook name (must exist).
- * @param $hook_function the function name to call (must be callable).
+ * @param string $hook_name the hook name (must exist).
+ * @param callable-string $hook_function the function name to call (must be callable).
*/
public function registerHook($hook_name, $hook_function) {
Minz_ExtensionManager::addHook($hook_name, $hook_function, $this);