XoopsModules\Modulebuilder\Files\Language\LanguageModinfo::getLanguageNotifications()

Complexity

Conditions	2
Paths	2

Size

Total Lines	75
Code Lines	70

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	LanguageModinfo::getLanguageNotificationsTable()	0	31	2

<?php

namespace XoopsModules\Modulebuilder\Files\Language;

use XoopsModules\Modulebuilder;
use XoopsModules\Modulebuilder\Files;

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */
/**
 * modulebuilder module.
 *
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 *
 * @since           2.5.0
 *
 * @author          Txmod Xoops http://www.txmodxoops.org
 *
 */

/**
 * Class LanguageModinfo.
 */
class LanguageModinfo extends Files\CreateFile
{
    /**
     * @public function constructor
     * @param null
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * @static function getInstance
     * @param null
     * @return LanguageModinfo
     */
    public static function getInstance()
    {
        static $instance = false;
        if (!$instance) {
            $instance = new self();
        }

        return $instance;
    }

    /**
     * @public function write
     *
     * @param $module
     * @param $table
     * @param $filename
     *
     * @return null
     */
    public function write($module, $table, $filename)
    {
        $this->setModule($module);
        $this->setTable($table);
        $this->setFileName($filename);

        return null;
    }

    /**
     * @private function getLanguageMain
     *
     * @param $language
     * @param $module
     *
     * @return string
     */
    private function getLanguageMain($language, $module)
    {
        $df  = LanguageDefines::getInstance();
        $pc  = Modulebuilder\Files\CreatePhpCode::getInstance();
        $ret = $df->getBlankLine();
        $ret .= $pc->getPhpCodeIncludeDir("'common.php'",'', true, true, 'include');
        $ret .= $df->getBlankLine();
        $ret .= $df->getAboveHeadDefines('Admin Main');
        $ret .= $df->getDefine($language, 'NAME', (string)$module->getVar('mod_name'));
        $ret .= $df->getDefine($language, 'DESC', (string)$module->getVar('mod_description'));

        return $ret;
    }

    /**
     * @private function getLanguageMenu
     *
     * @param $module
     * @param $language
     *
     * @return string
     */
    private function getLanguageMenu($module, $language)
    {
        $df               = Modulebuilder\Files\Language\LanguageDefines::getInstance();
        $tables           = $this->getTableTables($module->getVar('mod_id'), 'table_order');
        $menu             = 1;
        $ret              = $df->getAboveHeadDefines('Admin Menu');
        $ret              .= $df->getDefine($language, "ADMENU{$menu}", 'Dashboard');
        $tablePermissions = [];
        $tableBroken      = [];
        foreach (array_keys($tables) as $i) {
            ++$menu;
            $tablePermissions[] = $tables[$i]->getVar('table_permissions');
            $tableBroken[]      = $tables[$i]->getVar('table_broken');
            $ucfTableName       = ucfirst($tables[$i]->getVar('table_name'));
            $ret                .= $df->getDefine($language, "ADMENU{$menu}", $ucfTableName);
        }
        if (in_array(1, $tableBroken)) {
            ++$menu;
            $ret    .= $df->getDefine($language, "ADMENU{$menu}", 'Broken items');
        }
        if (in_array(1, $tablePermissions)) {
            ++$menu;
            $ret .= $df->getDefine($language, "ADMENU{$menu}", 'Permissions');
        }
        ++$menu;
        $ret .= $df->getDefine($language, "ADMENU{$menu}", 'Feedback');
        $ret .= $df->getDefine($language, 'ABOUT', 'About');
        unset($menu, $tablePermissions);

        return $ret;
    }

    /**
     * @private function getLanguageAdmin
     * @param $language
     *
     * @return string
     */
    private function getLanguageAdmin($language)
    {
        $df  = LanguageDefines::getInstance();
        $ret = $df->getAboveHeadDefines('Admin Nav');
        $ret .= $df->getDefine($language, 'ADMIN_PAGER', 'Admin pager');
        $ret .= $df->getDefine($language, 'ADMIN_PAGER_DESC', 'Admin per page list');

        return $ret;
    }

