Aimeos\Aimeos\Scheduler\Provider\Email

Complexity

Total Complexity

26

Size/Duplication

Total Lines	247
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	validateFields()	0	29	8
A	saveFields()	0	12	1
F	getFields()	0	155	17

<?php

/**
 * @license GPLv3, http://www.gnu.org/copyleft/gpl.html
 * @copyright Metaways Infosystems GmbH, 2014
 * @copyright Aimeos (aimeos.org), 2014-2016
 * @package TYPO3
 */


namespace Aimeos\Aimeos\Scheduler\Provider;

use Aimeos\Aimeos\Base;
use Aimeos\Aimeos\Scheduler;
use TYPO3\CMS\Scheduler\Task\Enumeration\Action;


/**
 * Common methods for Aimeos' e-mail additional field providers.
 *
 * @package TYPO3
 */
abstract class Email extends AbstractProvider
{
    private $fieldSenderFrom = 'aimeos_sender_from';
    private $fieldSenderEmail = 'aimeos_sender_email';
    private $fieldReplyEmail = 'aimeos_reply_email';
    private $fieldPageLogin = 'aimeos_pageid_login';
    private $fieldPageDetail = 'aimeos_pageid_detail';
    private $fieldPageCatalog = 'aimeos_pageid_catalog';
    private $fieldPageDownload = 'aimeos_pageid_download';
    private $fieldTemplateBaseurl = 'aimeos_template_baseurl';


