CloudConfigTrait.php

<?php
/**
 * This file is part of the Cloudinary PHP package.
 *
 * (c) Cloudinary
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cloudinary\Configuration;

/**
 * Trait CloudConfigTrait
 *
 */
trait CloudConfigTrait
{
    /**
     * Sets the name of your Cloudinary cloud.
     *
     * @param string $cloudName The name of your Cloudinary cloud.
     *                          Used to build the public URL for all your media assets.
     *
     * @return $this
     *
     * @api
     */
    public function cloudName(string $cloudName): static
    {
        return $this->setCloudConfig(CloudConfig::CLOUD_NAME, $cloudName);
    }

    /**
     * Sets the OAuth2.0 token.
     *
     * @param ?string $oauthToken Used instead of API key and API secret
     *
     * @return $this
     *
     * @api
     */
    public function oauthToken(?string $oauthToken): static
    {
        return $this->setCloudConfig(CloudConfig::OAUTH_TOKEN, $oauthToken);
    }

    /**
     * Sets the signature algorithm.
     *
     * @param string $signatureAlgorithm The algorithm to use. (Can be SHA1 or SHA256).
     *
     * @return $this
     *
     * @api
     */
    public function signatureAlgorithm(string $signatureAlgorithm): static
    {
        return $this->setCloudConfig(CloudConfig::SIGNATURE_ALGORITHM, $signatureAlgorithm);
    }

    /**
     * Sets the signature version.
     *
     * @param int $signatureVersion The signature version to use. (Can be 1 or 2).
     *
     * @return $this
     *
     * @api
     */
    public function signatureVersion(int $signatureVersion): static
    {
        return $this->setCloudConfig(CloudConfig::SIGNATURE_VERSION, $signatureVersion);
    }

    /**
     * Sets the Cloud configuration key with the specified value.
     *
     * @param string $configKey   The configuration key.
     * @param mixed  $configValue THe configuration value.
     *
     * @return $this
     *
     * @internal
     */
    abstract public function setCloudConfig(string $configKey, mixed $configValue): static;
}