TplAppMailpit Class Reference

Static Public Member Functions
static	getActionChangeMailpitPort ()
static	getActionEnableMailpit ($enable)
static	getActionInstallMailpitService ()
static	getActionRemoveMailpitService ()
static	getActionSwitchMailpitVersion ($version)
static	getMenuMailpit ()
static	getMenuMailpitService ()
static	getMenuMailpitVersions ()
static	process ()

Data Fields
const	ACTION_CHANGE_PORT = 'changeMailpitPort'
const	ACTION_ENABLE = 'enableMailpit'
const	ACTION_INSTALL_SERVICE = 'installMailpitService'
const	ACTION_REMOVE_SERVICE = 'removeMailpitService'
const	ACTION_SWITCH_VERSION = 'switchMailpitVersion'
const	MENU = 'mailpit'
const	MENU_SERVICE = 'mailpitService'
const	MENU_VERSIONS = 'mailpitVersions'

Detailed Description

Class TplAppMailpit

This class provides methods to generate menus and actions for managing the Mailpit application. It includes functionalities for enabling/disabling Mailpit, switching versions, changing ports, and managing the Mailpit service.

Definition at line 17 of file class.tpl.app.mailpit.php.

Member Function Documentation

getActionChangeMailpitPort()

getActionChangeMailpitPort ( )

static

Generates the action to change the Mailpit port.

This method creates the action string for changing the Mailpit port and includes a command to reload the application.

Returns

string The generated action string for changing the Mailpit port. @global object $bearsamppBins Provides access to system binaries and their configurations.

Definition at line 262 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppBins;
 
        return TplApp::getActionRun(Action::CHANGE_PORT, array($bearsamppBins->getMailpit()->getName())) . PHP_EOL .
            TplAppReload::getActionReload();
    }

References $bearsamppBins, Action\CHANGE_PORT, TplAppReload\getActionReload(), and TplApp\getActionRun().

Here is the call graph for this function:

getActionEnableMailpit()

getActionEnableMailpit ( $enable )

static

Generates the action to enable or disable Mailpit.

This method creates the action string for enabling or disabling Mailpit and includes a command to reload the application.

Parameters

int

$enable

The enable flag (1 to enable, 0 to disable).

Returns

string The generated action string for enabling or disabling Mailpit. @global object $bearsamppBins Provides access to system binaries and their configurations.

Definition at line 159 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppBins;
 
        return TplApp::getActionRun(Action::ENABLE, array($bearsamppBins->getMailpit()->getName(), $enable)) . PHP_EOL .
            TplAppReload::getActionReload();
    }

References $bearsamppBins, Action\ENABLE, TplAppReload\getActionReload(), and TplApp\getActionRun().

Here is the call graph for this function:

getActionInstallMailpitService()

getActionInstallMailpitService ( )

static

Generates the action to install the Mailpit service.

This method creates the action string for installing the Mailpit service and includes a command to reload the application.

Returns

string The generated action string for installing the Mailpit service.

Definition at line 277 of file class.tpl.app.mailpit.php.

    {
        return TplApp::getActionRun(Action::SERVICE, array(BinMailpit::SERVICE_NAME, ActionService::INSTALL)) . PHP_EOL .
            TplAppReload::getActionReload();
    }

References TplAppReload\getActionReload(), TplApp\getActionRun(), ActionService\INSTALL, Action\SERVICE, and BinMailpit\SERVICE_NAME.

Here is the call graph for this function:

getActionRemoveMailpitService()

getActionRemoveMailpitService ( )

static

Generates the action to remove the Mailpit service.

This method creates the action string for removing the Mailpit service and includes a command to reload the application.

Returns

string The generated action string for removing the Mailpit service.

Definition at line 290 of file class.tpl.app.mailpit.php.

    {
        return TplApp::getActionRun(Action::SERVICE, array(BinMailpit::SERVICE_NAME, ActionService::REMOVE)) . PHP_EOL .
            TplAppReload::getActionReload();
    }

References TplAppReload\getActionReload(), TplApp\getActionRun(), ActionService\REMOVE, Action\SERVICE, and BinMailpit\SERVICE_NAME.

Here is the call graph for this function:

getActionSwitchMailpitVersion()

