ObjectConfigBuilderInterface.php

<?php

/*
 * This file is part of the Klipper package.
 *
 * (c) François Pluchino <francois.pluchino@klipper.dev>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Klipper\Component\DefaultValue;

use Klipper\Component\DefaultValue\Exception\BadMethodCallException;

/**
 * @author François Pluchino <francois.pluchino@klipper.dev>
 */
interface ObjectConfigBuilderInterface extends ObjectConfigInterface
{
    /**
     * Set the types.
     *
     * @param ResolvedObjectTypeInterface $type The type of the object default value
     *
     * @return static
     */
    public function setType(ResolvedObjectTypeInterface $type);

    /**
     * Sets the data of the object default value.
     *
     * @param mixed $data The data of the object default value
     *
     * @return static
     */
    public function setData($data);

    /**
     * Sets the value for an property.
     *
     * @param string $name  The name of the property
     * @param mixed  $value The value of the property
     *
     * @return static
     *
     * @throws BadMethodCallException When the data is empty
     */
    public function setProperty(string $name, $value);

    /**
     * Sets the properties.
     *
     * @param array $properties The properties
     *
     * @return static
     *
     * @throws BadMethodCallException When the data is empty
     */
    public function setProperties(array $properties);

    /**
     * Builds and returns the object default value configuration.
     */
    public function getObjectConfig(): ObjectConfigInterface;
}