aliyun / openapi-sdk-php-client

src/Credentials/Ini/CreateTrait.php

<?php

namespace AlibabaCloud\Client\Credentials\Ini;

use AlibabaCloud\Client\SDK;
use AlibabaCloud\Client\Clients\Client;
use AlibabaCloud\Client\Clients\AccessKeyClient;
use AlibabaCloud\Client\Clients\RamRoleArnClient;
use AlibabaCloud\Client\Clients\RsaKeyPairClient;
use AlibabaCloud\Client\Clients\EcsRamRoleClient;
use AlibabaCloud\Client\Exception\ClientException;
use AlibabaCloud\Client\Clients\BearerTokenClient;

/**
 * Trait CreateTrait
 *
 * @package   AlibabaCloud\Client\Credentials\Ini
 *
 * @mixin     IniCredential
 */
trait CreateTrait
{
    /**
     * @param string $clientName
     * @param array  $credential
     *
     * @return Client|bool
     * @throws ClientException
     */
    protected function createClient($clientName, array $credential)
    {
        if (!isset($credential['enable']) || !$credential['enable']) {
            return false;
        }

        if (!isset($credential['type'])) {
            $this->missingRequired('type', $clientName);

It seems like missingRequired() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $this->createClientByType($clientName, $credential)->name($clientName);
    }

    /**
     * @param string $clientName
     * @param array  $credential
     *
     * @return AccessKeyClient|BearerTokenClient|EcsRamRoleClient|RamRoleArnClient|RsaKeyPairClient
     * @throws ClientException
     */
    private function createClientByType($clientName, array $credential)
    {
        switch (\strtolower($credential['type'])) {
            case 'access_key':
                return $this->accessKeyClient($clientName, $credential);
            case 'ecs_ram_role':
                return $this->ecsRamRoleClient($clientName, $credential);
            case 'ram_role_arn':
                return $this->ramRoleArnClient($clientName, $credential);
            case 'bearer_token':
                return $this->bearerTokenClient($clientName, $credential);
            case 'rsa_key_pair':
                return $this->rsaKeyPairClient($clientName, $credential);
            default:
                throw new ClientException(
                    "Invalid type '{$credential['type']}' for '$clientName' in {$this->filename}",
                    SDK::INVALID_CREDENTIAL
                );
        }
    }

    /**
     * @param array  $credential
     * @param string $clientName
     *
     * @return AccessKeyClient
     * @throws ClientException
     */
    private function accessKeyClient($clientName, array $credential)
    {
        if (!isset($credential['access_key_id'])) {
            $this->missingRequired('access_key_id', $clientName);
        }

        if (!isset($credential['access_key_secret'])) {
            $this->missingRequired('access_key_secret', $clientName);
        }

        return new AccessKeyClient(
            $credential['access_key_id'],
            $credential['access_key_secret']
        );
    }

    /**
     * @param string $clientName
     * @param array  $credential
     *
     * @return EcsRamRoleClient
     * @throws ClientException
     */
    private function ecsRamRoleClient($clientName, array $credential)
    {
        if (!isset($credential['role_name'])) {
            $this->missingRequired('role_name', $clientName);
        }

        return new EcsRamRoleClient($credential['role_name']);
    }

    /**
     * @param string $clientName
     * @param array  $credential
     *
     * @return RamRoleArnClient
     * @throws ClientException
     */
    private function ramRoleArnClient($clientName, array $credential)
    {
        if (!isset($credential['access_key_id'])) {
            $this->missingRequired('access_key_id', $clientName);
        }

        if (!isset($credential['access_key_secret'])) {
            $this->missingRequired('access_key_secret', $clientName);
        }

        if (!isset($credential['role_arn'])) {
            $this->missingRequired('role_arn', $clientName);
        }

        if (!isset($credential['role_session_name'])) {
            $this->missingRequired('role_session_name', $clientName);
        }

        return new RamRoleArnClient(
            $credential['access_key_id'],
            $credential['access_key_secret'],
            $credential['role_arn'],
            $credential['role_session_name']
        );
    }

    /**
     * @param string $clientName
     * @param array  $credential
     *
     * @return BearerTokenClient
     * @throws ClientException
     */
    private function bearerTokenClient($clientName, array $credential)
    {
        if (!isset($credential['bearer_token'])) {
            $this->missingRequired('bearer_token', $clientName);
        }

        return new BearerTokenClient($credential['bearer_token']);
    }

    /**
     * @param array  $credential
     * @param string $clientName
     *
     * @return RsaKeyPairClient
     * @throws ClientException
     */
    private function rsaKeyPairClient($clientName, array $credential)
    {
        if (!isset($credential['public_key_id'])) {
            $this->missingRequired('public_key_id', $clientName);
        }

        if (!isset($credential['private_key_file'])) {
            $this->missingRequired('private_key_file', $clientName);
        }

        return new RsaKeyPairClient(
            $credential['public_key_id'],
            $credential['private_key_file']
        );
    }
}