ggoffy / modulebuilder

class/Files/Language/LanguageBlocks.php

<?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 (https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 *
 * @since           2.5.0
 *
 * @author          Txmod Xoops https://xoops.org 
 *                  Goffy https://myxoops.org
 *
 */

/**
 * Class LanguageBlocks.
 */
class LanguageBlocks extends Files\CreateFile
{
    /**
     * @var mixed
     */
    private $ld = null;

    /**
     * @public function constructor
     * @param null
     */
    public function __construct()
    {
        parent::__construct();
        $this->ld = LanguageDefines::getInstance();
    }

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

        return $instance;
    }

    /**
     * @public function write
     * @param string $module
     * @param mixed  $tables
     * @param string $filename
     */
    public function write($module, $tables, $filename)
    {
        $this->setModule($module);
        $this->setFileName($filename);
        $this->setTables($tables);
    }

    /**
     * @private function getLanguageBlock
     * @param string $language
     *
     * @return string
     */
    private function getLanguageBlock($language)
    {
        $tables = $this->getTables();
        $ret    = $this->ld->getAboveDefines('Admin Edit');
        $ret    .= $this->ld->getDefine($language, 'DISPLAY', 'How Many Items to Display');
        $ret    .= $this->ld->getDefine($language, 'DISPLAY_SPOTLIGHT', "How Many Items to Display (only valid if you select 'all')", true);
        $ret    .= $this->ld->getDefine($language, 'TITLE_LENGTH', 'Title Length');
        $ret    .= $this->ld->getDefine($language, 'CATTODISPLAY', 'Categories to Display');
        $ret    .= $this->ld->getDefine($language, 'ALLCAT', 'All Categories');
        foreach (\array_keys($tables) as $t) {
            if (1 === (int)$tables[$t]->getVar('table_blocks')) {
                $tableName        = $tables[$t]->getVar('table_name');
                $tableSoleName    = $tables[$t]->getVar('table_solename');
                $ucfTableName     = \ucfirst($tableName);
                $ucfTableSoleName = \ucfirst($tableSoleName);
                $stuTableName     = \mb_strtoupper($tableName);
                $stuTableSoleName = \mb_strtoupper($tableSoleName);
                $ret .= $this->ld->getAboveDefines($ucfTableName);
                $fields = $this->getTableFields($tables[$t]->getVar('table_mid'), $tables[$t]->getVar('table_id'));
                $ret .= $this->ld->getDefine($language, $stuTableName . '_TO_DISPLAY', $ucfTableName . ' to Display');
                $ret .= $this->ld->getDefine($language, 'ALL_' . $stuTableName, 'All ' . $ucfTableName);
                foreach (\array_keys($fields) as $f) {
                    if (1 === (int)$fields[$f]->getVar('field_block')) {
                        $fieldName = $fields[$f]->getVar('field_name');
                        $stuFieldName = \mb_strtoupper($fieldName);
                        $rpFieldName = $this->getRightString($fieldName);
                        $fieldNameDesc = \ucfirst($rpFieldName);
                        $ret .= $this->ld->getDefine($language, $stuFieldName, $fieldNameDesc);
                    }
                }
                $ret .= $this->ld->getDefine($language, $stuTableSoleName . '_GOTO', 'Goto ' . $ucfTableSoleName);
            }
        }

        return $ret;
    }

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

        return $ret;
    }

    /**
     * @public function render
     * @param null
     * @return bool|string
     */
    public function render()
    {
        $module        = $this->getModule();
        $filename      = $this->getFileName();
        $moduleDirname = $module->getVar('mod_dirname');
        $language      = $this->getLanguage($moduleDirname, 'MB', '', false);

false of type false is incompatible with the type string expected by parameter $addFq of XoopsModules\Modulebuilder\Files\CreateFile::getLanguage().

        $content       = $this->getHeaderFilesComments($module);
        $content       .= $this->getLanguageBlock($language);
        $content       .= $this->getLanguageFooter();

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

        return $this->renderFile();
    }
}