Mailcode\Mailcode_Commands_Command_ShowURL

Complexity

Total Complexity

11

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getLabel()	0	3	1
A	isMailcodeEnabled()	0	3	1
A	supportsURLEncoding()	0	3	1
A	getDefaultType()	0	3	1
A	getName()	0	3	1
A	supportsType()	0	3	1
A	supportsLogicKeywords()	0	3	1
A	requiresParameters()	0	3	1
A	getURL()	0	3	1
A	getValidations()	0	8	1
A	generatesContent()	0	3	1

<?php
/**
 * File containing the {@see \Mailcode\Mailcode_Commands_Command_ShowURL} class.
 *
 * @package Mailcode
 * @subpackage Commands
 * @see \Mailcode\Mailcode_Commands_Command_ShowURL
 */

declare(strict_types=1);

namespace Mailcode;

use Mailcode\Interfaces\Commands\TrackableInterface;
use Mailcode\Interfaces\Commands\Validation\QueryParamsInterface;
use Mailcode\Interfaces\Commands\Validation\TrackingIDInterface;
use Mailcode\Interfaces\Commands\Validation\NoTrackingInterface;
use Mailcode\Interfaces\Commands\Validation\ShortenInterface;
use Mailcode\Traits\Commands\Validation\QueryParamsTrait;
use Mailcode\Traits\Commands\Validation\TrackingIDTrait;
use Mailcode\Traits\Commands\Validation\NoTrackingTrait;
use Mailcode\Traits\Commands\Validation\ShortenTrait;

/**
 * Mailcode command: `showurl` to format and display a URL
 * with or without tracking. The URL is specified as the
 * content of the command, to allow Mailcode syntax to build
 * the URL or retrieve it from variables.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_ShowURL
    extends Mailcode_Commands_Command
    implements
    Mailcode_Interfaces_Commands_ProtectedContent,
    TrackableInterface,
    QueryParamsInterface,
    ShortenInterface
{
    use Mailcode_Traits_Commands_ProtectedContent;
    use NoTrackingTrait;
    use TrackingIDTrait;
    use QueryParamsTrait;
    use ShortenTrait;

    public function getName() : string
    {
        return 'showurl';
    }

    public function getLabel() : string
    {
        return t('Show URL with or without tracking.');
    }

    public function supportsType(): bool
    {
        return false;
    }

    public function supportsURLEncoding() : bool
    {
        return false;
    }

    public function getDefaultType() : string
    {
        return '';
    }

    public function requiresParameters(): bool
    {
        return true;
    }

    public function supportsLogicKeywords() : bool
    {
        return false;
    }

    protected function getValidations() : array
    {
        return array(
            Mailcode_Interfaces_Commands_ProtectedContent::VALIDATION_NAME_CONTENT_ID,
            TrackingIDInterface::VALIDATION_NAME_TRACKING_ID,
            QueryParamsInterface::VALIDATION_NAME_QUERY_PARAMS,
            Mailcode_Interfaces_Commands_ProtectedContent::VALIDATION_NAME_NESTED_MAILCODE,
            ShortenInterface::VALIDATION_NAME_SHORTEN,
        );
    }

    public function generatesContent() : bool
    {
        return true;
    }

    public function getURL() : string
    {
        return $this->getContentTrimmed();
    }

    public function isMailcodeEnabled() : bool
    {
        return true;
    }
}