Add @var annotations to XmlTypeCheck class
authorUmherirrender <umherirrender_de.wp@web.de>
Sat, 29 Jun 2019 22:28:30 +0000 (00:28 +0200)
committerUmherirrender <umherirrender_de.wp@web.de>
Sat, 29 Jun 2019 22:56:59 +0000 (22:56 +0000)
Also fix type of XmlTypeCheck::elementOpen argument

Change-Id: Ia54464e98440992b435eac89f14b7e60fe812f62

includes/libs/mime/XmlTypeCheck.php

index 0b52391..65cc54b 100644 (file)
 
 class XmlTypeCheck {
        /**
-        * Will be set to true or false to indicate whether the file is
+        * @var bool|null Will be set to true or false to indicate whether the file is
         * well-formed XML. Note that this doesn't check schema validity.
         */
        public $wellFormed = null;
 
        /**
-        * Will be set to true if the optional element filter returned
+        * @var bool Will be set to true if the optional element filter returned
         * a match at some point.
         */
        public $filterMatch = false;
@@ -46,30 +46,30 @@ class XmlTypeCheck {
        public $filterMatchType = false;
 
        /**
-        * Name of the document's root element, including any namespace
+        * @var string Name of the document's root element, including any namespace
         * as an expanded URL.
         */
        public $rootElement = '';
 
        /**
-        * A stack of strings containing the data of each xml element as it's processed. Append
-        * data to the top string of the stack, then pop off the string and process it when the
+        * @var string[] A stack of strings containing the data of each xml element as it's processed.
+        * Append data to the top string of the stack, then pop off the string and process it when the
         * element is closed.
         */
        protected $elementData = [];
 
        /**
-        * A stack of element names and attributes, as we process them.
+        * @var array A stack of element names and attributes, as we process them.
         */
        protected $elementDataContext = [];
 
        /**
-        * Current depth of the data stack.
+        * @var int Current depth of the data stack.
         */
        protected $stackDepth = 0;
 
        /**
-        * Additional parsing options
+        * @var array Additional parsing options
         */
        private $parserOptions = [
                'processing_instruction_handler' => null,
@@ -308,7 +308,7 @@ class XmlTypeCheck {
 
        /**
         * @param string $name
-        * @param string $attribs
+        * @param array $attribs
         */
        private function elementOpen( $name, $attribs ) {
                $this->elementDataContext[] = [ $name, $attribs ];