Amplexor\XConnect\Request\Order

Complexity

Total Complexity

27

Size/Duplication

Total Lines	353
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getSourceLanguage()	0	4	1
A	createOrderName()	0	20	2
A	setConfig()	0	9	3
A	getOrderName()	0	4	1
A	getClientId()	0	4	1
A	getTemplateId()	0	4	1
A	getRequestDate()	0	5	1
A	getDueDate()	0	16	2
A	getIssuedBy()	0	4	1
A	isConfidential()	0	4	1
A	addTargetLanguage()	0	6	2
A	getTargetLanguages()	0	4	1
A	addInstruction()	0	4	1
A	getInstructions()	0	4	1
A	setReference()	0	4	1
A	getReference()	0	4	1
A	needsConfirmation()	0	4	1
A	needsQuotation()	0	4	1
A	addFile()	0	6	2
A	getFiles()	0	4	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\Request;

/**
 * Class that represents the X-Connect order.
 */
class Order
{
    /**
     * The order name.
     *
     * @var string
     */
    private $orderName;

    /**
     * The source language.
     *
     * @var string
     */
    private $sourceLanguage;

    /**
     * The target languages.
     *
     * @var array
     */
    private $targetLanguages = array();

    /**
     * The order instruction.
     *
     * @var array
     */
    private $instructions = array();

    /**
     * The client reference.
     *
     * @var string
     */
    private $reference;

    /**
     * The configuration.
     *
     * @var array
     */
    private $config = array(
        'clientId'          => '',
        'orderNamePrefix'   => '',
        'templateId'        => '',
        'dueDate'           => 0,
        'issuedBy'          => '',
        'isConfidential'    => false,
        'needsConfirmation' => true,
        'needsQuotation'    => false,
    );

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


    /**
     * Create a new order.
     *
     * @param string $source_language
     *   The source language for the translation order.
     * @param array $config
     *   The configuration elements for the order:
     *   - 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($source_language, $config = array())
    {
        $this->sourceLanguage = $source_language;
        $this->setConfig($config);

        $this->orderName = $this->createOrderName();
    }

    /**
     * Get the source language.
     *
     * @return string
     *   The source language of the translation.
     */
    public function getSourceLanguage()
    {
        return $this->sourceLanguage;
    }

    /**
     * Helper function to generate the order name when the object is created.
     *
     * @return string
     */
    protected function createOrderName()
    {
        $prefix = !empty($this->config['orderNamePrefix'])
            ? $this->config['orderNamePrefix']
            : 'translation_order';

        // Add timestamp.
        $timestamp = new \DateTime();

        // Get a 3-digit microsecond representation.
        $microseconds = floor((substr((string) microtime(), 1, 8) * 1000));
        $microseconds = str_pad($microseconds, 3, '0', STR_PAD_LEFT);

        return sprintf(
            '%s_%s%s',
            $prefix,
            $timestamp->format('YmdHis'),
            $microseconds
        );
    }

    /**
     * Fill in the configuration based on the given config array.
     *
     * @param array $config
     *   The config array to store.
     */
    protected function setConfig($config)
    {
        $config_keys = array_keys($this->config);
        foreach ($config_keys as $key) {
            if (isset($config[$key])) {
                $this->config[$key] = $config[$key];
            }
        }
    }

    /**
     * Get the order name.
     *
     * @return string
     *   The order name.
     */
    public function getOrderName()
    {
        return $this->orderName;
    }

    /**
     * Get the client id.
     *
     * @return string
     *   The client ID.
     */
    public function getClientId()
    {
        return $this->config['clientId'];
    }

    /**
     * Get the template id.
     *
     * @return string
     *   The template ID.
     */
    public function getTemplateId()
    {
        return $this->config['templateId'];
    }

    /**
     * Get the request date.
     *
     * @return DateTime
     *   The date time presentation of the request date.
     */
    public function getRequestDate()
    {
        $date = new \DateTime();
        return $date;
    }

    /**
     * Get the request due date.
     *
     * The date is calculated based on the dueDate value in the settings.
     *
     * @return DateTime
     *   The date time presentation of the due date.
     */
    public function getDueDate()
    {
        // When no due date interval given, use today.
        $dueDate = new \DateTime();
        if (empty($this->config['dueDate'])) {
            return $dueDate;
        }

        // Calculate the date by adding the dueDate interval.
        $interval = new \DateInterval(
            'P' . (int) $this->config['dueDate'] . 'D'
        );
        $dueDate->add($interval);

        return $dueDate;
    }

    /**
     * Get the issuer identifier.
     *
     * @return string
     *   The email address.
     */
    public function getIssuedBy()
    {
        return $this->config['issuedBy'];
    }

    /**
     * Get if the translation content is confidential.
     *
     * @return bool
     *   Translation vcontent is confidential true/false.
     */
    public function isConfidential()
    {
        return (bool) $this->config['isConfidential'];
    }

    /**
     * Add a target language.
     *
     * @param string $language
     *   The target language to add to the order.
     */
    public function addTargetLanguage($language)
    {
        if (!in_array($language, $this->targetLanguages)) {
            $this->targetLanguages[] = $language;
        }
    }

    /**
     * Get the target languages.
     *
     * @return array
     *   The target language codes.
     */
    public function getTargetLanguages()
    {
        return $this->targetLanguages;
    }

    /**
     * Add instruction to the order.
     *
     * @param string $instruction
     *   The instruction.
     */
    public function addInstruction($instruction)
    {
        $this->instructions[] = $instruction;
    }

    /**
     * Get the client instruction.
     *
     * @return string
     *   The client instruction regarding the translation.
     */
    public function getInstructions()
    {
        return $this->instructions;
    }

    /**
     * Set the client reference.
     *
     * @param string $reference
     *   The reference to use in the order.
     */
    public function setReference($reference)
    {
        $this->reference = $reference;
    }

    /**
     * Get the client reference.
     *
     * @return string
     *   The client reference.
     */
    public function getReference()
    {
        return $this->reference;
    }

    /**
     * Is there a confirmation needed before the translation may be processed.
     *
     * @return bool
     *   Needs confirmation true/false.
     */
    public function needsConfirmation()
    {
        return (bool) $this->config['needsConfirmation'];
    }

    /**
     * Get if an quotation is required before translation is processed.
     *
     * @return bool
     *   Needs quotation true/false.
     */
    public function needsQuotation()
    {
        return (bool) $this->config['needsQuotation'];
    }

    /**
     * Add an input file to the order.
     *
     * @param string $file_name
     *   The file name of the file to add to the order.
     */
    public function addFile($file_name)
    {
        if (!in_array($file_name, $this->files)) {
            $this->files[] = $file_name;
        }
    }

    /**
     * Get the input files.
     *
     * @return array
     *   The input file names part of the translation order.
     */
    public function getFiles()
    {
        return $this->files;
    }
}