From cbe7e31f68d4ca2bfcd53dffdb130f1f84be3343 Mon Sep 17 00:00:00 2001 From: Thomas Lange Date: Sun, 24 Oct 2021 15:54:43 +0200 Subject: Split up BigPipe "enabled" method into two methods Split up the "enabled" method of the BigPipe class into two methods, one to check if the pipelining mode is currently enabled ("isEnabled") and another one to enable/disable the pipelining mode ("setEnabled"). This change prevents that a single method has two different jobs, which can be confusing for programmers who didn't wrote the code but only use them. Now there are two clearly named methods for exactly one job. --- include/classes/BigPipe/BigPipe.php | 19 +++++++++++-------- include/classes/BigPipe/Pagelet.php | 4 ++-- 2 files changed, 13 insertions(+), 10 deletions(-) (limited to 'include/classes') diff --git a/include/classes/BigPipe/BigPipe.php b/include/classes/BigPipe/BigPipe.php index 30e3f41..6162388 100644 --- a/include/classes/BigPipe/BigPipe.php +++ b/include/classes/BigPipe/BigPipe.php @@ -15,16 +15,19 @@ class BigPipe { private static $pagelets = []; #=============================================================================== - # Enable or disable the pipeline mode + # Check if pipelining mode is enabled #=============================================================================== - public static function enabled($change = NULL) { - if($change !== NULL) { - self::$enabled = (bool) $change; - } - + public static function isEnabled(): bool { return self::$enabled; } + #=============================================================================== + # Enable or disable the pipelining mode + #=============================================================================== + public static function setEnabled(bool $enabled): void { + self::$enabled = $enabled; + } + #=============================================================================== # Insert pagelet into queue #=============================================================================== @@ -63,7 +66,7 @@ class BigPipe { if(!empty($pagelets_ordered)) { $pagelets = call_user_func_array('array_merge', $pagelets_ordered); - if(self::enabled()) { + if(self::isEnabled()) { foreach($pagelets as $Pagelet) { $Pagelet->flush(); } @@ -90,7 +93,7 @@ class BigPipe { } } - if(self::enabled()) { + if(self::isEnabled()) { echo "\n"; } } diff --git a/include/classes/BigPipe/Pagelet.php b/include/classes/BigPipe/Pagelet.php index 0358df6..bd50c4b 100644 --- a/include/classes/BigPipe/Pagelet.php +++ b/include/classes/BigPipe/Pagelet.php @@ -150,7 +150,7 @@ class Pagelet extends Item { # Flush pagelet immediately #=============================================================================== public function flush() { - if(BigPipe::enabled()) { + if(BigPipe::isEnabled()) { $pageletHTML = str_replace(["\r", "\n", "\t"], '', $this->getHTML()); $pageletHTML = str_replace('--', '--', $pageletHTML); @@ -169,7 +169,7 @@ class Pagelet extends Item { #=============================================================================== public function __toString() { $pageletHTML = "<{$this->tagName} id=\"{$this->getID()}\">"; - $pageletHTML .= !BigPipe::enabled() ? $this->getHTML() : $this->tagHTML; + $pageletHTML .= !BigPipe::isEnabled() ? $this->getHTML() : $this->tagHTML; $pageletHTML .= "tagName}>"; return $pageletHTML; -- cgit v1.2.3