File Core/src/Mailer/UserMailer.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2019 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */

namespace BEdita\Core\Mailer;

use BEdita\Core\Model\Entity\User;
use Cake\Core\Configure;
use Cake\Mailer\Mailer;

/**
 * Mailer class to send notifications to users
 *
 * @since 4.0.0
 */
class UserMailer extends Mailer
{
    /**
     * Welcome message.
     *
     * It requires `$options['params']` with:
     * - `user` the user Entity to send welcome email
     *
     * @param array $options Email options
     * @return \Cake\Mailer\Mailer
     * @throws \LogicException When missing some required parameter
     */
    public function welcome($options)
    {
        if (empty($options['params']['user'])) {
            throw new \LogicException(__d('bedita', 'Parameter "{0}" missing', ['params.user']));
        }

        $user = $options['params']['user'];
        $this->checkUser($user);
        $projectName = $this->getProjectName();
        $subject = __d('bedita', 'Welcome to {0}', [$projectName]);

        $this->set([
            'user' => $user,
            'projectName' => $projectName,
        ]);

        $this->viewBuilder()
            ->setTemplate('BEdita/Core.welcome')
            ->setLayout('BEdita/Core.default');

        return $this
            ->setEmailFormat('both')
            ->setTo($user->email)
            ->setSubject($subject);
    }

    /**
     * Signup message.
     *
     * It requires `$options['params']` with:
     * - `user` the User Entity to send signup email
     * - `activationUrl` the activation url to follow
     *
     * @param array $options Email options
     * @return \Cake\Mailer\Mailer
     * @throws \LogicException When missing some required parameter
     */
    public function signup(array $options)
    {
        if (empty($options['params']['activationUrl'])) {
            throw new \LogicException(__d('bedita', 'Parameter "{0}" missing', ['params.activationUrl']));
        }

        if (empty($options['params']['user'])) {
            throw new \LogicException(__d('bedita', 'Parameter "{0}" missing', ['params.user']));
        }

        $user = $options['params']['user'];
        $this->checkUser($user);

        $projectName = $this->getProjectName();
        $subject = __d('bedita', '{0} registration', [$projectName]);

        $this->set([
            'user' => $user,
            'activationUrl' => $options['params']['activationUrl'],
            'projectName' => $projectName,
        ]);

        $this->viewBuilder()
            ->setTemplate('BEdita/Core.signup')
            ->setLayout('BEdita/Core.default');

        return $this->setEmailFormat('both')
            ->setTo($user->email)
            ->setSubject($subject);
    }

    /**
     * Credentials change message.
     *
     * It requires `$options['params']` with:
     * - `user` the user id to send signup email
     * - `changeUrl` the change url to follow
     *
     * @param array $options Email options
     * @return \Cake\Mailer\Mailer
     * @throws \LogicException When missing some required parameter
     */
    public function changeRequest(array $options)
    {
        if (empty($options['params']['changeUrl'])) {
            throw new \LogicException(__d('bedita', 'Parameter "{0}" missing', ['params.changeUrl']));
        }

        if (empty($options['params']['user'])) {
            throw new \LogicException(__d('bedita', 'Parameter "{0}" missing', ['params.user']));
        }

        $user = $options['params']['user'];
        $this->checkUser($user);

        $projectName = $this->getProjectName();
        $subject = __d('bedita', '{0} change request', [$projectName]);

        $this->set([
            'user' => $user,
            'changeUrl' => $options['params']['changeUrl'],
            'projectName' => $projectName,
        ]);

        $this->viewBuilder()
            ->setTemplate('BEdita/Core.change_request')
            ->setLayout('BEdita/Core.default');

        return $this->setEmailFormat('both')
            ->setTo($user->email)
            ->setSubject($subject);
    }

    /**
     * Check the user is valid.
     *
     * @param \BEdita\Core\Model\Entity\User $user The user entity
     * @return void
     * @throws \LogicException When user is not valid
     */
    protected function checkUser($user)
    {
        if (!($user instanceof User)) {
            throw new \LogicException(__d('bedita', 'Invalid user, it must be an User Entity'));
        }

        if (empty($user->email)) {
            throw new \LogicException(__d('bedita', 'User email missing'));
        }
    }

    /**
     * Get the project name.
     * It tries to get the application name (default 'BEdita')
     *
     * @return string
     */
    protected function getProjectName()
    {
        $name = Configure::read('Project.name');

        return $name ?? 'BEdita';
    }
}

Namespaces

Classes