markerOn/Off to checked/Unchecked

php-school · Dec 20, 2019 · 3342279 · 3342279
1 parent 91e2348
commit 3342279
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 66 deletions.
diff --git a/README.md b/README.md
@@ -821,8 +821,8 @@ use PhpSchool\CliMenu\Style\CheckboxStyle;
 
 $menu = (new CliMenuBuilder)
     ->modifyCheckboxStyle(function (CheckboxStyle $style) {
-        $style->setMarkerOff('[○] ')
-            ->setMarkerOn('[●] ');
+        $style->setUncheckedMarker('[○] ')
+            ->setCheckedMarker('[●] ');
     })
     ->build();
 ```
@@ -837,8 +837,8 @@ use PhpSchool\CliMenu\Style\RadioStyle;
 
 $menu = (new CliMenuBuilder)
     ->modifyRadioStyle(function (RadioStyle $style) {
-        $style->setMarkerOff('[ ] ')
-            ->setMarkerOn('[✔] ');
+        $style->setUncheckedMarker('[ ] ')
+            ->setCheckedMarker('[✔] ');
     })
     ->build();
 ```

diff --git a/examples/checkbox-item.php b/examples/checkbox-item.php
@@ -24,8 +24,8 @@
     ->addSubMenu('Interpreted', function (CliMenuBuilder $b) use ($itemCallable) {
         $b->setTitle('Interpreted Languages')
             ->modifyCheckboxStyle(function (CheckboxStyle $style) {
-                $style->setMarkerOff('[○] ')
-                    ->setMarkerOn('[●] ');
+                $style->setUncheckedMarker('[○] ')
+                    ->setCheckedMarker('[●] ');
             })
             ->addCheckboxItem('PHP', $itemCallable)
             ->addCheckboxItem('Javascript', $itemCallable)

diff --git a/examples/radio-item.php b/examples/radio-item.php
@@ -24,8 +24,8 @@
     ->addSubMenu('Interpreted', function (CliMenuBuilder $b) use ($itemCallable) {
         $b->setTitle('Interpreted Languages')
             ->modifyRadioStyle(function (RadioStyle $style) {
-                $style->setMarkerOff('[ ] ')
-                    ->setMarkerOn('[✔] ');
+                $style->setUncheckedMarker('[ ] ')
+                    ->setCheckedMarker('[✔] ');
             })
             ->addRadioItem('PHP', $itemCallable)
             ->addRadioItem('Javascript', $itemCallable)

diff --git a/src/Style/CheckboxStyle.php b/src/Style/CheckboxStyle.php
@@ -5,21 +5,21 @@
 class CheckboxStyle
 {
     private const DEFAULT_STYLES = [
-        'markerOn'      => '[✔] ',
-        'markerOff'     => '[ ] ',
-        'itemExtra'     => '✔',
+        'checkedMarker' => '[✔] ',
+        'uncheckedMarker' => '[ ] ',
+        'itemExtra' => '✔',
         'displaysExtra' => false,
     ];
 
     /**
      * @var string
      */
-    private $markerOn;
+    private $checkedMarker;
 
     /**
      * @var string
      */
-    private $markerOff;
+    private $uncheckedMarker;
 
     /**
      * @var string
@@ -33,17 +33,17 @@ class CheckboxStyle
 
     public function __construct()
     {
-        $this->markerOn      = self::DEFAULT_STYLES['markerOn'];
-        $this->markerOff     = self::DEFAULT_STYLES['markerOff'];
-        $this->itemExtra     = self::DEFAULT_STYLES['itemExtra'];
+        $this->checkedMarker = self::DEFAULT_STYLES['checkedMarker'];
+        $this->uncheckedMarker = self::DEFAULT_STYLES['uncheckedMarker'];
+        $this->itemExtra = self::DEFAULT_STYLES['itemExtra'];
         $this->displaysExtra = self::DEFAULT_STYLES['displaysExtra'];
     }
 
     public function hasChangedFromDefaults() : bool
     {
         $currentValues = [
-            $this->markerOn,
-            $this->markerOff,
+            $this->checkedMarker,
+            $this->uncheckedMarker,
             $this->itemExtra,
             $this->displaysExtra,
         ];
@@ -53,29 +53,29 @@ public function hasChangedFromDefaults() : bool
 
     public function getMarker(bool $selected) : string
     {
-        return $selected ? $this->markerOn : $this->markerOff;
+        return $selected ? $this->checkedMarker : $this->uncheckedMarker;
     }
 
-    public function getMarkerOn() : string
+    public function getCheckedMarker() : string
     {
-        return $this->markerOn;
+        return $this->checkedMarker;
     }
 
-    public function setMarkerOn(string $marker) : self
+    public function setCheckedMarker(string $marker) : self
     {
-        $this->markerOn = $marker;
+        $this->checkedMarker = $marker;
 
         return $this;
     }
 
-    public function getMarkerOff() : string
+    public function getUncheckedMarker() : string
     {
-        return $this->markerOff;
+        return $this->uncheckedMarker;
     }
 
-    public function setMarkerOff(string $marker) : self
+    public function setUncheckedMarker(string $marker) : self
     {
-        $this->markerOff = $marker;
+        $this->uncheckedMarker = $marker;
 
         return $this;
     }

diff --git a/src/Style/RadioStyle.php b/src/Style/RadioStyle.php
@@ -5,21 +5,21 @@
 class RadioStyle
 {
     private const DEFAULT_STYLES = [
-        'markerOn'      => '[●] ',
-        'markerOff'     => '[○] ',
-        'itemExtra'     => '✔',
+        'checkedMarker' => '[●] ',
+        'uncheckedMarker' => '[○] ',
+        'itemExtra' => '✔',
         'displaysExtra' => false,
     ];
 
     /**
      * @var string
      */
-    private $markerOn;
+    private $checkedMarker;
 
     /**
      * @var string
      */
-    private $markerOff;
+    private $uncheckedMarker;
 
     /**
      * @var string
@@ -38,17 +38,17 @@ class RadioStyle
 
     public function __construct()
     {
-        $this->markerOn      = self::DEFAULT_STYLES['markerOn'];
-        $this->markerOff     = self::DEFAULT_STYLES['markerOff'];
-        $this->itemExtra     = self::DEFAULT_STYLES['itemExtra'];
+        $this->checkedMarker = self::DEFAULT_STYLES['checkedMarker'];
+        $this->uncheckedMarker = self::DEFAULT_STYLES['uncheckedMarker'];
+        $this->itemExtra = self::DEFAULT_STYLES['itemExtra'];
         $this->displaysExtra = self::DEFAULT_STYLES['displaysExtra'];
     }
 
     public function hasChangedFromDefaults() : bool
     {
         $currentValues = [
-            $this->markerOn,
-            $this->markerOff,
+            $this->checkedMarker,
+            $this->uncheckedMarker,
             $this->itemExtra,
             $this->displaysExtra,
         ];
@@ -58,29 +58,29 @@ public function hasChangedFromDefaults() : bool
 
     public function getMarker(bool $selected) : string
     {
-        return $selected ? $this->markerOn : $this->markerOff;
+        return $selected ? $this->checkedMarker : $this->uncheckedMarker;
     }
 
-    public function getMarkerOn() : string
+    public function getCheckedMarker() : string
     {
-        return $this->markerOn;
+        return $this->checkedMarker;
     }
 
-    public function setMarkerOn(string $marker) : self
+    public function setCheckedMarker(string $marker) : self
     {
-        $this->markerOn = $marker;
+        $this->checkedMarker = $marker;
 
         return $this;
     }
 
-    public function getMarkerOff() : string
+    public function getUncheckedMarker() : string
     {
-        return $this->markerOff;
+        return $this->uncheckedMarker;
     }
 
-    public function setMarkerOff(string $marker) : self
+    public function setUncheckedMarker(string $marker) : self
     {
-        $this->markerOff = $marker;
+        $this->uncheckedMarker = $marker;
 
         return $this;
     }

diff --git a/test/MenuItem/SplitItemTest.php b/test/MenuItem/SplitItemTest.php
@@ -482,14 +482,14 @@ public function testCheckboxItem() : void
         $checkboxItem1 = new CheckboxItem('Item One', function () {
         });
         $checkboxItem1->getStyle()
-            ->setMarkerOff('[ ] ')
-            ->setMarkerOn('[✔] ');
+            ->setUncheckedMarker('[ ] ')
+            ->setCheckedMarker('[✔] ');
 
         $checkboxItem2 = new CheckboxItem('Item Two', function () {
         });
         $checkboxItem2->getStyle()
-            ->setMarkerOff('[ ] ')
-            ->setMarkerOn('[✔] ');
+            ->setUncheckedMarker('[ ] ')
+            ->setCheckedMarker('[✔] ');
 
         $item = new SplitItem(
             [
@@ -519,14 +519,14 @@ public function testRadioItem() : void
         $radioItem1 = new RadioItem('Item One', function () {
         });
         $radioItem1->getStyle()
-            ->setMarkerOn('[+] ')
-            ->setMarkerOff('[-] ');
+            ->setCheckedMarker('[+] ')
+            ->setUncheckedMarker('[-] ');
 
         $radioItem2 = new RadioItem('Item Two', function () {
         });
         $radioItem2->getStyle()
-            ->setMarkerOn('[+] ')
-            ->setMarkerOff('[-] ');
+            ->setCheckedMarker('[+] ')
+            ->setUncheckedMarker('[-] ');
 
         $item = new SplitItem(
             [

diff --git a/test/Style/CheckboxStyleTest.php b/test/Style/CheckboxStyleTest.php
@@ -26,23 +26,23 @@ public function testGetSetMarkerOn() : void
     {
         $style = new CheckboxStyle;
 
-        self::assertSame('[✔] ', $style->getMarkerOn());
+        self::assertSame('[✔] ', $style->getCheckedMarker());
 
-        $style->setMarkerOn('[x] ');
+        $style->setCheckedMarker('[x] ');
 
-        self::assertSame('[x] ', $style->getMarkerOn());
+        self::assertSame('[x] ', $style->getCheckedMarker());
         self::assertTrue($style->hasChangedFromDefaults());
     }
 
     public function testGetSetMarkerOff() : void
     {
         $style = new CheckboxStyle;
 
-        self::assertSame('[ ] ', $style->getMarkerOff());
+        self::assertSame('[ ] ', $style->getUncheckedMarker());
 
-        $style->setMarkerOff('( ) ');
+        $style->setUncheckedMarker('( ) ');
 
-        self::assertSame('( ) ', $style->getMarkerOff());
+        self::assertSame('( ) ', $style->getUncheckedMarker());
         self::assertTrue($style->hasChangedFromDefaults());
     }
 

diff --git a/test/Style/RadioStyleTest.php b/test/Style/RadioStyleTest.php
@@ -26,23 +26,23 @@ public function testGetSetMarkerOn() : void
     {
         $style = new RadioStyle;
 
-        self::assertSame('[●] ', $style->getMarkerOn());
+        self::assertSame('[●] ', $style->getCheckedMarker());
 
-        $style->setMarkerOn('[x] ');
+        $style->setCheckedMarker('[x] ');
 
-        self::assertSame('[x] ', $style->getMarkerOn());
+        self::assertSame('[x] ', $style->getCheckedMarker());
         self::assertTrue($style->hasChangedFromDefaults());
     }
 
     public function testGetSetMarkerOff() : void
     {
         $style = new RadioStyle;
 
-        self::assertSame('[○] ', $style->getMarkerOff());
+        self::assertSame('[○] ', $style->getUncheckedMarker());
 
-        $style->setMarkerOff('( ) ');
+        $style->setUncheckedMarker('( ) ');
 
-        self::assertSame('( ) ', $style->getMarkerOff());
+        self::assertSame('( ) ', $style->getUncheckedMarker());
         self::assertTrue($style->hasChangedFromDefaults());
     }