PHP Class nspl\ds\Set

Inheritance: extends Collection
Show file Open project: ihor/Nspl Class Usage Examples

Public Methods

Method Description
__construct ( )
__toString ( ) : string
add ( mixed $element )
clear ( )
contains ( mixed $element ) : boolean
copy ( ) : Set
delete ( mixed $element ) : boolean
difference ( Set | array | Traversable $sequence ) : Set
fromArray ( array $array ) : static
intersection ( Set | array | Traversable $sequence ) : Set
isEmpty ( ) : boolean
isSubset ( Set | array | Traversable $sequence ) : boolean
isSuperset ( Set | array | Traversable $sequence ) : boolean
key ( ) : mixed (PHP 5 >= 5.0.0)
Return the key of the current element
offsetExists ( mixed $index ) : boolean (PHP 5 >= 5.0.0)
Whether a offset exists
offsetGet ( integer $index ) : mixed (PHP 5 >= 5.0.0)
Offset to retrieve
offsetSet ( integer $index, mixed $value ) : void (PHP 5 >= 5.0.0)
Offset to set
offsetUnset ( integer $index ) : void (PHP 5 >= 5.0.0)
Offset to unset
toArray ( ) : array
union ( Set | array | Traversable $sequence ) : Set
update ( array | Traversable $sequence1 )

Protected Methods

Method Description
getElementKey ( mixed $element ) : integer | string

Method Details

__construct() public method

public __construct ( )

__toString() public method

public __toString ( ) : string
return string

add() public method

public add ( mixed $element )
$element mixed

clear() public method

public clear ( )

contains() public method

public contains ( mixed $element ) : boolean
$element mixed
return boolean

copy() public method

public copy ( ) : Set
return Set

delete() public method

public delete ( mixed $element ) : boolean
$element mixed
return boolean

difference() public method

public difference ( Set | array | Traversable $sequence ) : Set
$sequence Set | array | Traversable
return Set

fromArray() public static method

public static fromArray ( array $array ) : static
$array array
return static

getElementKey() protected static method

protected static getElementKey ( mixed $element ) : integer | string
$element mixed
return integer | string

intersection() public method

public intersection ( Set | array | Traversable $sequence ) : Set
$sequence Set | array | Traversable
return Set

isEmpty() public method

public isEmpty ( ) : boolean
return boolean

isSubset() public method

public isSubset ( Set | array | Traversable $sequence ) : boolean
$sequence Set | array | Traversable
return boolean

isSuperset() public method

public isSuperset ( Set | array | Traversable $sequence ) : boolean
$sequence Set | array | Traversable
return boolean

key() public method

(PHP 5 >= 5.0.0)
Return the key of the current element
See link: http://php.net/manual/en/iterator.key.php
public key ( ) : mixed
return mixed scalar on success, or null on failure.

offsetExists() public method

(PHP 5 >= 5.0.0)
Whether a offset exists
See link: http://php.net/manual/en/arrayaccess.offsetexists.php
public offsetExists ( mixed $index ) : boolean
$index mixed

An offset to check for.

return boolean true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

offsetGet() public method

(PHP 5 >= 5.0.0)
Offset to retrieve
See link: http://php.net/manual/en/arrayaccess.offsetget.php
public offsetGet ( integer $index ) : mixed
$index integer

The offset to retrieve.

return mixed Can return all value types.

offsetSet() public method

(PHP 5 >= 5.0.0)
Offset to set
See link: http://php.net/manual/en/arrayaccess.offsetset.php
public offsetSet ( integer $index, mixed $value ) : void
$index integer

The offset to assign the value to.

$value mixed

The value to set.

return void

offsetUnset() public method

(PHP 5 >= 5.0.0)
Offset to unset
See link: http://php.net/manual/en/arrayaccess.offsetunset.php
public offsetUnset ( integer $index ) : void
$index integer

The offset to unset.

return void

toArray() public method

public toArray ( ) : array
return array

union() public method

public union ( Set | array | Traversable $sequence ) : Set
$sequence Set | array | Traversable
return Set

update() public method

public update ( array | Traversable $sequence1 )
$sequence1 array | Traversable