PropertyCharacteristics extends BitSet
The BitSet class is a helper class to manage bit sets. It eases the work with bits and bitwise operations by providing a reliable and tested API.
only to be used within Extbase, not part of TYPO3 Core API.
Table of Contents
Constants
- ANNOTATED_LAZY = 1 << 4
- ANNOTATED_TRANSIENT = 1 << 5
- IS_STATIC = 1 << 3
- VISIBILITY_PRIVATE = 1 << 0
- VISIBILITY_PROTECTED = 1 << 1
- VISIBILITY_PUBLIC = 1 << 2
Properties
- $set : int
Methods
- __construct() : mixed
- __toInt() : int
- Returns the integer representation of the internal set.
- __toString() : string
- Returns the (binary) string representation of the internal (integer) set.
- and() : void
- Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.
- andNot() : void
- Clears all of the bits in this BitSet whose corresponding bit is set in the specified BitSet.
- clear() : void
- Sets all of the bits in this BitSet to false.
- get() : bool
- or() : void
- Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the bit set argument has the value true.
- set() : void
- Performs the same operation as {@see or()} without the need to create a BitSet instance from an integer value.
- setValue() : void
- unset() : void
- Performs the same operation as {@see andNot()} without the need to create a BitSet instance from an integer value.
- xor() : void
- Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds:
Constants
ANNOTATED_LAZY
    public
        mixed
    ANNOTATED_LAZY
    = 1 << 4
    
    
    
    
ANNOTATED_TRANSIENT
    public
        mixed
    ANNOTATED_TRANSIENT
    = 1 << 5
    
    
    
    
IS_STATIC
    public
        mixed
    IS_STATIC
    = 1 << 3
    
    
    
    
VISIBILITY_PRIVATE
    public
        mixed
    VISIBILITY_PRIVATE
    = 1 << 0
    
    
    
    
VISIBILITY_PROTECTED
    public
        mixed
    VISIBILITY_PROTECTED
    = 1 << 1
    
    
    
    
VISIBILITY_PUBLIC
    public
        mixed
    VISIBILITY_PUBLIC
    = 1 << 2
    
    
    
    
Properties
$set
        protected
            int
    $set
    
    
    
    
    
    
Methods
__construct()
    public
                    __construct([int $set = 0 ]) : mixed
    Parameters
- $set : int = 0
__toInt()
Returns the integer representation of the internal set.
    public
                    __toInt() : int
    (As PHP does not know a byte type, the internal set is already handled as an integer and can therefore directly be returned)
Return values
int__toString()
Returns the (binary) string representation of the internal (integer) set.
    public
                    __toString() : string
    Return values
stringand()
Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.
    public
                    and(BitSet $set) : void
    Parameters
- $set : BitSet
andNot()
Clears all of the bits in this BitSet whose corresponding bit is set in the specified BitSet.
    public
                    andNot(BitSet $set) : void
    Parameters
- $set : BitSet
clear()
Sets all of the bits in this BitSet to false.
    public
                    clear() : void
    get()
    public
                    get(int $bitIndex) : bool
    Parameters
- $bitIndex : int
Return values
boolor()
Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the bit set argument has the value true.
    public
                    or(BitSet $set) : void
    Parameters
- $set : BitSet
set()
Performs the same operation as {@see or()} without the need to create a BitSet instance from an integer value.
    public
                    set(int $bitIndex) : void
    Parameters
- $bitIndex : int
setValue()
    public
                    setValue(int $bitIndex, bool $value) : void
    Parameters
- $bitIndex : int
- $value : bool
unset()
Performs the same operation as {@see andNot()} without the need to create a BitSet instance from an integer value.
    public
                    unset(int $bitIndex) : void
    Parameters
- $bitIndex : int
xor()
Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds:
    public
                    xor(BitSet $set) : void
    - The bit initially has the value true, and the corresponding bit in the argument has the value false.
- The bit initially has the value false, and the corresponding bit in the argument has the value true.
Parameters
- $set : BitSet