txmodxoops / tdmcreate

class/Files/User/UserRate.php

<?php

namespace XoopsModules\Tdmcreate\Files\User;

use XoopsModules\Tdmcreate;
use XoopsModules\Tdmcreate\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.
 */
/**
 * tdmcreate 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 UserRate.
 */
class UserRate extends Files\CreateFile
{
    /**
     * @var string
     */
    private $xc = null;
	
	/**
     * @var string
     */
    private $pc = null;
	
	/**
     * @var string
     */
    private $uxc = null;
	
	
	/**
     * @public function constructor
     *
     * @param null
     */
    public function __construct()
    {
        parent::__construct();
        $this->xc      = Tdmcreate\Files\CreateXoopsCode::getInstance();

It seems like XoopsModules\Tdmcreate\Files\CreateXoopsCode::getInstance() of type XoopsModules\Tdmcreate\Files\CreateXoopsCode is incompatible with the declared type string of property $xc.

        $this->pc = Tdmcreate\Files\CreatePhpCode::getInstance();

It seems like XoopsModules\Tdmcreate\Files\CreatePhpCode::getInstance() of type XoopsModules\Tdmcreate\Files\CreatePhpCode is incompatible with the declared type string of property $pc.

        $this->uxc      = UserXoopsCode::getInstance();

It seems like XoopsModules\Tdmcreate\Files\User\UserXoopsCode::getInstance() of type XoopsModules\Tdmcreate\Files\User\UserXoopsCode is incompatible with the declared type string of property $uxc.

    }

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

        return $instance;
    }

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

    /**
     * @private function getUserRateHeader
     *
     * @param $moduleDirname
     * @param $tableName
     *
     * @return string
     */
    public function getUserRateHeader($moduleDirname, $tableName)
    {
        $pc  = Tdmcreate\Files\CreatePhpCode::getInstance();
        $ret = $pc->getPhpCodeUseNamespace(['Xmf', 'Request'], '', '');
        $ret .= $pc->getPhpCodeUseNamespace(['XoopsModules', $moduleDirname], '', '');
        $ret .= $pc->getPhpCodeUseNamespace(['XoopsModules', $moduleDirname, 'Constants']);
        $ret .= $this->getInclude();
        $ret .= $this->xc->getXcXoopsRequest('op', 'op', 'form');
        $ret .= $this->xc->getXcXoopsRequest('lid', 'lid', '', 'Int');
        $ret .= $this->uxc->getUserTplMain($moduleDirname, $tableName);
        $ret .= $this->pc->getPhpCodeIncludeDir('XOOPS_ROOT_PATH', 'header', true);
        $ret .= $this->pc->getPhpCodeCommentLine('Define Stylesheet');
        $ret .= $this->xc->getXcXoThemeAddStylesheet();

        return $ret;
    }

    /**
     * @private function getUserRateSwitch
     * @param $moduleDirname
     * @param $tableId
     * @param $tableMid
     * @param $tableName
     * @param $tableSoleName
     * @param $tableAutoincrement
     * @param $language
     * @return string
     */
    private function getUserRateSwitch($moduleDirname, $tableId, $tableMid, $tableName, $tableSoleName, $tableAutoincrement, $language)

The method getUserRateSwitch() is not used, and could be removed.

    {
        $fields = $this->getTableFields($tableMid, $tableId);
        $cases  = [
            'form' => [$this->getUserRateForm($tableName, $language)],
            'save' => [$this->getUserRateSave($moduleDirname, $fields, $tableName, $tableSoleName, $tableAutoincrement, $language)],
        ];

        return $this->xc->getXcSwitch('op', $cases, true, false, "\t");
    }

    /**
     * @public function getAdminPagesList
     * @param $tableName
     * @param $language
     *
     * @return string
     */
    public function getUserRateForm($tableName, $language)
    {
        $ret = $this->pc->getPhpCodeCommentLine('Navigation');
        $ret .= $this->xc->getXcEqualsOperator('$navigation', "{$language}RATE", null, "\t\t");
        $ret .= $this->xc->getXcXoopsTplAssign('navigation', '$navigation', true, "\t\t");
        $ret .= $this->pc->getPhpCodeCommentLine('Title of page', null, "\t\t");
        $ret .= $this->xc->getXcEqualsOperator('$title', "{$language}RATE . ' - '", null, "\t\t");
        $ret .= $this->xc->getXcEqualsOperator('$title', "\$GLOBALS['xoopsModule']->name()", '.', "\t\t");
        $ret .= $this->xc->getXcXoopsTplAssign('xoops_pagetitle', '$title', true, "\t\t");
        $ret .= $this->pc->getPhpCodeCommentLine('Description', null, "\t\t");
        $ret .= $this->uxc->getUserAddMeta('description', $language, 'RATE', "\t\t");
        $ret .= $this->pc->getPhpCodeCommentLine('Form Create', null, "\t\t");
        $ret .= $this->xc->getXcHandlerCreateObj($tableName, "\t\t");
        $ret .= $this->xc->getXcGetForm('form', $tableName, 'Obj', "\t\t");
        $ret .= $this->xc->getXcXoopsTplAssign('form', '$form->render()', true, "\t\t");

        return $ret;
    }

    /**
     * @public function getUserRateSave
     * @param $moduleDirname
     * @param $fields
     * @param $tableName
     * @param $tableSoleName
     * @param $tableAutoincrement
     * @param $language
     * @return string
     */
    public function getUserRateSave($moduleDirname, $fields, $tableName, $tableSoleName, $tableAutoincrement, $language)

