ilCtrlArrayIterator Class Reference

Class ilCtrlArrayIterator. More...

Inheritance diagram for ilCtrlArrayIterator:

Collaboration diagram for ilCtrlArrayIterator:

Public Member Functions
	__construct (array $data)
	ilCtrlArrayIterator Constructor More...
	current ()
	@inheritDoc More...
	next ()
	@inheritDoc More...
	key ()
	@inheritDoc More...
	valid ()
	@inheritDoc More...
	rewind ()
	@inheritDoc More...
	current ()
	@inheritDoc More...
	key ()
	@inheritDoc More...

Private Attributes
array	$data

Detailed Description

Class ilCtrlArrayIterator.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 26 of file class.ilCtrlArrayIterator.php.

Constructor & Destructor Documentation

__construct()

ilCtrlArrayIterator::__construct

(

array

$data

)

ilCtrlArrayIterator Constructor

Parameters

string[]

Definition at line 38 of file class.ilCtrlArrayIterator.php.

    {
        $this->data = $data;
    }

References $data.

Member Function Documentation

current()

ilCtrlArrayIterator::current

(

)

@inheritDoc

Implements ilCtrlIteratorInterface.

Definition at line 46 of file class.ilCtrlArrayIterator.php.

                             : ?string
    {
        if ($this->valid()) {
            return current($this->data);
        }
 
        return null;
    }

References current(), and valid().

Referenced by current(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

key()

ilCtrlArrayIterator::key

(

)

@inheritDoc

Implements ilCtrlIteratorInterface.

Definition at line 66 of file class.ilCtrlArrayIterator.php.

                         : ?string
    {
        if ($this->valid()) {
            return key($this->data);
        }
 
        return null;
    }

References key(), and valid().

Referenced by key(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

next()

ilCtrlArrayIterator::next

(

)

@inheritDoc

Definition at line 58 of file class.ilCtrlArrayIterator.php.

                          : void
    {
        next($this->data);
    }

References next().

Referenced by next(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

rewind()

ilCtrlArrayIterator::rewind

(

)

@inheritDoc

Definition at line 98 of file class.ilCtrlArrayIterator.php.

                            : void
    {
        reset($this->data);
    }

valid()

ilCtrlArrayIterator::valid

(

)

@inheritDoc

Definition at line 78 of file class.ilCtrlArrayIterator.php.

                           : bool
    {
        $value = current($this->data);
        $key = key($this->data);
 
        if (null === $key) {
            return false;
        }
 
        if (!is_string($value) || !is_string($key)) {
            $this->next();
            return $this->valid();
        }
 
        return true;
    }

References current(), key(), next(), and valid().

Referenced by current(), key(), and valid().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$data

array ilCtrlArrayIterator::$data

private

Definition at line 31 of file class.ilCtrlArrayIterator.php.

Referenced by __construct().

---

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

• components/ILIAS/UICore/classes/Iterator/class.ilCtrlArrayIterator.php