ILIAS\Mail\Autoresponder\AutoresponderArrayCollection Class Reference

Inheritance diagram for ILIAS\Mail\Autoresponder\AutoresponderArrayCollection:

Collaboration diagram for ILIAS\Mail\Autoresponder\AutoresponderArrayCollection:

Public Member Functions
	__construct (private array $elements=[])
	getIterator ()
	offsetExists (int $offset)
	offsetGet (int $offset)
	offsetSet (int $offset, AutoresponderDto $value)
	offsetUnset (int $offset)
	count ()
	add (AutoresponderDto $element)
	remove ($key)
	removeElement (AutoresponderDto $element)
	containsKey ($key)
	getKey (AutoresponderDto $element)
	clear ()
	contains (AutoresponderDto $element)
	get ($key)
	set ($key, AutoresponderDto $value)
	isEmpty ()
	getKeys ()
	getValues ()
	filter (callable $callable)
	slice (int $offset, ?int $length=null)
	toArray ()
	equals ($other)
	add (AutoresponderDto $element)
	remove ($key)
	removeElement (AutoresponderDto $element)
	containsKey ($key)
	getKey (AutoresponderDto $element)
	clear ()
	contains (AutoresponderDto $element)
	get ($key)
	set ($key, AutoresponderDto $value)
	isEmpty ()
	getKeys ()
	getValues ()
	filter (callable $callable)
	slice (int $offset, ?int $length=null)
	toArray ()
	equals ($other)

Detailed Description

Definition at line 26 of file AutoresponderArrayCollection.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::__construct

(

private array

$elements = []

)

Parameters

AutoresponderDto[]|array<int|string,AutoresponderDto>

$elements

Definition at line 31 of file AutoresponderArrayCollection.php.

    {
    }

Member Function Documentation

add()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::add

(

AutoresponderDto

$element

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 71 of file AutoresponderArrayCollection.php.

                                                  : void
    {
        $this->elements[] = $element;
    }

Referenced by ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\offsetSet().

Here is the caller graph for this function:

clear()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::clear

(

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 107 of file AutoresponderArrayCollection.php.

                           : void
    {
        $this->elements = [];
    }

contains()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::contains

(

AutoresponderDto

$element

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 112 of file AutoresponderArrayCollection.php.

                                                       : bool
    {
        return \in_array($element, $this->elements, true);
    }

containsKey()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::containsKey

(

$key

)

Parameters

int | string

$key

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 93 of file AutoresponderArrayCollection.php.

                                     : bool
    {
        return isset($this->elements[$key]);
    }

Referenced by ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\offsetExists(), and ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\remove().

Here is the caller graph for this function:

count()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::count

(

)

Definition at line 66 of file AutoresponderArrayCollection.php.

                           : int
    {
        return \count($this->elements);
    }

equals()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::equals

(

$other

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 159 of file AutoresponderArrayCollection.php.

                                  : bool
    {
        if (!$other instanceof self) {
            return false;
        }
 
        $self = $this->toArray();
        $other = $other->toArray();
 
        sort($self);
        sort($other);
 
        return $self === $other;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort(), and ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\toArray().

Here is the call graph for this function:

filter()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::filter

(

callable

$callable

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 142 of file AutoresponderArrayCollection.php.

                                              : AutoresponderCollection
    {
        $filtered = array_filter($this->elements, $callable);
        return new self($filtered);
    }

get()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::get

(

$key

)

Parameters

int | string

$key

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 117 of file AutoresponderArrayCollection.php.

                             : ?AutoresponderDto
    {
        return $this->elements[$key] ?? null;
    }

getIterator()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::getIterator

(

)

Definition at line 35 of file AutoresponderArrayCollection.php.

                                 : ArrayIterator
    {
        return new ArrayIterator($this->elements);
    }

getKey()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::getKey

(

AutoresponderDto

$element

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 98 of file AutoresponderArrayCollection.php.

                                                     : int
    {
        $key = array_search($element, $this->elements, true);
        if ($key === false) {
            throw new InvalidArgumentException('Could not find an key for the passed element.');
        }
        return $key;
    }

getKeys()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::getKeys

(

)

Returns

array<int|string> $key

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 132 of file AutoresponderArrayCollection.php.

                             : array
    {
        return array_keys($this->elements);
    }

getValues()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::getValues

(

)

Returns

AutoresponderDto[] $

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 137 of file AutoresponderArrayCollection.php.

                               : array
    {
        return array_values($this->elements);
    }

isEmpty()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::isEmpty

(

)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 127 of file AutoresponderArrayCollection.php.

                             : bool
    {
        return empty($this->elements);
    }

offsetExists()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::offsetExists

(

int

$offset

)

Definition at line 40 of file AutoresponderArrayCollection.php.

                                             : bool
    {
        return $this->containsKey($offset);
    }

References ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\containsKey().

Here is the call graph for this function:

offsetGet()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::offsetGet

(

int

$offset

)

Definition at line 45 of file AutoresponderArrayCollection.php.

                                          : AutoresponderDto
    {
        return $this->get($offset);
    }

offsetSet()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::offsetSet	(	int	$offset,
		AutoresponderDto	$value
	)

Definition at line 50 of file AutoresponderArrayCollection.php.

                                                                   : void
    {
        if (!isset($offset)) {
            $this->add($value);
 
            return;
        }
 
        $this->set($offset, $value);
    }

References ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\add().

Here is the call graph for this function:

offsetUnset()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::offsetUnset

(

int

$offset

)

Definition at line 61 of file AutoresponderArrayCollection.php.

                                            : void
    {
        $this->remove($offset);
    }

remove()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::remove

(

$key

)

Parameters

string | int

$key

Exceptions

InvalidArgumentException

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 76 of file AutoresponderArrayCollection.php.

                                : void
    {
        if (!$this->containsKey($key)) {
            throw new InvalidArgumentException("Key $key does not exist.");
        }
        unset($this->elements[$key]);
    }

References ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\containsKey().

Here is the call graph for this function:

removeElement()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::removeElement

(

AutoresponderDto

$element

)

Exceptions

InvalidArgumentException

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 84 of file AutoresponderArrayCollection.php.

                                                            : void
    {
        $key = array_search($element, $this->elements, true);
        if ($key === false) {
            throw new InvalidArgumentException('Could not find an key for the passed element.');
        }
        unset($this->elements[$key]);
    }

set()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::set	(		$key,
		AutoresponderDto	$value
	)

Parameters

int | string

$key

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 122 of file AutoresponderArrayCollection.php.

                                                      : void
    {
        $this->elements[$key] = $value;
    }

slice()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::slice	(	int	$offset,
		?int	$length = null
	)

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 148 of file AutoresponderArrayCollection.php.

                                                           : AutoresponderCollection
    {
        $sliced = \array_slice($this->elements, $offset, $length, true);
        return new self($sliced);
    }

toArray()

ILIAS\Mail\Autoresponder\AutoresponderArrayCollection::toArray

(

)

Returns

AutoresponderDto[]|array<int|string, AutoresponderDto>

Implements ILIAS\Mail\Autoresponder\AutoresponderCollection.

Definition at line 154 of file AutoresponderArrayCollection.php.

                             : array
    {
        return $this->elements;
    }

Referenced by ILIAS\Mail\Autoresponder\AutoresponderArrayCollection\equals().

Here is the caller graph for this function:

---

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

• components/ILIAS/Mail/classes/Autoresponder/AutoresponderArrayCollection.php