timegridio/timegrid

<?php

namespace App\TG;

use Snowfire\Beautymail\Beautymail;

class TransMail
{
    /**
     * @var Mail
     */
    protected $mail = null;

    /**
     * @var string
     */
    protected $locale = 'en_US';

    /**
     * Locale Switch Function name.
     *
     * @var string
     */
    protected $localeSwitchFunction = 'setGlobalLocale';

    /**
     * @var string
     */
    protected $revertLocale = 'en_US';

    /**
     * @var string
     */
    protected $timezone = null;

    /**
     * @var string
     */
    protected $revertTimezone = null;

    /**
     * @var string
     */
    protected $subjectKey = '';

    /**
     * @var array
     */
    protected $subjectParams = [];

    /**
     * @var string
     */
    protected $viewBase = 'emails';

    /**
     * @var string
     */
    protected $viewPath = '';

    /**
     * @var string
     */
    protected $subject = '';

    /**
     * @var  bool Post sent success status indicator.
     */
    protected $success = false;

    /**
     * Construct the class.
     *
     * @param Mail|null $mail
     */
    public function __construct($mail = null)
    {
        $this->mail = $mail ?: app()->make(Beautymail::class);

        $this->locale();
    }

    /**
     * Use switch locale function name.
     *
     * @param string $functionName
     *
     * @return $this
     */
    public function useFunction($functionName)
    {
        $this->localeSwitchFunction = $functionName;

        return $this;
    }

    /**
     * Set the locale.
     *
     * @param string $posixLocale
     *
     * @return $this
     */
    public function locale($posixLocale = null)
    {
        $this->revertLocale = app()->getLocale();

        if ($posixLocale === null) {
            $posixLocale = $this->revertLocale;
        }

        $this->locale = $posixLocale;

        return $this;
    }

    public function timezone($timezone)
    {
        $this->revertTimezone = session()->get('timezone');

        $this->timezone = $timezone;

        return $this;
    }

    public function switchTimezone($timezone)
    {
        if ($timezone !== null && $timezone != '') {
            $this->revertTimezone = session()->get('timezone');

            session()->set('timezone', $timezone);
            logger()->info("Switching timezone to $timezone for session");
        }

        return $this;
    }

    /**
     * Set the template view path key.
     *
     * @param string $template
     *
     * @return $this
     */
    public function template($template)
    {
        $this->viewPath = $template;

        return $this;
    }

    /**
     * Set the subject trans key and parameters.
     *
     * @param string $key
     * @param array  $params
     *
     * @return $this
     */
    public function subject($key, $params = [])
    {
        $this->subjectKey = $key;

        $this->subjectParams = $params;

        return $this;
    }

    /**
     * Switch application wide locale, send message, and restore locale.
     *
     * @param array $header
     * @param array $params
     *
     * @return void
     */
    public function send(array $header, array $params)
    {
        $this->switchLocale($this->locale);
        $this->switchTimezone($this->timezone);

        $this->mail->send($this->getViewKey(), $params, function ($message) use ($header) {
            $message
                ->to(array_get($header, 'email'), array_get($header, 'name'))
                ->subject($this->getSubject());
        });

        $this->switchLocale($this->revertLocale);
        $this->switchTimezone($this->revertTimezone);

        $this->success = 0 == $this->mail->failures();

        return $this->success();
    }

    public function success()
    {
        return $this->success;
    }

    /////////////
    // Helpers //
    /////////////

    /**
     * Switch Locale.
     *
     * @param string $posixLocale
     *
     * @return $this
     */
    protected function switchLocale($posixLocale)
    {
        if (function_exists($this->localeSwitchFunction)) {
            call_user_func($this->localeSwitchFunction, $posixLocale);
        }

        return $this;
    }

    /**
     * Build and get the view path key.
     *
     * @throws Exception 'Email view does not exist'
     *
     * @return string
     */
    protected function getViewKey()
    {
        $key = $this->viewBase.'.'.$this->viewPath;

        if (!view()->exists($key)) {
            throw new \Exception('Email view does not exist: '.$key);
        }

        return $key;
    }

    /**
     * Build and get the localized subject string.
     *
     * @return string
     */
    protected function getSubject()
    {
        return $this->subject = trans('emails.'.$this->subjectKey, $this->subjectParams);
    }
}