updated PHPDoc

fpvcode · Nov 28, 2023 · ef82b65 · ef82b65
1 parent 88f3115
commit ef82b65
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 0 deletions.
diff --git a/src/MinifyCSS.php b/src/MinifyCSS.php
@@ -6,19 +6,44 @@
 
 use MatthiasMullie\Minify;
 
+/**
+ * [Description MinifyCSS].
+ */
 class MinifyCSS extends ShrinkWrap {
+    /**
+     * @var array
+     */
     private $available_engines = ['matthiasmullie', 'regex'];
 
+    /**
+     * @var string
+     */
     private $engine;
+
+    /**
+     * @var array
+     */
     private $options;
 
+    /**
+     * @var mixed
+     */
     private $minifier;
 
+    /**
+     * @param string $engine
+     * @param array  $options
+     */
     public function __construct(string $engine = 'matthiasmullie', array $options = []) {
         in_array($engine, $this->available_engines) ? $this->engine = $engine : $this->engine = 'matthiasmullie';
         $this->options = $options;
     }
 
+    /**
+     * @param null|string $data
+     *
+     * @return null|mixed
+     */
     public function init(string $data = null) {
         switch ($this->engine) {
             case 'matthiasmullie':
@@ -28,13 +53,23 @@ public function init(string $data = null) {
         }
     }
 
+    /**
+     * @param null|string $data
+     *
+     * @return null|mixed
+     */
     public function minify(string $data = null) {
         switch ($this->engine) {
             case 'matthiasmullie':
                 return $this->minifier->minify($data);
         }
     }
 
+    /**
+     * @param string $data
+     *
+     * @return null|mixed
+     */
     public function add(string $data) {
         switch ($this->engine) {
             case 'matthiasmullie':

diff --git a/src/MinifyHTML.php b/src/MinifyHTML.php
@@ -6,14 +6,33 @@
 
 use voku\helper\HtmlMin;
 
+/**
+ * [Description MinifyHTML].
+ */
 class MinifyHTML extends ShrinkWrap {
+    /**
+     * @var array
+     */
     private $available_engines = ['voku', 'regex'];
 
+    /**
+     * @var string
+     */
     private $engine;
+
+    /**
+     * @var array
+     */
     private $options;
 
+    /**
+     * @var mixed
+     */
     private $minifier;
 
+    /**
+     * @var array
+     */
     private $voku_options = [
         'doOptimizeViaHtmlDomParser'                   => false, // optimize html via "HtmlDomParser()"
         'doRemoveComments'                             => false, // remove default HTML comments (depends on "doOptimizeViaHtmlDomParser(true)")
@@ -41,11 +60,20 @@ class MinifyHTML extends ShrinkWrap {
         'doRemoveOmittedHtmlTags'                      => false, // remove ommitted html tags e.g. <p>lall</p> => <p>lall
     ];
 
+    /**
+     * @param string $engine
+     * @param array  $options
+     */
     public function __construct(string $engine = 'voku', array $options = []) {
         in_array($engine, $this->available_engines) ? $this->engine = $engine : $this->engine = 'voku';
         $this->options = $options;
     }
 
+    /**
+     * @param null|string $data
+     *
+     * @return null|mixed
+     */
     public function init(string $data = null) {
         switch ($this->engine) {
             case 'voku':
@@ -62,6 +90,11 @@ public function init(string $data = null) {
         }
     }
 
+    /**
+     * @param null|string $data
+     *
+     * @return null|mixed
+     */
     public function minify(string $data = null) {
         switch ($this->engine) {
             case 'voku':

diff --git a/src/MinifyJS.php b/src/MinifyJS.php
@@ -6,19 +6,44 @@
 
 use MatthiasMullie\Minify;
 
+/**
+ * [Description MinifyJS].
+ */
 class MinifyJS extends ShrinkWrap {
+    /**
+     * @var array
+     */
     private $available_engines = ['matthiasmullie', 'regex'];
 
+    /**
+     * @var string
+     */
     private $engine;
+
+    /**
+     * @var array
+     */
     private $options;
 
+    /**
+     * @var mixed
+     */
     private $minifier;
 
+    /**
+     * @param string $engine
+     * @param array  $options
+     */
     public function __construct(string $engine = 'matthiasmullie', array $options = []) {
         in_array($engine, $this->available_engines) ? $this->engine = $engine : $this->engine = 'matthiasmullie';
         $this->options = $options;
     }
 
+    /**
+     * @param null|string $data
+     *
+     * @return null|mixed
+     */
     public function init(string $data = null) {
         switch ($this->engine) {
             case 'matthiasmullie':
@@ -28,13 +53,23 @@ public function init(string $data = null) {
         }
     }
 
+    /**
+     * @param null|string $data
+     *
+     * @return null|mixed
+     */
     public function minify(string $data = null) {
         switch ($this->engine) {
             case 'matthiasmullie':
                 return $this->minifier->minify($data);
         }
     }
 
+    /**
+     * @param string $data
+     *
+     * @return null|mixed
+     */
     public function add(string $data) {
         switch ($this->engine) {
             case 'matthiasmullie':

diff --git a/src/ShrinkWrap.php b/src/ShrinkWrap.php
@@ -98,6 +98,10 @@ public function __construct() {
         $this->domparser = new HTML5();
     }
 
+    /**
+     * @param mixed $method
+     * @param mixed $args
+     */
     public function __call($method, $args) {
         echo "Calling unknown object method '{$method}' " . json_encode($args) . "\n";
     }