scotteh / php-goose

src/Article.php

Doc Comments +6 added lines, -6 removed lines

@@ -228,7 +228,7 @@ 
     protected $topNode;
 
     /**
-     * @param Element|null $topNode
+     * @param null|\DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -436,7 +436,7 @@ 
     protected $doc;
 
     /**
-     * @param Document $doc
+     * @param \DOMWrap\Document $doc
      *
      * @return self
      */
@@ -446,7 +446,7 @@ 
         return $this;
     }
 
-    /** @return Document */
+    /** @return \DOMWrap\Document */
     public function getDoc(): Document {
         return $this->doc;
     }
@@ -460,7 +460,7 @@ 
     protected $rawDoc;
 
     /**
-     * @param Document $rawDoc
+     * @param \DOMWrap\Document $rawDoc
      *
      * @return self
      */
@@ -470,7 +470,7 @@ 
         return $this;
     }
 
-    /** @return Document */
+    /** @return \DOMWrap\Document */
     public function getRawDoc(): Document {
         return $this->rawDoc;
     }
@@ -483,7 +483,7 @@ 
     protected $rawResponse;
 
     /**
-     * @param \Psr\Http\Message\ResponseInterface|null $rawResponse
+     * @param \Psr\Http\Message\ResponseInterface $rawResponse
      *
      * @return self
      */

src/Configuration.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 
     /**
      * @param string $option
-     * @param mixed $value
+     * @param string|null $value
      *
      * @return self
      */

src/Modules/Cleaners/DocumentCleaner.php

Doc Comments +5 added lines, -5 removed lines

@@ -190,7 +190,7 @@ 
     /**
      * Replace supplied element with <p> new element.
      *
-     * @param Element $node
+     * @param \DOMWrap\Element $node
      *
      * @return self|null
      */
