TDMCreateFile::getStrToUpper() - Code Metrics - Inspection of "Timgno" - txmodxoops/tdmcreate - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#45)

by Gino

created 2016-01-14 14:54 UTC

TDMCreateFile::getStrToUpper() A

↳ Parent: TDMCreateFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php


/*
 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       The XOOPS Project http://sourceforge.net/projects/xoops/
 * @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
 *
 * @version         $Id: TDMCreateFile.php 12258 2014-01-02 09:33:29Z timgno $
 */
defined('XOOPS_ROOT_PATH') || die('Restricted access');

xoops_load('XoopsFile');

/**
 * Class TDMCreateFile.
 */
class TDMCreateFile extends TDMCreateTableFields
namespace YourVendor;

class YourClass { }
{
    /*
    * @var string
    */
    private $xoopsFile;

    /**
     * "filename" attribute of the files.
     *
     * @var mixed
     */
    private $fileName;


    /**
     * "path" attribute of the files.
     *
     * @var string
     */
    private $path;


    /**
     * "uploadPath" attribute of the files.
     *
     * @var string
     */
    private $uploadPath;

    /**
     * "folder_name" attribute of the files.
     *
     * @var string
     */
    private $folderName;


    /*
    * @var string
    */
    private $content;

    /*
    * @var mixed
    */
    private $created = false;

    /*
    * @var mixed
    */
    private $notCreated = false;

    /*
    * @var string
    */
    private $mode;

    /*
    * @var string
    */
    protected $tdmcfile;

    /*
    *  @public function constructor
    *  @param null
    */
    /**
     *
     */
    public function __construct()
    {
        parent::__construct();
        $this->xoopsFile = XoopsFile::getHandler();
        $this->tdmcreate = TDMCreateHelper::getInstance();
    }

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