getActionSwitchMailpitVersion ( $version )

static

Generates the action to switch the Mailpit version.

This method creates the action string for switching the Mailpit version and includes a command to reload the application.

Parameters

string

$version

The version to switch to.

Returns

string The generated action string for switching the Mailpit version. @global object $bearsamppBins Provides access to system binaries and their configurations.

Definition at line 178 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppBins;
 
        return TplApp::getActionRun(Action::SWITCH_VERSION, array($bearsamppBins->getMailpit()->getName(), $version)) . PHP_EOL .
            TplAppReload::getActionReload() . PHP_EOL;
    }

References $bearsamppBins, TplAppReload\getActionReload(), TplApp\getActionRun(), and Action\SWITCH_VERSION.

Here is the call graph for this function:

getMenuMailpit()

getMenuMailpit ( )

static

Generates the Mailpit menu.

This method creates the menu items and associated actions for Mailpit, including options for downloading, enabling, switching versions, managing the service, and viewing logs.

Returns

string The generated Mailpit menu items and actions. @global object $bearsamppConfig Provides access to the application configuration. @global object $bearsamppBins Provides access to system binaries and their configurations. @global object $bearsamppLang Provides language support for retrieving language-specific values.

@global object $bearsamppRoot Provides access to the root path of the application.

Definition at line 60 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppBins, $bearsamppLang;
        $resultItems = $resultActions = '';
 
        $isEnabled = $bearsamppBins->getMailpit()->isEnable();
 
        // Download
        $resultItems .= TplAestan::getItemLink(
                $bearsamppLang->getValue(Lang::DOWNLOAD_MORE),
                HttpClient::getWebsiteUrl('module/mailpit', '#releases'),
                false,
                TplAestan::GLYPH_BROWSER
            ) . PHP_EOL;
 
        // Enable
        $tplEnable     = TplApp::getActionMulti(
            self::ACTION_ENABLE,
            array($isEnabled ? Config::DISABLED : Config::ENABLED),
            array($bearsamppLang->getValue(Lang::MENU_ENABLE), $isEnabled ? TplAestan::GLYPH_CHECK : ''),
            false,
            get_called_class()
        );
        $resultItems   .= $tplEnable[TplApp::SECTION_CALL] . PHP_EOL;
        $resultActions .= $tplEnable[TplApp::SECTION_CONTENT] . PHP_EOL;
 
        if ($isEnabled) {
            $resultItems .= TplAestan::getItemSeparator() . PHP_EOL;
 
            // Versions
            $tplVersions   = TplApp::getMenu($bearsamppLang->getValue(Lang::VERSIONS), self::MENU_VERSIONS, get_called_class());
            $resultItems   .= $tplVersions[TplApp::SECTION_CALL] . PHP_EOL;
            $resultActions .= $tplVersions[TplApp::SECTION_CONTENT] . PHP_EOL;
 
            // Service
            $tplService    = TplApp::getMenu($bearsamppLang->getValue(Lang::SERVICE), self::MENU_SERVICE, get_called_class());
            $resultItems   .= $tplService[TplApp::SECTION_CALL] . PHP_EOL;
            $resultActions .= $tplService[TplApp::SECTION_CONTENT] . PHP_EOL;
 
            // Web page
            $resultItems .= TplAestan::getItemExe(
                    $bearsamppLang->getValue(Lang::MAILPIT),
                    $bearsamppConfig->getBrowser(),
                    TplAestan::GLYPH_WEB_PAGE,
                    Path::getLocalUrl() . ':' . $bearsamppBins->getMailpit()->getUiPort() . '/' . $bearsamppBins->getMailpit()->getWebRoot()
                ) . PHP_EOL;
 
            // Log
            $resultItems .= TplAestan::getItemNotepad($bearsamppLang->getValue(Lang::MENU_LOGS), $bearsamppBins->getMailpit()->getLog()) . PHP_EOL;
        }
 
        return $resultItems . PHP_EOL . $resultActions;
    }

