PHP Class Habari\Bitmask

Show file Open project: habari/system

Protected Properties

Property Type Description
$flags
$full set of flag bit masks
$value maximum integer value of the bitmask

Public Methods

Method Description
__construct ( array $flags = null, integer $value = null ) Constructor. Takes an optional array parameter of bit flags to mask on.
__get ( integer $bit ) : boolean Magic getter method for flag status
__isset ( string $flag ) : boolean Magic check-whether-flag-exists method
__set ( string $bit, mixed $on ) : mixed Magic setter method for flag values.
__tostring ( ) : string Convert this Bitmask into a string, based ont he flags that are set

Method Details

__construct() public method

Constructor. Takes an optional array parameter of bit flags to mask on.
public __construct ( array $flags = null, integer $value = null )
$flags array An array of flag names
$value integer (optional) a combined bitmask value

__get() public method

Magic getter method for flag status
public __get ( integer $bit ) : boolean
$bit integer representing the mask bit to test
return boolean

__isset() public method

Magic check-whether-flag-exists method
public __isset ( string $flag ) : boolean
$flag string of flag name
return boolean

__set() public method

Magic setter method for flag values.
public __set ( string $bit, mixed $on ) : mixed
$bit string The name of the Bitmask part to set
$on mixed The value to set the bit to
return mixed The set value

__tostring() public method

Convert this Bitmask into a string, based ont he flags that are set
public __tostring ( ) : string
return string Converted bitmask value

Property Details

$flags protected property

protected $flags

$full protected property

set of flag bit masks
protected $full

$value protected property

maximum integer value of the bitmask
protected $value