    /**
     * @private function getLanguageSubmenu
     * @param       $language
     * @param array $tables
     *
     * @return string
     */
    private function getLanguageSubmenu($language, $tables)
    {
        $df          = LanguageDefines::getInstance();
        $ret         = $df->getAboveDefines('Submenu');
        $ret         .= $df->getDefine($language, 'SMNAME1', 'Index page');
        $i           = 1;
        $tableSubmit = [];
        $tableSearch = [];
        foreach (array_keys($tables) as $t) {
            $tableName     = $tables[$t]->getVar('table_name');
            $tableSearch[] = $tables[$t]->getVar('table_search');
            $ucfTablename  = ucfirst(mb_strtolower($tableName));
            if (1 == $tables[$t]->getVar('table_submenu')) {
                $ret .= $df->getDefine($language, "SMNAME{$i}", $ucfTablename);
            }
            ++$i;
            if (1 == $tables[$t]->getVar('table_submit')) {
                $ret .= $df->getDefine($language, "SMNAME{$i}", 'Submit ' . $ucfTablename);
                ++$i;
            }
        }

        if (in_array(1, $tableSearch)) {
            $ret .= $df->getDefine($language, "SMNAME{$i}", 'Search');
        }
        unset($i, $tableSubmit);

        return $ret;
    }