        return $instance;
    }

    /**
     * @public function create
     *
     * @param $moduleDirname
     * @param $subdir
     * @param $fileName
     * @param $content
     * @param $created
     * @param $notCreated
     * @param $mode
     */
    public function create($moduleDirname, $subdir = null, $fileName, $content = '', $created = false, $notCreated = false, $mode = 'w+')
    {
        $this->setFileName($fileName);
        $this->created = $created;
        $this->notCreated = $notCreated;
        $this->setMode($mode);
        $this->setRepositoryPath($moduleDirname);
        if (!empty($content) && is_string($content)) {
            $this->setContent($content);
        }
        if (isset($subdir) && is_string($subdir)) {
            $this->setSubDir($subdir);
        }
    }

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

    /*
    *  @private function setRepositoryPath
    *  @param string $moduleDirname
    */
    /**
     * @param $moduleDirname
     */
    private function setRepositoryPath($moduleDirname)
    {
        $this->uploadPath = TDMC_UPLOAD_REPOSITORY_PATH.DIRECTORY_SEPARATOR.$moduleDirname;
    }

    /*
    *  @private function getRepositoryPath
    *  @param null
    */
    /**
     * @return string
     */
    private function getRepositoryPath()
    {
        return $this->uploadPath;
    }

    /*
    *  @private function setSubDir
    *  @param string $subdir
    */
    /**
     * @param $subdir
     */
    private function setSubDir($subdir)
    {
        $this->subdir = $subdir;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /*
    *  @private function getSubDir
    *  @param null
    */
    private function getSubDir()
    {
        return $this->subdir;
    }

    /**
     * public function setFileName.
     *
     * @param $fileName
     *
     * @internal param mixed $file_name
     */
    public function setFileName($fileName)
    {
        $this->filename = $fileName;

    }

    /*
    *  @public function getFileName
    *  @param null
    */
    /**
     * @return mixed
     */
    public function getFileName()
    {
        return $this->filename;

    }

    /*
    *  @private function setContent
    *  @param string $content
    */
    /**
     * @param $content
     */
    private function setContent($content)
    {
        $this->content = $content;
    }

    /*
    *  @private function setContent
    *  @param null
    */
    /**
     */
    private function getContent()
    {
        return $this->content;
    }

    /*
    *  @private function getFolderName
    *  @param null
    */
    /**
     * @return string
     */
    private function getFolderName()
    {
        $path = $this->getUploadPath();
        if (strrpos($path, '\\')) {
            $str = strrpos($path, '\\');
            if ($str !== false) {
                return substr($path, $str + 1, strlen($path));
            } else {
                return substr($path, $str, strlen($path));
            }
        }
        //return 'root module';
        return;
    }

    /*
    *  @public function getUploadPath
    *  @param null
    */
    /**
     * @return string
     */
    private function getUploadPath()
    {
        if ($this->getSubDir() != null) {
            $ret = $this->getRepositoryPath().DIRECTORY_SEPARATOR.$this->getSubDir();
        } else {
            $ret = $this->getRepositoryPath();
        }

        return $ret;
    }

    /*
    *  @private function getCreated
    *  @param null
    */
    /**
     * @return bool
     */
    private function getCreated()
    {
        return $this->created;
    }

    /*
    *  @private function getNotCreated
    *  @param null
    */
    /**
     * @return bool
     */
    private function getNotCreated()
    {
        return $this->notCreated;
    }

    /*
    *  @private function setMode
    *  @param string $mode
    */
    /**
     * @param $mode
     */
    private function setMode($mode)
    {
        $this->mode = $mode;
    }

    /*
    *  @private function getMode
    *  @param null
    */
    /**
     */
    private function getMode()
    {
        return $this->mode;
    }

    /*
    *  @public function getLanguage
    *  @param string $moduleDirname
    *  @param string $prefix
    *  @param string $suffix
    */
    /**
     * @param        $moduleDirname
     * @param string $prefix
     * @param string $suffix
     *
     * @return string
     */
    public function getLanguage($moduleDirname, $prefix = '', $suffix = '')
    {
        $lang = '_'.$prefix.'_'.strtoupper($moduleDirname);
        $ret = $lang;
        if (!empty($suffix) || $suffix != '_') {
            $ret = $lang.'_'.$suffix;
        } elseif ($suffix == '_') {
            $ret = $lang.'_';
        }

        return $ret;
    }

    /*
    *  @public function getLeftString
    *  @param string $string
    */
    /**
     * @param $string
     *
     * @return string
     */
    public function getLeftString($string)
    {
        return substr($string, 0, strpos($string, '_'));
    }

    /*
    *  @public function getRightString
    *  @param string $string
    */
    /**
     * @param $string
     *
     * @return string
     */
    public function getRightString($string)
    {
        if (strpos($string, '_')) {

            $str = strpos($string, '_');
            if ($str !== false) {
                $ret = substr($string, $str + 1, strlen($string));

                return $ret;
            }
        }

        return $string;
    }

    /*
     *  @public function getCamelCase
     *  @param $string
     */
    /**
     * @param $string
     * @param $ucfirst
     * @param $lcfirst
     *
     * @return string
     */
    public function getCamelCase($string, $ucfirst = false, $lcfirst = false)
    {
        $rightString = $this->getRightString($string);
        $leftString = $this->getLeftString($string);
        if ($ucfirst) {
            $ret = $this->getUcfirst($leftString).$this->getUcfirst($rightString);

            return $ret;
        }
        if ($lcfirst) {
            $ret = $this->getlcfirst($leftString).$this->getUcfirst($rightString);

            return $ret;
        }

        return $string;
    }

    /*
     *  @public function getUcfirst
     *  @param $string
     */
    /**
     * @param $string
     *
     * @return string
     */
    public function getUcfirst($string)
    {
        return ucfirst($string);
    }

    /*
     *  @public function getLcfirst
     *  @param $string
     */
    /**
     * @param $string
     *
     * @return string
     */
    public function getLcfirst($string)
    {
        return lcfirst($string);
    }

    /*
     *  @public function getStrToUpper
     *  @param $string
     */
    /**
     * @param $string
     *
     * @return string
     */
    public function getStrToUpper($string)
    {
        return strtoupper($string);
    }

    /*
     *  @public function getStrToLower
     *  @param $string
     */
    /**
     * @param $string
     *
     * @return string
     */
    public function getStrToLower($string)
    {
        return strtolower($string);
    }

    /*
    *  @public function getInclude
    *  @param $filename
    */
    /**
     * @return string
     */
    public function getInclude($filename = 'header')
    {
        return "include __DIR__ . '/{$filename}.php';\n";
    }

    /*
    *  @public function getIncludeOnce
    *  @param $filename
    */
    /**
     * @return string
     */
    public function getIncludeOnce($filename = 'header')
    {
        return "include_once __DIR__ . '/{$filename}.php';\n";
    }

    /*
     *  @public function getCommentLine
     *  @param $string
     */
    /**
     * @param $string
     *
     * @return string
     */
    public function getCommentLine($string)
    {
        $ret = <<<EOT
// {$string}\n
EOT;

        return $ret;
    }

    /*
     * @public function getSimpleString
     * @param $string     
     *
     * @return string
     */
    public function getSimpleString($string)
    {
        $ret = <<<EOT
{$string}\n
EOT;

        return $ret;
    }
	
	/*
     * @public function getRemoveCarriageReturn
     * @param $string     
     *
     * @return string
     */
    public function getRemoveCarriageReturn($string)
    {
        return str_replace(array("\n", "\r"), '', $string);
    }	

    /*
    *  @public function getHeaderFilesComments
    *  @param string $module
    *  @param string $fileName
    */
    /**
     * @param $module
     * @param $fileName
     * @param $noPhpFile
     *
     * @return string
     */
    public function getHeaderFilesComments($module, $fileName, $noPhpFile = null)
    {
        $name = $module->getVar('mod_name');
        $dirname = $module->getVar('mod_dirname');
        $version = $module->getVar('mod_version');
        $since = $module->getVar('mod_since');
        $minXoops = $module->getVar('mod_min_xoops');
        $author = $module->getVar('mod_author');
        $credits = $module->getVar('mod_credits');
        $authorMail = $module->getVar('mod_author_mail');
        $authorWebsiteUrl = $module->getVar('mod_author_website_url');
        $license = $module->getVar('mod_license');
        $subversion = $module->getVar('mod_subversion');
        $date = date('D Y-m-d H:i:s');
        if (is_null($noPhpFile)) {
            $ret = <<<EOT
<?php
/*\n
EOT;
        } elseif (is_string($noPhpFile)) {
            $ret = <<<EOT
{$noPhpFile}
/*\n
EOT;
        } else {
            $ret = <<<EOT
/*\n
EOT;
        }
        $ret .= <<<EOT
 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.
*/
/**
 * {$name} module for xoops
 *
 * @copyright       The XOOPS Project (http://xoops.org)
 * @license         {$license}
 * @package         {$dirname}
 * @since           {$since}
 * @min_xoops       {$minXoops}
 * @author          {$author} - Email:<{$authorMail}> - Website:<{$authorWebsiteUrl}>
 * @version         \$Id: {$version} {$fileName} {$subversion} {$date}Z {$credits} \$
 */\n
EOT;

        return $ret;
    }

    /*
    *  @public function renderFile
    *  @param null
    */
    /**
     * @return string
     */
    public function renderFile()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $fileName = $this->getFileName();
        $path = $this->getUploadPath().DIRECTORY_SEPARATOR.$fileName;
        $created = $this->getCreated();
        $notCreated = $this->getNotCreated();
        $folderName = $this->getFolderName();
        $mode = $this->getMode();
        $ret = '';
        if (!$this->xoopsFile->__construct($path, true)) {

            // Force to create file if not exist
            if ($this->xoopsFile->open($mode, true)) {

                if ($this->xoopsFile->writable()) {

                    // Integration of the content in the file
                    if (!$this->xoopsFile->write($this->getContent(), $mode, true)) {

                        $ret .= sprintf($notCreated, $fileName, $folderName);
                        $GLOBALS['xoopsTpl']->assign('created', false);
                        exit();

                    }
                    // Created
                    $ret .= sprintf($created, $fileName, $folderName);
                    $GLOBALS['xoopsTpl']->assign('created', true);
                    $this->xoopsFile->close();

                } else {
                    $ret .= sprintf($notCreated, $fileName, $folderName);
                    $GLOBALS['xoopsTpl']->assign('created', false);
                }
            } else {
                $ret .= sprintf($notCreated, $fileName, $folderName);
                $GLOBALS['xoopsTpl']->assign('created', false);
            }
        }

        return $ret;
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-23 22:08 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 31 and the first side effect is on line 24. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/*
4			You may not change or alter any portion of this comment or credits
5			of supporting developers from this source code or any supporting source code
6			which is considered copyrighted (c) material of the original comment or credit authors.
7
8			This program is distributed in the hope that it will be useful,
9			but WITHOUT ANY WARRANTY; without even the implied warranty of
10			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*/
12			/**
13			* tdmcreate module.
14			*
15			* @copyright The XOOPS Project http://sourceforge.net/projects/xoops/
16			* @license GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
17			*
18			* @since 2.5.0
19			*
20			* @author Txmod Xoops http://www.txmodxoops.org
21			*
22			* @version $Id: TDMCreateFile.php 12258 2014-01-02 09:33:29Z timgno $
23			*/
24			defined('XOOPS_ROOT_PATH') \|\| die('Restricted access');
25
26			xoops_load('XoopsFile');
27
28			/**
29			* Class TDMCreateFile.
30			*/
31			class TDMCreateFile extends TDMCreateTableFields
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-23 22:08 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
32			{
33			/*
34			* @var string
35			*/
36			private $xoopsFile;
37
38			/**

txmodxoops / tdmcreate

Pull Request — master (#45)

TDMCreateFile::getStrToUpper() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like