References $bearsamppBins, $bearsamppConfig, $bearsamppLang, $bearsamppRoot, Config\DISABLED, Lang\DOWNLOAD_MORE, Config\ENABLED, TplApp\getActionMulti(), TplAestan\getItemExe(), TplAestan\getItemLink(), TplAestan\getItemNotepad(), TplAestan\getItemSeparator(), Path\getLocalUrl(), TplApp\getMenu(), HttpClient\getWebsiteUrl(), TplAestan\GLYPH_BROWSER, TplAestan\GLYPH_CHECK, TplAestan\GLYPH_WEB_PAGE, Lang\MAILPIT, Lang\MENU_ENABLE, Lang\MENU_LOGS, TplApp\SECTION_CALL, TplApp\SECTION_CONTENT, Lang\SERVICE, and Lang\VERSIONS.

Here is the call graph for this function:

getMenuMailpitService()

getMenuMailpitService ( )

static

Generates the Mailpit service menu.

This method creates the menu items and associated actions for managing the Mailpit service, including starting, stopping, restarting, changing ports, and installing or removing the service.

Returns

string The generated Mailpit service menu items and actions. @global object $bearsamppLang Provides language support for retrieving language-specific values. @global object $bearsamppBins Provides access to system binaries and their configurations.

@global object $bearsamppRoot Provides access to the root path of the application.

Definition at line 198 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppRoot, $bearsamppLang, $bearsamppBins;
 
        $tplChangePort = TplApp::getActionMulti(
            self::ACTION_CHANGE_PORT,
            null,
            array($bearsamppLang->getValue(Lang::MENU_CHANGE_PORT), TplAestan::GLYPH_NETWORK),
            false,
            get_called_class()
        );
 
        $isInstalled = $bearsamppBins->getMailpit()->getService()->isInstalled();
 
        $result = TplAestan::getItemActionServiceStart($bearsamppBins->getMailpit()->getService()->getName()) . PHP_EOL .
            TplAestan::getItemActionServiceStop($bearsamppBins->getMailpit()->getService()->getName()) . PHP_EOL .
            TplAestan::getItemActionServiceRestart($bearsamppBins->getMailpit()->getService()->getName()) . PHP_EOL .
            TplAestan::getItemSeparator() . PHP_EOL .
            TplApp::getActionRun(
                Action::CHECK_PORT,
                array($bearsamppBins->getMailpit()->getName(), $bearsamppBins->getMailpit()->getSmtpPort()),
                array(sprintf($bearsamppLang->getValue(Lang::MENU_CHECK_PORT), $bearsamppBins->getMailpit()->getSmtpPort()), TplAestan::GLYPH_LIGHT)
            ) . PHP_EOL .
            $tplChangePort[TplApp::SECTION_CALL] . PHP_EOL .
            TplAestan::getItemNotepad($bearsamppLang->getValue(Lang::MENU_UPDATE_ENV_PATH), Path::getRootPath() . '/nssmEnvPaths.dat') . PHP_EOL;
 
        if (!$isInstalled) {
            $tplInstallService = TplApp::getActionMulti(
                self::ACTION_INSTALL_SERVICE,
                null,
                array($bearsamppLang->getValue(Lang::MENU_INSTALL_SERVICE), TplAestan::GLYPH_SERVICE_INSTALL),
                $isInstalled,
                get_called_class()
            );
 
            $result .= $tplInstallService[TplApp::SECTION_CALL] . PHP_EOL . PHP_EOL .
                $tplInstallService[TplApp::SECTION_CONTENT] . PHP_EOL;
        } else {
            $tplRemoveService = TplApp::getActionMulti(
                self::ACTION_REMOVE_SERVICE,
                null,
                array($bearsamppLang->getValue(Lang::MENU_REMOVE_SERVICE), TplAestan::GLYPH_SERVICE_REMOVE),
                !$isInstalled,
                get_called_class()
            );
 
            $result .= $tplRemoveService[TplApp::SECTION_CALL] . PHP_EOL . PHP_EOL .
                $tplRemoveService[TplApp::SECTION_CONTENT] . PHP_EOL;
        }
 
        $result .= $tplChangePort[TplApp::SECTION_CONTENT] . PHP_EOL;
 
        return $result;
    }

