Bitmask Class Reference

List of all members.

Public Member Functions
	__construct ($flags=null, $value=null)
	__set ($bit, $on)
	__get ($bit)
	__isset ($flag)
	__tostring ()
Protected Attributes
	$flags = array()
	$full = 0
	$value = 0

---

Detailed Description

Class to wrap around bitmap field functionality

Definition at line 10 of file bitmask.php.

---

Constructor & Destructor Documentation

Bitmask::__construct	(	$	flags = null,
		$	value = null
	)

Constructor. Takes an optional array parameter of bit flags to mask on.

Parameters:

	array	$flags An array of flag names
	integer	$value (optional) a combined bitmask value

Definition at line 23 of file bitmask.php.

---

Member Function Documentation

Bitmask::__get

(

$

bit

)

Magic getter method for flag status

Parameters:

bit

integer representing the mask bit to test

Returns:

boolean

Definition at line 128 of file bitmask.php.

Bitmask::__isset

(

$

flag

)

Magic check-whether-flag-exists method

Parameters:

flag

string of flag name

Returns:

boolean

Definition at line 150 of file bitmask.php.

Bitmask::__set	(	$	bit,
		$	on
	)

Magic setter method for flag values.

Parameters:

	bit	integer representing the mask bit
	on	on or off?

Definition at line 61 of file bitmask.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• system/classes/bitmask.php