The parameter $tableAutoincrement is not used and could be removed.

    {
        $ret                = $this->pc->getPhpCodeCommentLine('Security Check');
        $xoopsSecurityCheck = $this->xc->getXcXoopsSecurityCheck();
        $securityError      = $this->xc->getXcXoopsSecurityErrors();
        $implode            = $this->pc->getPhpCodeImplode(',', $securityError);
        $redirectError      = $this->xc->getXcRedirectHeader($tableName, '', '3', $implode, true, "\t\t\t");
        $ret                .= $this->pc->getPhpCodeConditions($xoopsSecurityCheck, '', '', $redirectError, false, "\t\t");
        $ret                .= $this->xc->getXcHandlerCreateObj($tableName, "\t\t");

        $ret .= $this->xc->getXcSaveElements($moduleDirname, $tableName, $tableSoleName, $fields, "\t\t");

        $ret       .= $this->pc->getPhpCodeCommentLine('Insert Data', null, "\t\t");
        $insert    = $this->xc->getXcHandlerInsert($tableName, $tableName, 'Obj', true);
        $confirmOk = $this->xc->getXcRedirectHeader('index', '', '2', "{$language}FORM_OK", true, "\t\t\t");
        $ret       .= $this->pc->getPhpCodeConditions($insert, '', '', $confirmOk, false, "\t\t");

        $ret .= $this->pc->getPhpCodeCommentLine('Get Form Error', null, "\t\t");
        $ret .= $this->xc->getXcXoopsTplAssign('error', "\${$tableName}Obj->getHtmlErrors()", true, "\t\t");
        $ret .= $this->xc->getXcGetForm('form', $tableName, 'Obj', "\t\t");
        $ret .= $this->xc->getXcXoopsTplAssign('form', '$form->display()', true, "\t\t");

        return $ret;
    }

    /**
     * @public function getUserRateFooter
     * @param $moduleDirname
     * @param $language
     * @return string
     */
    public function getUserRateFooter($moduleDirname, $language)

The parameter $moduleDirname is not used and could be removed.

    {
        $ret              = $this->pc->getPhpCodeCommentLine('Breadcrumbs');
        $ret              .= $this->uxc->getUserBreadcrumbs('RATE', $language);
        $ret              .= $this->getInclude('footer');

        return $ret;
    }

    /**
     * @public function render
     * @param null
     * @return bool|string
     */
    public function render()
    {
        $module             = $this->getModule();
        $table              = $this->getTable();
        $filename           = $this->getFileName();
        $moduleDirname      = $module->getVar('mod_dirname');
        $tableId            = $table->getVar('table_id');

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

        $tableMid           = $table->getVar('table_mid');

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

        $tableName          = $table->getVar('table_name');

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

        $tableSoleName      = $table->getVar('table_solename');

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

        $tableAutoincrement = $table->getVar('table_autoincrement');

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

        $language           = $this->getLanguage($moduleDirname, 'MA');

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

        $content            = $this->getHeaderFilesComments($module);
        //$content            .= $this->getUserRateHeader($moduleDirname, $tableName);
        //$content            .= $this->getUserRateSwitch($moduleDirname, $tableId, $tableMid, $tableName, $tableSoleName, $tableAutoincrement, $language);
        //$content            .= $this->getUserRateFooter($moduleDirname, $language);

        $this->create($moduleDirname, '/', $filename, $content, _AM_TDMCREATE_FILE_CREATED, _AM_TDMCREATE_FILE_NOTCREATED);

        return $this->renderFile();
    }
}