bristol-su / typeform-service

src/Connectors/ApiKey.php

<?php

Missing file doc comment

namespace BristolSU\Service\Typeform\Connectors;

use BristolSU\Support\Connection\Contracts\Connector;
use FormSchema\Generator\Field;
use FormSchema\Schema\Form;
use GuzzleHttp\Exception\GuzzleException;

class ApiKey extends Connector

Missing doc comment for class ApiKey

{

    /**

Missing short description in doc comment

Parameter $method should have a doc-comment as per coding-style.

Parameter $uri should have a doc-comment as per coding-style.

Parameter $options should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public function request($method, $uri, array $options = [])
    {
        $options['base_uri'] = config('typeform_service.base_uri');
        $headers = ((isset($options['headers']) && is_array($options['headers']))?$options['headers']:[]);
        $headers['Authorization'] = 'Bearer ' . $this->getSetting('api_key');
        $options['headers'] = $headers;
        return $this->client->request($method, $uri, $options);
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function test(): bool
    {
        try {
            $this->request('get', '/me');
            return true;
        } catch (GuzzleException $e) {
            return false;
        }
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    static public function settingsSchema(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            Field::input('api_key')->inputType('text')->label('API Key')
                ->description('You should be able to find this on Typeform')->required(true)
        )->getSchema();
    }
}