mautic / mautic

app/bundles/IntegrationsBundle/Event/MappedIntegrationObjectTokenEvent.php

<?php

declare(strict_types=1);

/*
 * @copyright   2019 Mautic, Inc. All rights reserved
 * @author      Mautic, Inc.
 *
 * @link        https://mautic.com
 *
 * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Mautic\IntegrationsBundle\Event;

use Mautic\CoreBundle\Event\CommonEvent;

/**
 * This event is dispatched to allow plugins to provide tokens which create links
 * to any synced integration objects they may provide.
 *
 * Class MappedIntegrationObjectTokenEvent
 */
class MappedIntegrationObjectTokenEvent extends CommonEvent
{
    /**
     * @var array
     */
    private $tokens = [];

    /**
     * Add a new mapped integration object token.
     *
     * @param string $integrationName - The name of the integration
     * @param $objectName - The name of the object in sync_object_mapping table

The doc comment - at position 0 could not be parsed: Unknown type name '-' at position 0 in -.

     * @param $objectLink - The base_url to direct users to the object on the integration site
     * @param string $title    - The title of the token in the token select dropdown
     * @param string $linkText - The link text used for the url provided in $objectLink
     * @param string $default  - The default value to show when the token value isnt found
     */
    public function addToken(
        $integrationName,
        $objectName,
        $objectLink,
        $title = '',
        $linkText = 'Link Text',
        $default = 'Default Value'
    ): void {
        $this->tokens[$integrationName][$objectName] = [
            'base_url'    => $objectLink,
            'token_title' => $title,
            'link_text'   => $linkText,
            'default'     => $default,
        ];
    }

    /**
     * @return array
     */
    public function getTokens()
    {
        return $this->tokens;
    }

    /**
     * Get only the tokens provided by a particular integration.
     *
     * @param string $integrationName
     *
     * @return array
     */
    public function getTokensByIntegration($integrationName)
    {
        return $this->tokens[$integrationName] ?? [];
    }
}