@@ -244,9 +244,9 @@ 
     /**
      * Generate new <p> element with supplied content.
      *
-     * @param NodeList $replacementNodes
+     * @param \DOMWrap\NodeList $replacementNodes
      *
-     * @return Element
+     * @return \DOMWrap\Element
      */
     private function getFlushedBuffer(NodeList $replacementNodes): Element {
         $newEl = $this->document()->createElement('p');
@@ -258,9 +258,9 @@ 
     /**
      * Generate <p> element replacements for supplied elements child nodes as required.
      *
-     * @param Element $node
+     * @param \DOMWrap\Element $node
      *
-     * @return NodeList $nodesToReturn Replacement elements
+     * @return \DOMWrap\NodeList $nodesToReturn Replacement elements
      */
     private function getReplacementNodes(Element $node): NodeList {
         $nodesToReturn = $node->newNodeList();

src/Modules/Extractors/ImageExtractor.php

Doc Comments +14 added lines, -14 removed lines

@@ -57,7 +57,7 @@ 
     }
 
     /**
-     * @return Image|null
+     * @return null|\Goose\Images\Image
      */
     private function getBestImage(): ?Image {
         $image = $this->checkForKnownElements();
@@ -87,7 +87,7 @@ 
      * Prefer Twitter images (as they tend to have the right size for us), then Open Graph images
      * (which seem to be smaller), and finally linked images.
      *
-     * @return Image|null
+     * @return \Goose\Images\Image|null
      */
     private function checkForMetaTag(): ?Image {
         $image = $this->checkForTwitterTag();
@@ -120,7 +120,7 @@ 
      * 4. any images left over let's do a full GET request, download em to disk and check their dimensions
      * 5. Score images based on different factors like height/width and possibly things like color density
      *
-     * @param Element $node
+     * @param \DOMWrap\Element $node
      * @param int $parentDepthLevel
      * @param int $siblingDepthLevel
      *
@@ -158,7 +158,7 @@ 
     }
 
     /**
-     * @param Element $node
+     * @param \DOMWrap\Element $node
      * @param int $parentDepth
      * @param int $siblingDepth
      *
@@ -337,7 +337,7 @@ 
     /**
      * will check the image src against a list of bad image files we know of like buttons, etc...
      *
-     * @param Element $imageNode
+     * @param \DOMWrap\Element $imageNode
      *
      * @return bool
      */
@@ -358,7 +358,7 @@ 
     }
 
     /**
-     * @param Element $node
+     * @param \DOMWrap\Element $node
      *
      * @return LocallyStoredImage[]
      */
@@ -410,7 +410,7 @@ 
     /**
      * checks to see if we were able to find feature image tags on this page
      *
-     * @return Image|null
+     * @return null|\Goose\Images\Image
      */
     private function checkForLinkTag(): ?Image {
         return $this->checkForTag('link[rel="image_src"]', 'href', 'linktag');
@@ -419,7 +419,7 @@ 
     /**
      * checks to see if we were able to find open graph tags on this page
      *
-     * @return Image|null
+     * @return null|\Goose\Images\Image
      */
     private function checkForOpenGraphTag(): ?Image {
         return $this->checkForTag('meta[property="og:image"],meta[name="og:image"]', 'content', 'opengraph');
@@ -428,7 +428,7 @@ 
     /**
      * checks to see if we were able to find twitter tags on this page
      *
-     * @return Image|null
+     * @return null|\Goose\Images\Image
      */
     private function checkForTwitterTag(): ?Image {
         return $this->checkForTag('meta[property="twitter:image"],meta[name="twitter:image"],meta[property="twitter:image:src"],meta[name="twitter:image:src"]', 'content', 'twitter');
@@ -439,7 +439,7 @@ 
      * @param string $attr
      * @param string $type
      *
-     * @return Image|null
+     * @return null|\Goose\Images\Image
      */
     private function checkForTag(string $selector, string $attr, string $type): ?Image {
         $meta = $this->article()->getRawDoc()->find($selector);
@@ -476,9 +476,9 @@ 
     }
 
     /**
-     * @param Image $mainImage
+     * @param \Goose\Images\Image $mainImage
      *
-     * @return Image|null
+     * @return \Goose\Images\Image|null
      */
     private function ensureMinimumImageSize(Image $mainImage): ?Image {
         if ($mainImage->getWidth() >= $this->config()->get('image_min_width')
@@ -493,7 +493,7 @@ 
      * @param string $imageSrc
      * @param bool $returnAll
      *
-     * @return LocallyStoredImage|null
+     * @return \Goose\Images\LocallyStoredImage|null
      */
     private function getLocallyStoredImage(string $imageSrc, bool $returnAll = false): ?LocallyStoredImage {
         $locallyStoredImages = ImageUtils::storeImagesToLocalFile([$imageSrc], $returnAll, $this->config());
@@ -524,7 +524,7 @@ 
      *
      * @todo enable this to use a series of settings files so people can define what the image ids/classes are on specific sites
      *
-     * @return Image|null
+     * @return null|\Goose\Images\Image
      */
     private function checkForKnownElements(): ?Image {
         if (!$this->article()->getRawDoc()) {

src/Modules/Extractors/MetaExtractor.php

Doc Comments +3 added lines, -3 removed lines

@@ -149,19 +149,19 @@
     }
 
     /**
-     * @param Document $doc
+     * @param \DOMWrap\Document $doc
      * @param string $tag
      * @param string $property
      * @param string $value
      *
-     * @return NodeList
+     * @return \DOMWrap\NodeList
      */
     private function getNodesByLowercasePropertyValue(Document $doc, string $tag, string $property, string $value): NodeList {
         return $doc->findXPath("descendant::".$tag."[translate(@".$property.", 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')='".$value."']");
     }
 
     /**
-     * @param Document $doc
+     * @param \DOMWrap\Document $doc
      * @param string $property
      * @param string $value
      * @param string $attr

src/Modules/Formatters/OutputFormatter.php

Doc Comments +14 added lines, -14 removed lines

@@ -54,7 +54,7 @@ 
     /**
      * Takes an element and turns the P tags into \n\n
      *
-     * @param Element $topNode The top most node to format
+     * @param \DOMWrap\Element $topNode The top most node to format
      *
      * @return string
      */
@@ -91,7 +91,7 @@ 
     }
 
     /**
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return string
      */
@@ -106,7 +106,7 @@ 
     /**
      * cleans up and converts any nodes that should be considered text into text
      *
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -130,7 +130,7 @@ 
      * if there are elements inside our top node that have a negative gravity score, let's
      * give em the boot
      *
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -156,7 +156,7 @@ 
      *
      * replaces header tags h1 ... h6 with newline padded text
      *
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -181,7 +181,7 @@ 
     /**
      * @todo Implement
      *
-     * @param Element $item
+     * @param \DOMWrap\Element $item
      *
      * @return string
      */
@@ -192,7 +192,7 @@ 
     /**
      * remove paragraphs that have less than x number of words, would indicate that it's some sort of link
      *
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -236,7 +236,7 @@ 
     }
 
     /**
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -253,7 +253,7 @@ 
     }
 
     /**
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return bool
      */
@@ -282,8 +282,8 @@ 
     }
 
     /**
-     * @param Element $topNode
-     * @param Element $node
+     * @param \DOMWrap\Element $topNode
+     * @param \DOMWrap\Element $node
      *
      * @return bool
      */
@@ -302,7 +302,7 @@ 
     /**
      * Adds any siblings that may have a decent score to this node
      *
-     * @param Element $currentSibling
+     * @param \DOMWrap\Element $currentSibling
      * @param float $baselineScoreForSiblingParagraphs
      *
      * @return Element[]
@@ -334,7 +334,7 @@ 
     }
 
     /**
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return self
      */
@@ -363,7 +363,7 @@ 
      * of the paragraphs within the top node. For example if our total score of 10 paragraphs was 1000 but each had an average value of
      * 100 then 100 should be our base.
      *
-     * @param Element $topNode
+     * @param \DOMWrap\Element $topNode
      *
      * @return float
      */

src/Text/StopWords.php

Doc Comments +1 added lines, -1 removed lines

@@ -104,7 +104,7 @@
     /**
      * @param string $strippedInput
      *
-     * @return array
+     * @return string
      */
     public function getCandidateWords(string $strippedInput): string {
         // Simple separating words in Japanese.