erwane/cakephp-libs

There is no license information available for the latest version (2.0.6) of this package.

Erwane CakePHP Libs

2.0.6 2022-06-10 13:36 UTC

Requires

• php: ^7.2 || ^8.0
• cakephp/cakephp: ^4.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^4.0
• php-parallel-lint/php-parallel-lint: ^1.2
• phpro/grumphp: ^v1.0
• phpunit/phpunit: ^9.0 || ^8.0

Unknown License

• Erwane Breton

README

Mailer

Mailer class are mades to simplify the customization of e-mail templates.

Imagine you want to allow your App users or admins to customize theirs e-mails. With this classes, you can set some allowedVars in template and users can use it with {{USER_NAME}} syntax in email.

All vars need to be allowed with setAllowedVars() and are quoted. No injection risk.

Mailer

use Ecl\Mailer\Mailer;
use Cake\ORM\Entity;

$mailer = new Mailer();
$mailer
    ->setAllowedVars(['USER_NAME'])
    ->setViewVars([
        'user' => new Entity(['name' => 'User Name']),
    ])
    ->setEmailFormat('text')
    ->deliver('Hello {{USER_NAME}}');

This will send a text e-mail with content below:

Hello User Name

This, work with reusable Mailer and templates too.

namespace App\Mailer;

use Ecl\Mailer\Mailer;

class UserMailer extends Mailer
{
    public function welcome($user)
    {
        $this
            ->setTo($user->email)
            ->setSubject(sprintf('Welcome %s', $user->name))
            ->setAllowedVars(['USER_NAME'])
            ->set(['user' => $user]);
    }
}

// templates/email/html/welcome.php
<p>Hi {{USER_NAME}}</p>

The Mailer add one new method setAllowedVars(array): self, required for template var replacement.

Renderer

The rendered can be used without Ecl\Mailer\Mailer if you want to pre-fill a wysiwyg textarea.

use Ecl\Mailer\Renderer;

$invoice = $this->Invoices->get(1, ['contain' => ['Customers']]);

// Get template from DB (or templates dir)
/** @var \App\Model\Entity\EmailTemplate $emailTemplate */
$emailTemplate = $this->EmailTemplates
    ->find()
    ->where(['type' => 'invoice_send'])
    ->first();

$body = '';
if ($emailTemplate && $emailTemplate->body) {
    $renderer = new Renderer();
    $rendered = $renderer
        ->setAllowedVars([
            'INVOICE_NUM',
            'CUSTOMER_TITLE', 
        ])
        ->set([
            'invoice' => $invoice, 
            'customer' => $invoice->customer,
        ])
        ->render($emailTemplate->body, ['html']);

    $body = $rendered['html'];
}

$body now contain the formatted body e-mail with all allowed vars replaced by values in entities.

<!-- Template -->
<p>Hi {{CUSTOMER_TITLE}}.</p>

<p>
    Please find your invoice <b>{{INVOICE_NUM}}<b> attached.
</p>

<!-- Body for wysiwyg -->
<p>Hi Company name.</p>

<p>
    Please find your invoice <b>FC-202102-01234<b> attached.
</p>