Resources/PhpOffice/PhpWord/Collection/AbstractCollection.php

<?php
/**
 * This file is part of PHPWord - A pure PHP library for reading and writing
 * word processing documents.
 *
 * PHPWord is free software distributed under the terms of the GNU Lesser
 * General Public License version 3 as published by the Free Software Foundation.
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code. For the full list of
 * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
 *
 * @see         https://github.com/PHPOffice/PHPWord
 *
 * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
 */

namespace PhpOffice\PhpWord\Collection;

/**
 * Collection abstract class.
 *
 * @since 0.10.0
 */
abstract class AbstractCollection
{
    /**
     * Items.
     *
     * @var \PhpOffice\PhpWord\Element\AbstractContainer[]
     */
    private $items = [];

    /**
     * Get items.
     *
     * @return \PhpOffice\PhpWord\Element\AbstractContainer[]
     */
    public function getItems()
    {
        return $this->items;
    }

    /**
     * Get item by index.
     *
     * @param int $index
     *
     * @return \PhpOffice\PhpWord\Element\AbstractContainer
     */
    public function getItem($index)
    {
        if (\array_key_exists($index, $this->items)) {
            return $this->items[$index];
        }

        return null;
    }

    /**
     * Set item.
     *
     * @param int $index
     * @param \PhpOffice\PhpWord\Element\AbstractContainer $item
     */
    public function setItem($index, $item): void
    {
        if (\array_key_exists($index, $this->items)) {
            $this->items[$index] = $item;
        }
    }

    /**
     * Add new item.
     *
     * @param \PhpOffice\PhpWord\Element\AbstractContainer $item
     *
     * @return int
     */
    public function addItem($item)
    {
        $index = $this->countItems() + 1;
        $this->items[$index] = $item;

        return $index;
    }

    /**
     * Get item count.
     *
     * @return int
     */
    public function countItems()
    {
        return \count($this->items);
    }
}