    /**
     * @private function getLanguageBlocks
     * @param       $language
     * @param array $tables
     *
     * @return string
     */
    private function getLanguageBlocks($tables, $language)
    {
        $df  = LanguageDefines::getInstance();
        $ret = $df->getAboveDefines('Blocks');
        foreach (array_keys($tables) as $i) {
            $tableName        = $tables[$i]->getVar('table_name');
            $stuTableName     = mb_strtoupper($tableName);
            $tableSoleName    = $tables[$i]->getVar('table_solename');
            $stuTableSoleName = mb_strtoupper($tableSoleName);
            $ucfTableName     = ucfirst($tableName);
            $ucfTableSoleName = ucfirst($stuTableSoleName);

            $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK", "{$ucfTableName} block");
            $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_DESC", "{$ucfTableName} block description");
            if (1 == $tables[$i]->getVar('table_category')) {
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_{$stuTableSoleName}", "{$ucfTableName} block {$ucfTableSoleName}");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_{$stuTableSoleName}_DESC", "{$ucfTableName} block {$ucfTableSoleName} description");
            } else {
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_{$stuTableSoleName}", "{$ucfTableName} block  {$ucfTableSoleName}");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_{$stuTableSoleName}_DESC", "{$ucfTableName} block  {$ucfTableSoleName} description");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_LAST", "{$ucfTableName} block last");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_LAST_DESC", "{$ucfTableName} block last description");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_NEW", "{$ucfTableName} block new");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_NEW_DESC", "{$ucfTableName} block new description");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_HITS", "{$ucfTableName} block hits");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_HITS_DESC", "{$ucfTableName} block hits description");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_TOP", "{$ucfTableName} block top");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_TOP_DESC", "{$ucfTableName} block top description");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_RANDOM", "{$ucfTableName} block random");
                $ret .= $df->getDefine($language, "{$stuTableName}_BLOCK_RANDOM_DESC", "{$ucfTableName} block random description");
            }
        }

        return $ret;
    }

    /**
     * @private function getLanguageUser
     * @param $language
     *
     * @return string
     */
    private function getLanguageUser($language)
    {
        $df  = LanguageDefines::getInstance();
        $ret = $df->getAboveDefines('User');
        $ret .= $df->getDefine($language, 'USER_PAGER', 'User pager');
        $ret .= $df->getDefine($language, 'USER_PAGER_DESC', 'User per page list');

        return $ret;
    }

    /**
     * @private function getLanguageConfig
     * @param $language
     * @param $tables
     *
     * @return string
     */
    private function getLanguageConfig($language, $tables)
    {
        $df          = LanguageDefines::getInstance();
        $ret         = $df->getAboveDefines('Config');
        $fieldImage  = false;
        $fieldFile   = false;
        $useTag      = false;
        $fieldEditor = false;
        // $usePermissions = false;
        foreach (array_keys($tables) as $i) {
            $fields = $this->getTableFields($tables[$i]->getVar('table_mid'), $tables[$i]->getVar('table_id'));
            $ucfTablename    = ucfirst($tables[$i]->getVar('table_name'));
            $stuTablename    = mb_strtoupper($ucfTablename);

The assignment to $stuTablename is dead and can be removed.

            foreach (array_keys($fields) as $f) {
                $fieldElement = $fields[$f]->getVar('field_element');
                if (3 == $fieldElement) {
                    $fieldEditor = true;
                }
                if (4 == $fieldElement) {
                    $fieldEditor = true;
                }
                if (13 == $fieldElement) {
                    $fieldImage = true;
                }
				if (14 == $fieldElement) {
                    $fieldFile = true;
                }
            }
            if (0 != $tables[$i]->getVar('table_tag')) {
                $useTag = true;
            }
            // if (0 != $tables[$i]->getVar('table_permissions')) {$usePermissions = true;}
        }
        if ($fieldEditor) {
            $ret .= $df->getDefine($language, 'EDITOR_DEFAULT', 'Editor');
            $ret .= $df->getDefine($language, 'EDITOR_DEFAULT_DESC', 'Select the editor which should be used for text area fields');
            $ret .= $df->getDefine($language, 'EDITOR_MAXCHAR', 'Text max characters');
            $ret .= $df->getDefine($language, 'EDITOR_MAXCHAR_DESC', 'Max characters for showing text of a textarea or editor field in admin area');
        }
        $ret .= $df->getDefine($language, 'KEYWORDS', 'Keywords');
        $ret .= $df->getDefine($language, 'KEYWORDS_DESC', 'Insert here the keywords (separate by comma)');
        /*if (usePermissions) {
            $ret .= $df->getDefine($language, "GROUPS", "Groups");
            $ret .= $df->getDefine($language, "GROUPS_DESC", "Groups to have permissions");
            $ret .= $df->getDefine($language, "ADMIN_GROUPS", "Admin Groups");
            $ret .= $df->getDefine($language, "ADMIN_GROUPS_DESC", "Admin Groups to have permissions access");
        }*/

        if ($fieldImage || $fieldFile) {
            $ret .= $df->getDefine($language, 'SIZE_MB', 'MB');
        }
        if ($fieldImage) {
            $ret .= $df->getDefine($language, 'MAXSIZE_IMAGE', 'Max size image');
            $ret .= $df->getDefine($language, 'MAXSIZE_IMAGE_DESC', 'Define the max size for uploading images');
            $ret .= $df->getDefine($language, 'MIMETYPES_IMAGE', 'Mime types image');
            $ret .= $df->getDefine($language, 'MIMETYPES_IMAGE_DESC', 'Define the allowed mime types for uploading images');
            $ret .= $df->getDefine($language, 'MAXWIDTH_IMAGE', 'Max width image');
            $ret .= $df->getDefine($language, 'MAXWIDTH_IMAGE_DESC', 'Set the max width which is allowed for uploading images (in pixel)<br>0 means that images keep original size<br>If original image is smaller the image will be not enlarged');
            $ret .= $df->getDefine($language, 'MAXHEIGHT_IMAGE', 'Max height image');
            $ret .= $df->getDefine($language, 'MAXHEIGHT_IMAGE_DESC', 'Set the max height which is allowed for uploading images (in pixel)<br>0 means that images keep original size<br>If original image is smaller the image will be not enlarged');
			//MB define
        }
		if ($fieldFile) {
            $ret .= $df->getDefine($language, 'MAXSIZE_FILE', 'Max size file');
            $ret .= $df->getDefine($language, 'MAXSIZE_FILE_DESC', 'Define the max size for uploading files');
            $ret .= $df->getDefine($language, 'MIMETYPES_FILE', 'Mime types file');
            $ret .= $df->getDefine($language, 'MIMETYPES_FILE_DESC', 'Define the allowed mime types for uploading files');
        }
        if ($useTag) {
            $ret .= $df->getDefine($language, 'USE_TAG', 'Use TAG');
            $ret .= $df->getDefine($language, 'USE_TAG_DESC', 'If you use tag module, check this option to yes');
        }
        $getDefinesConf = [
            'NUMB_COL'               => 'Number Columns',
            'NUMB_COL_DESC'          => 'Number Columns to View.',
            'DIVIDEBY'               => 'Divide By',
            'DIVIDEBY_DESC'          => 'Divide by columns number.',
            'TABLE_TYPE'             => 'Table Type',
            'TABLE_TYPE_DESC'        => 'Table Type is the bootstrap html table.',
            'PANEL_TYPE'             => 'Panel Type',
            'PANEL_TYPE_DESC'        => 'Panel Type is the bootstrap html div.',
            'IDPAYPAL'               => 'Paypal ID',
            'IDPAYPAL_DESC'          => 'Insert here your PayPal ID for donactions.',
            'ADVERTISE'              => 'Advertisement Code',
            'ADVERTISE_DESC'         => 'Insert here the advertisement code',
            'MAINTAINEDBY'           => 'Maintained By',
            'MAINTAINEDBY_DESC'      => 'Allow url of support site or community',
            'BOOKMARKS'              => 'Social Bookmarks',
            'BOOKMARKS_DESC'         => 'Show Social Bookmarks in the single page',
            'FACEBOOK_COMMENTS'      => 'Facebook comments',
            'FACEBOOK_COMMENTS_DESC' => 'Allow Facebook comments in the single page',
            'DISQUS_COMMENTS'        => 'Disqus comments',
            'DISQUS_COMMENTS_DESC'   => 'Allow Disqus comments in the single page',
        ];
        foreach ($getDefinesConf as $defc => $descc) {
            $ret .= $df->getDefine($language, $defc, $descc);
        }

        return $ret;
    }

    /**
     * @private function getLanguageNotificationsGlobal
     * @param       $language
     * @param mixed $tableSoleName
     *
     * @return string
     */
    private function getLanguageNotificationsGlobal($language)
    {
        $df               = LanguageDefines::getInstance();
        $ret              = $df->getAboveDefines('Notifications');
        $getDefinesNotif  = [
            'GLOBAL_NOTIFY'                  => 'Global notification',
            'GLOBAL_NOTIFY_DESC'             => 'Global notification desc',
            'GLOBAL_NEW_NOTIFY'              => 'New item',
            'GLOBAL_NEW_NOTIFY_CAPTION'      => 'Notify me about new items',
            'GLOBAL_NEW_NOTIFY_SUBJECT'      => 'Notification new item',
            'GLOBAL_MODIFY_NOTIFY'           => 'Item modification',
            'GLOBAL_MODIFY_NOTIFY_CAPTION'   => 'Notify me about item modification',
            'GLOBAL_MODIFY_NOTIFY_SUBJECT'   => 'Notification about modification',
            'GLOBAL_DELETE_NOTIFY'           => 'Item deleted',
            'GLOBAL_DELETE_NOTIFY_CAPTION'   => 'Notify me about deleted items',
            'GLOBAL_DELETE_NOTIFY_SUBJECT'   => 'Notification delete item',
            'GLOBAL_APPROVE_NOTIFY'          => 'Item approve',
            'GLOBAL_APPROVE_NOTIFY_CAPTION'  => 'Notify me about items waiting for approvement',
            'GLOBAL_APPROVE_NOTIFY_SUBJECT'  => 'Notification item waiting for approvement',
            'GLOBAL_BROKEN_NOTIFY'           => 'Item broken',
            'GLOBAL_BROKEN_NOTIFY_CAPTION'   => 'Notify me about broken item',
            'GLOBAL_BROKEN_NOTIFY_SUBJECT'   => 'Notification about broken item',

            //'CATEGORY_NOTIFY'                => 'Category notification',
            //'CATEGORY_NOTIFY_DESC'           => 'Category notification desc',
            //'CATEGORY_NOTIFY_CAPTION'        => 'Category notification caption',
            //'CATEGORY_NOTIFY_SUBJECT'        => 'Category notification Subject',
            //'CATEGORY_SUBMIT_NOTIFY'         => 'Category submit notification',
            //'CATEGORY_SUBMIT_NOTIFY_CAPTION' => 'Category submit notification caption',
            //'CATEGORY_SUBMIT_NOTIFY_DESC'    => 'Category submit notification desc',
            //'CATEGORY_SUBMIT_NOTIFY_SUBJECT' => 'Category submit notification subject',

        ];
        foreach ($getDefinesNotif as $defn => $descn) {
            $ret .= $df->getDefine($language, $defn, $descn);
        }

        return $ret;
    }

    /**
     * @private function getLanguageNotificationsTable
     * @param       $language
     * @param mixed $tableSoleName
     *
     * @return string
     */
    private function getLanguageNotificationsTable($language, $tableName, $tableSoleName)
    {
        $df               = LanguageDefines::getInstance();
        $ret              = $df->getAboveDefines('Notifications');
        $stuTableSoleName = mb_strtoupper($tableSoleName);
        $ucfTableSoleName = ucfirst($tableSoleName);
        $getDefinesNotif  = [
            $stuTableSoleName . '_NOTIFY'         => $ucfTableSoleName . ' notification',
            $stuTableSoleName . '_NOTIFY_CAPTION' => $ucfTableSoleName . ' notification caption',
            $stuTableSoleName . '_NOTIFY_SUBJECT' => $ucfTableSoleName . ' notification subject',
            $stuTableSoleName . '_NEW_NOTIFY'              => "New {$tableSoleName}",
            $stuTableSoleName . '_NEW_NOTIFY_CAPTION'      => "Notify me about new {$tableName}",
            $stuTableSoleName . '_NEW_NOTIFY_SUBJECT'      => "Notification new {$tableSoleName}",
            $stuTableSoleName . '_MODIFY_NOTIFY'           => "{$ucfTableSoleName} modification",
            $stuTableSoleName . '_MODIFY_NOTIFY_CAPTION'   => "Notify me about {$tableSoleName} modification",
            $stuTableSoleName . '_MODIFY_NOTIFY_SUBJECT'   => "Notification about modification",
            $stuTableSoleName . '_DELETE_NOTIFY'           => "{$ucfTableSoleName} deleted",
            $stuTableSoleName . '_DELETE_NOTIFY_CAPTION'   => "Notify me about deleted {$tableName}",
            $stuTableSoleName . '_DELETE_NOTIFY_SUBJECT'   => "Notification delete {$tableSoleName}",
            $stuTableSoleName . '_APPROVE_NOTIFY'          => "{$ucfTableSoleName} approve",
            $stuTableSoleName . '_APPROVE_NOTIFY_CAPTION'  => "Notify me about {$tableName} waiting for approvement",
            $stuTableSoleName . '_APPROVE_NOTIFY_SUBJECT'  => "Notification {$tableSoleName} waiting for approvement",
            $stuTableSoleName . '_BROKEN_NOTIFY'           => "{$ucfTableSoleName} broken",
            $stuTableSoleName . '_BROKEN_NOTIFY_CAPTION'   => "Notify me about broken {$tableSoleName}",
            $stuTableSoleName . '_BROKEN_NOTIFY_SUBJECT'   => "Notification about broken {$tableSoleName}",
        ];
        foreach ($getDefinesNotif as $defn => $descn) {
            $ret .= $df->getDefine($language, $defn, $descn);
        }

        return $ret;
    }
    /**
     * @private function getLanguagePermissionsGroups
     * @param $language
     *
     * @return string
     */
    private function getLanguagePermissionsGroups($language)
    {
        $df  = LanguageDefines::getInstance();
        $ret = $df->getAboveDefines('Permissions Groups');
        $ret .= $df->getDefine($language, 'GROUPS', 'Groups access');
        $ret .= $df->getDefine($language, 'GROUPS_DESC', 'Select general access permission for groups.');
        $ret .= $df->getDefine($language, 'ADMIN_GROUPS', 'Admin Group Permissions');
        $ret .= $df->getDefine($language, 'ADMIN_GROUPS_DESC', 'Which groups have access to tools and permissions page');
        $ret .= $df->getDefine($language, 'UPLOAD_GROUPS', 'Upload Group Permissions');
        $ret .= $df->getDefine($language, 'UPLOAD_GROUPS_DESC', 'Which groups have permissions to upload files');

        return $ret;
    }

    /**
     * @private function getFooter
     * @param null
     * @return string
     */
    private function getLanguageFooter()
    {
        $df  = LanguageDefines::getInstance();
        $ret = $df->getBelowDefines('End');
        $ret .= $df->getBlankLine();

        return $ret;
    }

    /**
     * @public function render
     * @param null
     * @return bool|string
     */
    public function render()
    {
        $module             = $this->getModule();
        $tables             = $this->getTableTables($module->getVar('mod_id'));
        $filename           = $this->getFileName();
        $moduleDirname      = $module->getVar('mod_dirname');
        $language           = $this->getLanguage($moduleDirname, 'MI');
        $tableAdmin         = [];
        $tableUser          = [];
        $tableSubmenu       = [];
        $tableBlocks        = [];
        $tableNotifications = [];
        $tablePermissions   = [];
        $tableSoleName      = '';

The assignment to $tableSoleName is dead and can be removed.

        $notifTable         = '';
        foreach (array_keys($tables) as $t) {
            $tableName            = $tables[$t]->getVar('table_name');
            $tableSoleName        = $tables[$t]->getVar('table_solename');
            $tableAdmin[]         = $tables[$t]->getVar('table_admin');
            $tableUser[]          = $tables[$t]->getVar('table_user');
            $tableSubmenu[]       = $tables[$t]->getVar('table_submenu');
            $tableBlocks[]        = $tables[$t]->getVar('table_blocks');
            $tableNotifications[] = $tables[$t]->getVar('table_notifications');
            if (1 === (int)$tables[$t]->getVar('table_notifications')) {
                $notifTable .= $this->getLanguageNotificationsTable($language, $tableName, $tableSoleName);
            }
            $tablePermissions[]   = $tables[$t]->getVar('table_permissions');
        }

        $content       = $this->getHeaderFilesComments($module);
        $content       .= $this->getLanguageMain($language, $module);
        $content       .= $this->getLanguageMenu($module, $language);
        if (in_array(1, $tableAdmin)) {
            $content .= $this->getLanguageAdmin($language);
        }
        if (in_array(1, $tableUser)) {
            $content .= $this->getLanguageUser($language);
        }
        if (in_array(1, $tableSubmenu)) {
            $content .= $this->getLanguageSubmenu($language, $tables);
        }
        //if (in_array(1, $tableBlocks)) {
        $content .= $this->getLanguageBlocks($tables, $language);
        //}
        $content .= $this->getLanguageConfig($language, $tables);
        if (in_array(1, $tableNotifications)) {
            $content .= $this->getLanguageNotificationsGlobal($language);
            $content .= $notifTable;
        }
        if (in_array(1, $tablePermissions)) {
            $content .= $this->getLanguagePermissionsGroups($language);
        }
        $content .= $this->getLanguageFooter();

        $this->create($moduleDirname, 'language/' . $GLOBALS['xoopsConfig']['language'], $filename, $content, _AM_MODULEBUILDER_FILE_CREATED, _AM_MODULEBUILDER_FILE_NOTCREATED);

        return $this->renderFile();
    }
}