Amplexor\XConnect\Request

Complexity

Total Complexity

9

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getOrder()	0	4	1
A	addTargetLanguage()	0	4	1
A	addInstruction()	0	4	1
A	setReference()	0	4	1
A	getFiles()	0	4	1
A	addFile()	0	6	1
A	getContent()	0	4	1
A	addContent()	0	5	1

<?php
/**
 * This file is part of the Amplexor\XConnect library
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/amplexor-drupal/xconnect/
 * @version 1.0.0
 * @package Amplexor.XConnect
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Amplexor\XConnect;

use Amplexor\XConnect\Request\Order;

/**
 * Class representing a translation request.
 */
class Request
{
    /**
     * The order that is part of the request.
     *
     * @var Order
     */
    private $order;

    /**
     * The files that are part of the request.
     *
     * @var array
     */
    private $files = array();

    /**
     * The content that is part of the request.
     *
     * @var array
     */
    private $content = array();


    /**
     * Create a new request by passing the configuration to it.
     *
     * @param string $sourceLanguage
     *   The source language for the request.
     * @param array $config
     *   The configuration for the request:
     *   - clientId : The client ID to order the translations for.
     *   - orderNamePrefix : The order gets by default the following name:
     *     translation_order_<date as YmdHis><microseconds as 3 digits>.
     *     You can override the "translation_order_" with your own prefix.
     *     (optional).
     *   - templateId : The translation template ID. (optional).
     *   - dueDate : What is the deadline for the file(s) to be translated.
     *     The deadline should be set in days from the moment the translation
     *     is ordered. (optional, default 0).
     *   - issuedBy : The email address of the, by the translation known, issuer
     *     of the translation.
     *   - isConfidential : Is the content for the translation confidential?
     *     (optional, default false).
     *   - needsConfirmation : Should there be a conformation send when the
     *     translation is ready? (optional, default true).
     *   - needsQuotation : Should a quotation be created and send before the
     *     translation is performed? (optional, default false).
     */
    public function __construct($sourceLanguage, array $config)
    {
        $this->order = new Order($sourceLanguage, $config);
    }

    /**
     * Get the order object from the request.
     *
     * @return Order
     *   The order object.
     */
    public function getOrder()
    {
        return $this->order;
    }

    /**
     * Add a translation target language for the request.
     *
     * @param string $language
     *   The language to translate the request to.
     */
    public function addTargetLanguage($language)
    {
        $this->order->addTargetLanguage($language);
    }

    /**
     * Add a translation instruction.
     *
     * @param string $instruction
     *   The instruction to add to the request.
     */
    public function addInstruction($instruction)
    {
        $this->order->addInstruction($instruction);
    }

    /**
     * Set the reference for the translation.
     *
     * @param string $reference
     *   The client refenece to use in all communication about the request.
     */
    public function setReference($reference)
    {
        $this->order->setReference($reference);
    }

    /**
     * Get the translation files that are part of the request.
     *
     * @return array
     *   Array of 'filename.ext' => 'full/path/to/filename.ext'
     */
    public function getFiles()
    {
        return $this->files;
    }

    /**
     * Add a file path to a file that needs to be translated.
     *
     * @param string $filePath
     *   A local file path to the file that needs to be included in the request.
     */
    public function addFile($filePath)
    {
        $fileName = basename($filePath);
        $this->files[$fileName] = $filePath;
        $this->getOrder()->addFile($fileName);
    }

    /**
     * Get the translation files content thatt are part of the request.
     *
     * @return array
     *   Array of 'filename.ext' => 'content string'.
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Add content strings to the request by providing a filename and string.
     *
     * @param string $fileName
     *   The file name to use to pass the content string.
     * @param string $content
     *   The file content as a string.
     */
    public function addContent($fileName, $content)
    {
        $this->content[$fileName] = $content;
        $this->getOrder()->addFile($fileName);
    }
}