ggoffy / modulebuilder

class/Files/User/UserXoopsCode.php

<?php

namespace XoopsModules\Modulebuilder\Files\User;

use XoopsModules\Modulebuilder;

/*
 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 UserXoopsCode.
 */
class UserXoopsCode
{
    /**
     * @var mixed
     */
    private $xc = null;
    /**
     * @var mixed
     */
    private $pc = null;

    /**
     * @public function constructor
     * @param null
     */
    public function __construct()
    {
        $this->xc = Modulebuilder\Files\CreateXoopsCode::getInstance();
        $this->pc = Modulebuilder\Files\CreatePhpCode::getInstance();
    }

    /*
    *  @static function getInstance
    *  @param null
    */

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

        return $instance;
    }

    /**
     * @public function getUserTplMain
     *
     * @param        $moduleDirname
     * @param string $tableName
     *
     * @return string
     */
    public function getUserTplMain($moduleDirname, $tableName = 'index')
    {
        return "\$GLOBALS['xoopsOption']['template_main'] = '{$moduleDirname}_{$tableName}.tpl';\n";
    }

    /**
     * @public function getUserAddMeta
     *
     * @param string $type
     * @param        $language
     * @param        $tableName
     *
     * @param string $t
     * @return string
     */
    public function getUserAddMeta($type, $language, $tableName, $t = '')
    {
        $stuTableName = \mb_strtoupper($tableName);
        $stripTags    = $this->pc->getPhpCodeStripTags('', $language . $stuTableName, true);

        return "{$t}\$GLOBALS['xoTheme']->addMeta('meta', '{$type}', {$stripTags});\n";
    }

    /**
     * @public function getUserMetaKeywords
     *
     * @param $moduleDirname
     *
     * @return string
     */
    public function getUserMetaKeywords($moduleDirname)
    {
        $implode = $this->pc->getPhpCodeImplode(',', '$keywords');

        return "{$moduleDirname}MetaKeywords(\$helper->getConfig('keywords') . ', ' . {$implode});\n";
    }

    /**
     * @public function getUserMetaDesc
     *
     * @param        $moduleDirname
     * @param        $language
     * @param string $file
     *
     * @return string
     */
    public function getUserMetaDesc($moduleDirname, $language, $file = 'INDEX')
    {
        return "{$moduleDirname}MetaDescription({$language}{$file}_DESC);\n";
    }

    /**
     * @public function getUserBreadcrumbs
     *
     * @param        $language
     * @param string $tableName
     * @param string $op
     * @param string $link
     * @param string $t
     *
     * @return string
     */
    public function getUserBreadcrumbs($language, $tableName = 'index', $op = '', $link = '', $t = '')
    {
        $stuTableName     = \mb_strtoupper($tableName);
        $stuOp            = '';
        $ret              = $this->pc->getPhpCodeCommentLine('Breadcrumbs', '', $t);
        if ('' !== $op) {
            $stuOp = '';
            if ('' !== $tableName) {
                $stuOp .= '_';
            }
            $stuOp .= \mb_strtoupper($op);
        }
        if ('' === $link) {
            $arrBCrumb        = ["'title'" => "{$language}{$stuTableName}{$stuOp}"];
        } else {
            $arrBCrumb        = ["'title'" => "{$language}{$stuTableName}{$stuOp}", "'link'" => "'{$link}'"];
        }
        $ret .= $this->pc->getPhpCodeArray('xoBreadcrumbs[]', $arrBCrumb, false, $t);

        return $ret;
    }

    /**
     * @public function getUserBreadcrumbs
     *
     * @return string
     */
    public function getUserBreadcrumbsFooterFile()
    {
        $cond = $this->xc->getXcXoopsTplAssign('xoBreadcrumbs', '$xoBreadcrumbs');
        $ret  = $this->pc->getPhpCodeConditions('\count($xoBreadcrumbs)', ' > ', '1', $cond, false, "\t\t");

        return $ret;
    }

    /**
     * @public function getUserModVersionArray
     *
     * @param int    $eleArray
     * @param        $descriptions
     * @param null   $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @param null   $index

Are you sure the doc-type for parameter $index is correct as it would always require null to be passed?

     * @param bool   $num
     * @param string $t
     *
     * @return string
     */
    public function getUserModVersionArray($eleArray, $descriptions, $name = null, $index = null, $num = false, $t = '')
    {
        $ret     = $t . '$modversion';
        $isArray = false;
        $n       = '';
        if (!\is_array($descriptions)) {
            $descs = [$descriptions];
        } else {
            $descs   = $descriptions;
            $isArray = true;
            $n       = "\n";
        }
        if (0 === $eleArray) {
            $ret .= " = ";
        } elseif (1 === $eleArray || 11 === $eleArray) {
            $ret .= "['{$name}'] = ";
        } elseif (2 === $eleArray) {
            $ret .= "['{$name}'][{$index}] = ";
        } elseif (3 === $eleArray) {
            $ret .= "['{$name}'][{$index}][{$num}] = ";
        }
        if ($isArray) {
            $ret .= "[";
        }
        $ret .= $n;
        //search for longest key
        $len = 0;
        foreach ($descs as $key => $desc) {
            $len = \strlen($key) > $len ? \strlen($key) : $len;
        }

        foreach ($descs as $key => $desc) {
            $space = str_repeat(' ', $len - \strlen($key));
            if ($eleArray < 4) {
                $ret .= $t . "\t'{$key}'{$space} => {$desc},{$n}";
            } elseif (11 === $eleArray) {
                if ('/' === \substr($desc, 1, 1)) {
                    $ret .= $t . "\t{$desc}";
                } else {
                    $ret .= $t . "\t{$desc},{$n}";
                }
            } elseif (12 === $eleArray) {
                $ret .= $t . "\t{$desc}{$n}";
            }
        }
        $ret .= $t;
        if ($isArray) {
            $ret .= "]";
        }
        $ret .= ";\n";
        return $ret;
    }

    /**
     * @public function getUserModVersionText
     *
     * @param int    $eleArray
     * @param        $text
     * @param null   $name

Are you sure the doc-type for parameter $name is correct as it would always require null to be passed?

     * @param null   $index

Are you sure the doc-type for parameter $index is correct as it would always require null to be passed?

     * @param bool   $num
     * @param string $t
     *
     * @return string
     */
    public function getUserModVersionText($eleArray, $text, $name = null, $index = null, $num = false, $t = '')
    {
        $ret = $t . '$modversion';

        if (0 === $eleArray) {
            $ret .= " = ";
        } elseif (1 === $eleArray) {
            $ret .= "['{$name}'] = ";
        } elseif (2 === $eleArray) {
            $ret .= "['{$name}'][{$index}] = ";
        } elseif (3 === $eleArray) {
            $ret .= "['{$name}'][{$index}][{$num}] = ";
        }

        $ret .= $t . "{$text};\n";
        return $ret;
    }
}