<?php

/*
 * The MIT License
 *
 * Copyright (c) 2024 "YooMoney", NBСO LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace YooKassa\Model;

use ArrayIterator;
use Countable;
use Iterator;
use IteratorAggregate;
use ReturnTypeWillChange;
use YooKassa\Common\AbstractObject;

/**
 * Metadata - Метаданные платежа указанные мерчантом.
 * Мерчант может добавлять произвольные данные к платежам в виде набора пар ключ-значение.
 * Имена ключей уникальны.
 */
class Metadata extends AbstractObject implements IteratorAggregate, Countable
{
    /**
     * {@inheritdoc}
     */
    public function toArray(): array
    {
        return $this->getUnknownProperties();
    }

    #[ReturnTypeWillChange]
    /**
     * Возвращает объект ArrayIterator для метаданных.
     */
    public function getIterator(): Iterator
    {
        return new ArrayIterator($this->getUnknownProperties());
    }

    #[ReturnTypeWillChange]
    /**
     * Возвращает количество метаданных.
     */
    public function count(): int
    {
        return count($this->getUnknownProperties());
    }
}
