vendor/reinder83/binary-flags/src/BinaryFlags.php line 55

Open in your IDE?
  1. <?php
  3. namespace Reinder83\BinaryFlags;
  5. use Countable;
  6. use Iterator;
  7. use JsonSerializable;
  9. /**
  10.  * This class holds useful methods for checking, adding or removing binary flags
  11.  *
  12.  * @author Reinder
  13.  */
  14. abstract class BinaryFlags implements Iterator, Countable, JsonSerializable
  15. {
  16.     use Traits\BinaryFlags;
  18.     /**
  19.      * @var int
  20.      */
  21.     private $currentPos = 0;
  23.     /**
  24.      * Initiate class
  25.      * @param int [$mask = 0]
  26.      * @param callable [$onModify = null]
  27.      */
  28.     public function __construct($mask = 0, callable $onModify = null)
  29.     {
  30.         $this->setMask($mask);
  32.         // set onModify callback if specified
  33.         if ($onModify !== null) {
  34.             $this->setOnModifyCallback($onModify);
  35.         }
  36.     }
  38.     /**
  39.      * Return the current element
  40.      *
  41.      * @return string the description of the flag or the name of the constant
  42.      * @since 1.2.0
  43.      */
  44.     public function current()
  45.     {
  46.         return $this->getFlagNames($this->currentPos);
  47.     }
  49.     /**
  50.      * Move forward to next element
  51.      *
  52.      * @return void
  53.      * @since 1.2.0
  54.      */
  55.     public function next()
  56.     {
  57.         $this->currentPos <<= 1; // shift to next bit
  58.         while (($this->mask & $this->currentPos) == 0 && $this->currentPos > 0) {
  59.             $this->currentPos <<= 1;
  60.         }
  61.     }
  63.     /**
  64.      * Return the key of the current element
  65.      *
  66.      * @return int the flag
  67.      * @since 1.2.0
  68.      */
  69.     public function key()
  70.     {
  71.         return $this->currentPos;
  72.     }
  74.     /**
  75.      * Checks if current position is valid
  76.      *
  77.      * @return boolean Returns true on success or false on failure.
  78.      * @since 1.2.0
  79.      */
  80.     public function valid()
  81.     {
  82.         return $this->currentPos > 0;
  83.     }
  85.     /**
  86.      * Rewind the Iterator to the first element
  87.      *
  88.      * @return void
  89.      * @since 1.2.0
  90.      */
  91.     public function rewind()
  92.     {
  93.         // find the first element
  94.         if ($this->mask === 0) {
  95.             $this->currentPos = 0;
  97.             return;
  98.         }
  100.         $this->currentPos = 1;
  101.         while (($this->mask & $this->currentPos) == 0) {
  102.             $this->currentPos <<= 1;
  103.         }
  104.     }
  106.     /**
  107.      * Returns the number of flags that are set
  108.      *
  109.      * @return int
  110.      *
  111.      * The return value is cast to an integer.
  112.      * @since 1.2.0
  113.      */
  114.     public function count()
  115.     {
  116.         $count = 0;
  117.         $mask  = $this->mask;
  119.         while ($mask != 0) {
  120.             if (($mask & 1) == 1) {
  121.                 $count++;
  122.             }
  123.             $mask >>= 1;
  124.         }
  126.         return $count;
  127.     }
  129.     /**
  130.      * Specify data which should be serialized to JSON
  131.      *
  132.      * @return mixed data which can be serialized by <b>json_encode</b>,
  133.      * @since 1.2.0
  134.      */
  135.     public function jsonSerialize()
  136.     {
  137.         return ['mask' => $this->mask];
  138.     }
  139. }