OperationDefinitionObject.php

Go to the documentation of this file.

<?php
namespace Magento\FunctionalTestingFramework\DataGenerator\Objects;

class OperationDefinitionObject
{
    const HTTP_CONTENT_TYPE_HEADER = 'Content-Type';

    private $name;

    private $operation;

    private $dataType;

    private $apiMethod;

    private $apiUrl;

    private $apiUri;

    private $auth;

    private $contentType;

    private $headers = [];

    private $params = [];

    private $operationMetadata = [];

    private $successRegex;

    private $returnRegex;

    private $removeBackend;

    public function __construct(
        $name,
        $operation,
        $dataType,
        $apiMethod,
        $apiUri,
        $auth,
        $headers,
        $params,
        $metaData,
        $contentType,
        $removeBackend,
        $successRegex = null,
        $returnRegex = null
    ) {
        $this->name = $name;
        $this->operation = $operation;
        $this->dataType = $dataType;
        $this->apiMethod = $apiMethod;
        $this->apiUri = trim($apiUri, '/');
        $this->auth = $auth;
        $this->headers = $headers;
        $this->params = $params;
        $this->operationMetadata = $metaData;
        $this->successRegex = $successRegex;
        $this->returnRegex = $returnRegex;
        $this->removeBackend = $removeBackend;
        $this->apiUrl = null;

        if (!empty($contentType)) {
            $this->contentType = $contentType;
        } else {
            $this->contentType = 'application/x-www-form-urlencoded';
        }

        // add content type as a header
        $this->headers[] = self::HTTP_CONTENT_TYPE_HEADER . ': ' . $this->contentType;
    }

    public function getDataType()
    {
        return $this->dataType;
    }

    public function getOperation()
    {
        return $this->operation;
    }

    public function getApiMethod()
    {
        return $this->apiMethod;
    }

    public function getApiUrl()
    {
        if (!$this->apiUrl) {
            $this->apiUrl = $this->apiUri;

            if (array_key_exists('query', $this->params)) {
                $this->addQueryParams();
            }
        }

        return $this->apiUrl;
    }

    public function getAuth()
    {
        return $this->auth;
    }

    public function getHeaders()
    {
        return $this->headers;
    }

    public function removeUrlBackend()
    {
        return $this->removeBackend;
    }

    public function getContentType()
    {
        return $this->contentType;
    }

    public function getOperationMetadata()
    {
        return $this->operationMetadata;
    }

    public function getSuccessRegex()
    {
        return $this->successRegex;
    }

    public function getReturnRegex()
    {
        return $this->returnRegex;
    }

    public function addQueryParams()
    {
        foreach ($this->params['query'] as $paramName => $paramValue) {
            if (strpos($this->apiUrl, '?') === false) {
                $this->apiUrl = $this->apiUrl . "?";
            } else {
                $this->apiUrl = $this->apiUrl . "&";
            }
            $this->apiUrl = $this->apiUrl . $paramName . "=" . $paramValue;
        }
    }
}