    /**
     * Fields generation.
     * This method is used to define new fields for adding or editing a task
     * In this case, it adds a page ID field
     *
     * @param array $taskInfo Reference to the array containing the info used in the add/edit form
     * @param object $task When editing, reference to the current task object. Null when adding.
     * @param object $parentObject Reference to the calling object (Scheduler's BE module)
     * @return array Array containg all the information pertaining to the additional fields
     *        The array is multidimensional, keyed to the task class name and each field's id
     *        For each field it provides an associative sub-array with the following:
     *            ['code']        => The HTML code for the field
     *            ['label']        => The label of the field (possibly localized)
     *            ['cshKey']        => The CSH key for the field
     *            ['cshLabel']    => The code of the CSH label
     */
    protected function getFields(array &$taskInfo, $task, $parentObject)
    {
        $additionalFields = [];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldSenderFrom]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldSenderFrom] = $task->{$this->fieldSenderFrom} ?? '';
        }

        $taskInfo[$this->fieldSenderFrom] = htmlspecialchars($taskInfo[$this->fieldSenderFrom] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldSenderFrom, $taskInfo[$this->fieldSenderFrom]);

        $additionalFields[$this->fieldSenderFrom] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.from-name',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldSenderFrom
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldSenderEmail]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldSenderEmail] = $task->{$this->fieldSenderEmail} ?? '';
        }

        $taskInfo[$this->fieldSenderEmail] = htmlspecialchars($taskInfo[$this->fieldSenderEmail] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldSenderEmail, $taskInfo[$this->fieldSenderEmail]);

        $additionalFields[$this->fieldSenderEmail] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.from-email',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldSenderEmail
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldReplyEmail]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldReplyEmail] = $task->{$this->fieldReplyEmail} ?? '';
        }

        $taskInfo[$this->fieldReplyEmail] = htmlspecialchars($taskInfo[$this->fieldReplyEmail] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldReplyEmail, $taskInfo[$this->fieldReplyEmail]);

        $additionalFields[$this->fieldReplyEmail] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.reply-email',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldReplyEmail
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldPageCatalog]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldPageCatalog] = $task->{$this->fieldPageCatalog} ?? '';
        }

        $taskInfo[$this->fieldPageCatalog] = htmlspecialchars($taskInfo[$this->fieldPageCatalog] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldPageCatalog, $taskInfo[$this->fieldPageCatalog]);

        $additionalFields[$this->fieldPageCatalog] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.page-catalog',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldPageCatalog
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldPageDetail]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldPageDetail] = $task->{$this->fieldPageDetail} ?? '';
        }

        $taskInfo[$this->fieldPageDetail] = htmlspecialchars($taskInfo[$this->fieldPageDetail] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldPageDetail, $taskInfo[$this->fieldPageDetail]);

        $additionalFields[$this->fieldPageDetail] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.page-detail',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldPageDetail
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldPageDownload]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldPageDownload] = $task->{$this->fieldPageDownload} ?? '';
        }

        $taskInfo[$this->fieldPageDownload] = htmlspecialchars($taskInfo[$this->fieldPageDownload] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldPageDownload, $taskInfo[$this->fieldPageDownload]);

        $additionalFields[$this->fieldPageDownload] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.page-download',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldPageDownload
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldPageLogin]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldPageLogin] = $task->{$this->fieldPageLogin} ?? '';
        }

        $taskInfo[$this->fieldPageLogin] = htmlspecialchars($taskInfo[$this->fieldPageLogin] ?? '', ENT_QUOTES, 'UTF-8');

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldPageLogin, $taskInfo[$this->fieldPageLogin]);

        $additionalFields[$this->fieldPageLogin] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.page-login',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldPageLogin
        ];


        // In case of editing a task, set to the internal value if data wasn't already submitted
        if (empty($taskInfo[$this->fieldTemplateBaseurl]) && $parentObject->getCurrentAction()->equals(Action::EDIT)) {
            $taskInfo[$this->fieldTemplateBaseurl] = $task->{$this->fieldTemplateBaseurl} ?? '';
        }

        $taskInfo[$this->fieldTemplateBaseurl] = htmlspecialchars($taskInfo[$this->fieldTemplateBaseurl] ?? '', ENT_QUOTES, 'UTF-8');

        $path = 'typo3conf/ext/aimeos/Resources/Public/Themes/default';
        $path = $taskInfo[$this->fieldTemplateBaseurl] = $taskInfo[$this->fieldTemplateBaseurl] ?? $path;

        $fieldStr = '<input class="form-control" name="tx_scheduler[%1$s]" id="%1$s" value="%2$s">';
        $fieldCode = sprintf($fieldStr, $this->fieldTemplateBaseurl, $path);

        $additionalFields[$this->fieldTemplateBaseurl] = [
            'code'     => $fieldCode,
            'label'    => 'LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.label.template-baseurl',
            'cshKey'   => 'xMOD_tx_aimeos',
            'cshLabel' => $this->fieldTemplateBaseurl
        ];


        $additionalFields += parent::getFields($taskInfo, $task, $parentObject);

        return $additionalFields;
    }


    /**
     * Store fields.
     * This method is used to save any additional input into the current task object
     * if the task class matches
     *
     * @param array $submittedData Array containing the data submitted by the user
     * @param object $task Reference to the current task object
     */
    protected function saveFields(array $submittedData, $task)
    {
        parent::saveFields($submittedData, $task);

        $task->{$this->fieldSenderFrom} = $submittedData[$this->fieldSenderFrom] ?? '';
        $task->{$this->fieldSenderEmail} = $submittedData[$this->fieldSenderEmail] ?? '';
        $task->{$this->fieldReplyEmail} = $submittedData[$this->fieldReplyEmail] ?? '';
        $task->{$this->fieldPageCatalog} = $submittedData[$this->fieldPageCatalog] ?? '';
        $task->{$this->fieldPageDetail} = $submittedData[$this->fieldPageDetail] ?? '';
        $task->{$this->fieldPageLogin} = $submittedData[$this->fieldPageLogin] ?? '';
        $task->{$this->fieldPageDownload} = $submittedData[$this->fieldPageDownload] ?? '';
        $task->{$this->fieldTemplateBaseurl} = $submittedData[$this->fieldTemplateBaseurl] ?? '';
    }


    /**
     * Fields validation.
     * This method checks if page id given in the 'Hide content' specific task is int+
     * If the task class is not relevant, the method is expected to return true
     *
     * @param array $submittedData Reference to the array containing the data submitted by the user
     * @param tx_scheduler_Module $parentObject Reference to the calling object (Scheduler's BE module)

The type Aimeos\Aimeos\Scheduler\Provider\tx_scheduler_Module was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return boolean True if validation was ok (or selected class is not relevant), false otherwise
     */
    protected function validateFields(array &$submittedData, $parentObject)
    {
        if (preg_match('/^.+@[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]+)*$/', $submittedData[$this->fieldSenderEmail] ?? '') !== 1) {
            throw new \InvalidArgumentException($GLOBALS['LANG']->sL('LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.error.from-email.invalid'));
        }

        if (($submittedData[$this->fieldReplyEmail] ?? '') && preg_match('/^.+@[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]+)*$/', $submittedData[$this->fieldReplyEmail]) !== 1) {
            throw new \InvalidArgumentException($GLOBALS['LANG']->sL('LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.error.reply-email.invalid'));
        }

        if (preg_match('/^[0-9]+$/', $submittedData[$this->fieldPageCatalog] ?? '') !== 1) {
            throw new \InvalidArgumentException($GLOBALS['LANG']->sL('LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.error.page-catalog.invalid'));
        }

        if (preg_match('/^[0-9]+$/', $submittedData[$this->fieldPageDetail] ?? '') !== 1) {
            throw new \InvalidArgumentException($GLOBALS['LANG']->sL('LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.error.page-detail.invalid'));
        }

        if (preg_match('/^[0-9]+$/', $submittedData[$this->fieldPageLogin] ?? '') !== 1) {
            throw new \InvalidArgumentException($GLOBALS['LANG']->sL('LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.error.page-login.invalid'));
        }

        if (preg_match('/^[0-9]+$/', $submittedData[$this->fieldPageDownload] ?? '') !== 1) {
            throw new \InvalidArgumentException($GLOBALS['LANG']->sL('LLL:EXT:aimeos/Resources/Private/Language/scheduler.xlf:email.error.page-download.invalid'));
        }

        parent::validateFields($submittedData, $parentObject);

        return true;
    }
}