Rename articleByLine to articleByline - won't affect method calls usi…

…ng old name because they're case insensitive in PHP
fivefilters · Nov 29, 2024 · e03143c · e03143c
1 parent 37d6807
commit e03143c
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ Then you pass this Configuration object to Readability. The following options ar
 
 - **MaxTopCandidates**: default value `5`, max amount of top level candidates.
 - **CharThreshold**: default value `500`, minimum amount of characters to consider that the article was parsed successful.
-- **ArticleByLine**: default value `false`, search for the article byline and remove it from the text. It will be moved to the article metadata. 
+- **ArticleByline**: default value `false`, search for the article byline and remove it from the text. It will be moved to the article metadata. 
 - **StripUnlikelyCandidates**: default value `true`, remove nodes that are unlikely to have relevant information. Useful for debugging or parsing complex or non-standard articles. 
 - **CleanConditionally**: default value `true`, remove certain nodes after parsing to return a cleaner result. 
 - **WeightClasses**: default value `true`, weight classes during the rating phase. 

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -15,7 +15,7 @@ class Configuration
 
     protected int $maxTopCandidates = 5;
     protected int $charThreshold = 500;
-    protected bool $articleByLine = false;
+    protected bool $articleByline = false;
     protected bool $stripUnlikelyCandidates = true;
     protected bool $cleanConditionally = true;
     protected bool $weightClasses = true;
@@ -119,17 +119,17 @@ public function setCharThreshold(int $charThreshold): Configuration
     /**
      * Get article by line.
      */
-    public function getArticleByLine(): bool
+    public function getArticleByline(): bool
     {
-        return $this->articleByLine;
+        return $this->articleByline;
     }
 
     /**
      * Set article by line.
      */
-    public function setArticleByLine(bool $articleByLine): Configuration
+    public function setArticleByline(bool $articleByline): Configuration
     {
-        $this->articleByLine = $articleByLine;
+        $this->articleByline = $articleByline;
 
         return $this;
     }

diff --git a/src/Readability.php b/src/Readability.php
@@ -962,7 +962,7 @@ private function textSimilarity(string $textA, string $textB): float
      */
     private function checkByline(DOMNode|DOMText|DOMElement $node, string $matchString): bool
     {
-        if (!$this->configuration->getArticleByLine()) {
+        if (!$this->configuration->getArticleByline()) {
             return false;
         }
 
@@ -987,7 +987,7 @@ private function checkByline(DOMNode|DOMText|DOMElement $node, string $matchStri
     }
 
     /**
-     * Checks the validity of a byLine. Based on string length.
+     * Checks the validity of a byline. Based on string length.
      */
     private function isValidByline(string $text): bool
     {

diff --git a/test/test-pages/001/config.json b/test/test-pages/001/config.json
@@ -1,3 +1,3 @@
 {
-  "ArticleByLine": true
+  "ArticleByline": true
 }
diff --git a/test/test-pages/aclu/config.json b/test/test-pages/aclu/config.json
@@ -1,3 +1,3 @@
 {
-  "ArticleByLine": true
+  "ArticleByline": true
 }
diff --git a/test/test-pages/ars-1/config.json b/test/test-pages/ars-1/config.json
@@ -1,3 +1,3 @@
 {
-  "ArticleByLine": true
+  "ArticleByline": true
 }
diff --git a/test/test-pages/breitbart/config.json b/test/test-pages/breitbart/config.json
@@ -1,3 +1,3 @@
 {
-  "ArticleByLine": true
+  "ArticleByline": true
 }
diff --git a/test/test-pages/fortressofsolitude/config.json b/test/test-pages/fortressofsolitude/config.json
@@ -1,3 +1,3 @@
 {
-  "ArticleByLine": true
+  "ArticleByline": true
 }
diff --git a/test/test-pages/lwn-1/config.json b/test/test-pages/lwn-1/config.json
@@ -1,3 +1,3 @@
 {
-  "ArticleByLine": true
+  "ArticleByline": true
 }
diff --git a/test/test-pages/marketwatch/config.json b/test/test-pages/marketwatch/config.json
@@ -1,4 +1,4 @@
 {
-  "ArticleByLine": true,
+  "ArticleByline": true,
   "SubstituteEntities": true
 }