References $bearsamppBins, $bearsamppLang, $bearsamppRoot, $result, Action\CHECK_PORT, TplApp\getActionMulti(), TplApp\getActionRun(), TplAestan\getItemActionServiceRestart(), TplAestan\getItemActionServiceStart(), TplAestan\getItemActionServiceStop(), TplAestan\getItemNotepad(), TplAestan\getItemSeparator(), Path\getRootPath(), TplAestan\GLYPH_LIGHT, TplAestan\GLYPH_NETWORK, TplAestan\GLYPH_SERVICE_INSTALL, TplAestan\GLYPH_SERVICE_REMOVE, Lang\MENU_CHANGE_PORT, Lang\MENU_CHECK_PORT, Lang\MENU_INSTALL_SERVICE, Lang\MENU_REMOVE_SERVICE, Lang\MENU_UPDATE_ENV_PATH, TplApp\SECTION_CALL, and TplApp\SECTION_CONTENT.

Here is the call graph for this function:

getMenuMailpitVersions()

getMenuMailpitVersions ( )

static

Generates the Mailpit versions menu.

This method creates the menu items and associated actions for switching between different versions of Mailpit.

Returns

string The generated Mailpit versions menu items and actions. @global object $bearsamppBins Provides access to system binaries and their configurations.

Definition at line 123 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppBins;
        $items   = '';
        $actions = '';
 
        foreach ($bearsamppBins->getMailpit()->getVersionList() as $version) {
            $tplSwitchMailpitVersion = TplApp::getActionMulti(
                self::ACTION_SWITCH_VERSION,
                array($version),
                array($version, $version == $bearsamppBins->getMailpit()->getVersion() ? TplAestan::GLYPH_CHECK : ''),
                false,
                get_called_class()
            );
 
            // Item
            $items .= $tplSwitchMailpitVersion[TplApp::SECTION_CALL] . PHP_EOL;
 
            // Action
            $actions .= PHP_EOL . $tplSwitchMailpitVersion[TplApp::SECTION_CONTENT];
        }
 
        return $items . $actions;
    }

References $bearsamppBins, TplApp\getActionMulti(), TplAestan\GLYPH_CHECK, TplApp\SECTION_CALL, and TplApp\SECTION_CONTENT.

Here is the call graph for this function:

process()

process ( )

static

Processes the Mailpit menu.

This method generates the menu for enabling or disabling Mailpit. It uses the global language object to retrieve the localized string for Mailpit.

Returns

array The generated menu for enabling or disabling Mailpit. @global object $bearsamppBins Provides access to system binaries and their configurations.

@global object $bearsamppLang Provides language support for retrieving language-specific values.

Definition at line 40 of file class.tpl.app.mailpit.php.

    {
        global $bearsamppLang, $bearsamppBins;
 
        return TplApp::getMenuEnable($bearsamppLang->getValue(Lang::MAILPIT), self::MENU, get_called_class(), $bearsamppBins->getMailpit()->isEnable());
    }

References $bearsamppBins, $bearsamppLang, TplApp\getMenuEnable(), and Lang\MAILPIT.

Referenced by TplApp\getSectionMenuLeft().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ACTION_CHANGE_PORT

const ACTION_CHANGE_PORT = 'changeMailpitPort'

Definition at line 25 of file class.tpl.app.mailpit.php.

ACTION_ENABLE

const ACTION_ENABLE = 'enableMailpit'

Definition at line 23 of file class.tpl.app.mailpit.php.

ACTION_INSTALL_SERVICE

const ACTION_INSTALL_SERVICE = 'installMailpitService'

Definition at line 26 of file class.tpl.app.mailpit.php.

ACTION_REMOVE_SERVICE

const ACTION_REMOVE_SERVICE = 'removeMailpitService'

Definition at line 27 of file class.tpl.app.mailpit.php.

ACTION_SWITCH_VERSION

const ACTION_SWITCH_VERSION = 'switchMailpitVersion'

Definition at line 24 of file class.tpl.app.mailpit.php.

MENU

const MENU = 'mailpit'

Definition at line 19 of file class.tpl.app.mailpit.php.

MENU_SERVICE

const MENU_SERVICE = 'mailpitService'

Definition at line 21 of file class.tpl.app.mailpit.php.

MENU_VERSIONS

const MENU_VERSIONS = 'mailpitVersions'

Definition at line 20 of file class.tpl.app.mailpit.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/classes/tpls/app/class.tpl.app.mailpit.php