Download the PHP package escolalms/templates-email without Composer

On this page you can find all versions of the php package escolalms/templates-email. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package templates-email

Templates-Email

Package for email notifications with editable templates (for important user-related events)

codecov Tests PHPUnit in environments Maintainability Test Coverage downloads downloads downloads

Purpose

This package allows you to create email notifications for events emitted in Laravel app.

Each notification is created as a class describing available variables that can be used in Template (which will be created in database and editable through admin panel). This class must be registered using Template facade from Template package, where you specify which Event it is associated with and which Channel it is sent through (e.g. Email channel when defined in this package).

Installing

Dependencies

Usage

Defining Templates

  1. Create event which triggers sending email using specified template. This event must implement method getUser() returning User model from LMS Core package.
  2. Create Class defining template variables, which you will use in email notification,
  3. Associate your class describing template variables with event and channel through which notifications should be sent. Use EscolaLms\Templates\Facades\Template::register(Event class, EscolaLms\TemplatesEmail\Core\EmailChannel::class, Variable class);
  4. Register template in db for admin panel or used /api/admin/templates, better described in Template package

Mjml (pre)rendering

  1. Emails are written using MJML, which then is prerendered into HTML when saving a Template (so that sending an email does not call renderer for each message).
  2. To render MJML you need to either:
    • install mjml npm package and configure path to executable binary in this package config binary_path key
    • register to MJML API and configure api id & secret in this package config file

Tests

Run ./vendor/bin/phpunit --filter 'EscolaLms\\TemplatesEmail\\Tests' to run tests. See tests folder as it contains a basic implementation of Variable (or Template description) class with minimal customisation - a quite good starting point for creating your own.

Test details codecov Tests PHPUnit in environments

Permissions

No Permissions defined for this package.

All versions of templates-email with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
escolalms/core Version ^1.2.2
escolalms/templates Version ^0.2.1
ezyang/htmlpurifier Version ^4.13
laravel/framework Version >=8.0
qferr/mjml-php Version ^2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package escolalms/templates-email contains the following files

Loading the files please wait ....