Func_App

Complexity

Total Complexity

96

Size/Duplication

Total Lines	766
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

45 Methods

Rating	Name	Duplication	Size	Complexity
A	loadObject()	0	20	5
A	getSetPath()	0	3	1
A	getRecordSetPathname()	0	5	1
A	getCtrlPath()	0	3	1
A	includeBase()	0	3	1
A	getDescription()	0	3	1
A	includeRecordSet()	0	3	1
A	getPhpPath()	0	3	1
A	includeTraceableRecordSet()	0	3	1
A	__construct()	0	21	1
A	getAddonName()	0	3	1
B	getSynchronizeSql()	0	36	11
A	getRecordPathname()	0	5	1
A	getAddon()	0	3	1
A	getUiPath()	0	3	1
A	register()	0	8	1
B	synchronizeSql()	0	50	11
A	translateArray()	0	8	2
A	LinkClassName()	0	3	1
A	includeUi()	0	3	1
A	Controller()	0	4	1
A	getRecordRef()	0	5	1
A	LogClassName()	0	3	1
B	__call()	0	38	8
A	shortFormatWithUnit()	0	17	4
A	includeAccess()	0	3	1
A	LinkSet()	0	6	1
A	includeRecordController()	0	3	1
A	phoneNumberFormat()	0	19	4
A	__isset()	0	26	6
A	ControllerProxy()	0	9	2
A	translate()	0	11	2
A	LogSetClassName()	0	3	1
A	includeLinkSet()	0	3	1
A	Ui()	0	4	1
A	LinkSetClassName()	0	3	1
A	numberFormat()	0	8	2
A	setTranslateLanguage()	0	3	1
A	includeController()	0	3	1
A	LogSet()	0	6	1
A	includeLogSet()	0	3	1
A	getRecordByRef()	0	13	3
A	mailTo()	0	15	4
A	translatable()	0	3	1
A	getUploadPath()	0	4	1

<?php
//-------------------------------------------------------------------------
// OVIDENTIA http://www.ovidentia.org
// Ovidentia is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2, or (at your option)
// any later version.
//
// 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.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.
//-------------------------------------------------------------------------
/**
 * @license http://opensource.org/licenses/gpl-license.php GNU General Public License (GPL)
 * @copyright Copyright (c) 2018 by CANTICO ({@link http://www.cantico.fr})
 */

require_once dirname(__FILE__) . '/define.php';
require_once dirname(__FILE__) . '/functions.php';



/**
 * Provides extensible functionalities to manage an application.
 *
 * @method app_CustomFieldSet       CustomFieldSet()
 * @method app_CustomSectionSet     CustomSectionSet()
 */
class Func_App extends bab_Functionality
{
    public $addonPrefix;
    public $classPrefix;
    public $addonName;
    public $controllerTg;
    public $phpPath;
    public $recordSetPath;
    public $ctrlPath;
    public $uiPath;


    /**
     * @var string
     */
    private $language = null;


    public function __construct()
    {
        $this->addonName = 'libapp';
        $this->addonPrefix = 'app';

        $this->classPrefix = $this->addonPrefix . '_';
        $this->controllerTg = 'addon/' . $this->addonName . '/main';

        $addon = bab_getAddonInfosInstance($this->addonName);
        $this->phpPath = $addon->getPhpPath();
        $this->recordSetPath = $this->phpPath;
        $this->ctrlPath = $this->phpPath;
        $this->uiPath = $this->phpPath . 'ui/';

        $babDB = bab_getDB();

        $LibOrm = bab_Functionality::get('LibOrm');
        /*@var $LibOrm Func_LibOrm */

        $LibOrm->initMysql();
        ORM_RecordSet::setBackend(new ORM_MySqlBackend($babDB));
    }


    /**
     * @param string $class
     * @return boolean
     */
    public function loadObject($class)
    {
        $classPrefix = $this->classPrefix;

        if (substr($class, 0, strlen($classPrefix)) === $classPrefix) {
            if (substr($class, -3) === 'Set') {
                $pathname = $this->getRecordSetPathname($class);
                if (file_exists($pathname)) {
                    require $pathname;
                    return true;
                }
            } else {
                $pathname = $this->getRecordPathname($class);
                if (file_exists($pathname)) {
                    require $pathname;
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Returns the expected pathname for the file containing the definition of the record set class.
     *
     * @param string $class
     * @return string
     */
    public function getRecordSetPathname($class)
    {
        // $App->MyRecordSet() -> myrecord.class.php
        $file = strtolower(substr($class, strlen($this->classPrefix), -3)) . '.class.php';
        return $this->recordSetPath . $file;
    }

    /**
     *  Returns the expected pathname for the file containing the definition of the record class.
     *
     * @param string $class
     * @return string
     */
    public function getRecordPathname($class)
    {
        // $App->MyRecord() -> myrecord.class.php
        $file = strtolower(substr($class, strlen($this->classPrefix))) . '.class.php';
        return $this->recordSetPath . $file;
    }

    /**
     * @return string
     */
    public function getUiPath()
    {
        return APP_UI_PATH;
    }

    /**
     * @return string
     */
    public function getSetPath()
    {
        return APP_SET_PATH;
    }

    /**
     * @return string
     */
    public function getCtrlPath()
    {
        return APP_CTRL_PATH;
    }

    /**
     * @return string
     */
    public function getPhpPath()
    {
        return APP_PHP_PATH;
    }


    /**
     * @return string
     *
     */
    public function getDescription()
    {
        return 'Application framework.';
    }


    /**
     * Get the addon name
     * @return string
     */
    public function getAddonName()
    {
        return $this->addonName;
    }


    /**
     * @return bab_addonInfos
     */
    public function getAddon()
    {
        return bab_getAddonInfosInstance($this->getAddonName());
    }


    /**
     * Register myself as a functionality.
     *
     */
    public static function register()
    {
        require_once $GLOBALS['babInstallPath'].'utilit/functionalityincl.php';
        $functionalities = new bab_functionalities();

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

        $addon = bab_getAddonInfosInstance('libapp');

        $addon->registerFunctionality('App', 'app.php');
    }


    /**
     * Synchronize sql tables for all classes found in Application object
     * using methods  'includeXxxxxClassName'
     * sychronize if the two correspond methods are met and the set classname match the prefix from parameter
     * do not synchronize if the set method has a VueSet suffix, in this case the table si juste a readonly vue
     *
     * @param	string	$prefix		tables and classes prefix
     * @return bab_synchronizeSql
     */
    public function synchronizeSql($prefix)
    {
        if (!$prefix) {
            return null;
        }

        require_once $GLOBALS['babInstallPath'].'utilit/devtools.php';
        $mysqlbackend = new ORM_MySqlBackend($GLOBALS['babDB']);
        $sql = 'SET FOREIGN_KEY_CHECKS=0;
            ';

        foreach (get_class_methods($this) as $method) {

            if (substr($method, 0, 7) === 'include' && substr($method, -3) === 'Set') {
                $incl = $method;
                $classNameMethod = substr($method, strlen('include')) . 'ClassName';


                $classname = $this->$classNameMethod();

                if ($prefix === substr($classname, 0, strlen($prefix))
                  && 'Set' === substr($classname, -3)
                  && 'ViewSet' !== substr($classname, -7)) {
                    if (method_exists($this, $incl)) {
                        $this->$incl();

                        $call = substr($classname, strlen($prefix));

                        if (class_exists($classname)) {

                            /* @var $set ORM_RecordSet */
                            $set = $this->$call();
                            if (method_exists($set, 'useLang')) {
                                // This is necessary if the recordSet constructor uses a setLang().
                                // We need to revert to multilang fields before synchronizing.
                                $set->useLang(false);

false of type false is incompatible with the type string expected by parameter $language of ORM_RecordSet::useLang().

                            }
                            $sql .= $mysqlbackend->setToSql($set) . "\n";
                        }
                    }
                }
            }
        }

        require_once $GLOBALS['babInstallPath'].'utilit/devtools.php';
        $synchronize = new bab_synchronizeSql();

        $synchronize->fromSqlString($sql);

        return $synchronize;
    }



    public function getSynchronizeSql($prefix)
    {
        if (!$prefix) {
            return null;
        }

        require_once $GLOBALS['babInstallPath'].'utilit/devtools.php';
        $mysqlbackend = new ORM_MySqlBackend($GLOBALS['babDB']);
        $sql = '';

        foreach (get_class_methods($this) as $method) {

            if (substr($method, 0, strlen('include')) === 'include' && substr($method, -strlen('Set')) === 'Set') {
                $incl = $method;
                $classNameMethod = substr($method, strlen('include')) . 'ClassName';

                $classname = $this->$classNameMethod();

                if ($prefix === substr($classname, 0, strlen($prefix))
                    && 'Set' === substr($classname, -3)
                    && 'ViewSet' !== substr($classname, -6)
                    ) {
                        if (method_exists($this, $incl)) {
                            $this->$incl();
                            $call = substr($classname, strlen($prefix));

                            if (class_exists($classname) && method_exists($this, $call)) {
                                $set = $this->$call();
                                $sql .= $mysqlbackend->setToSql($set) . "\n";
                            }
                        }
                    }
            }
        }

        return $sql;
    }



    public function includeBase()
    {
        require_once APP_PHP_PATH . 'base.class.php';
    }

    /**
     * Includes app_RecordSet class definition.
     */
    public function includeRecordSet()
    {
        require_once APP_SET_PATH . 'record.class.php';
    }


    /**
     * Includes app_TraceableRecordSet class definition.
     */
    public function includeTraceableRecordSet()
    {
        require_once APP_SET_PATH . 'traceablerecord.class.php';
    }



    /**
     * SET DEFINITION
     */

    //Log

    /**
     * Includes LogSet class definition.
     */
    public function includeLogSet()
    {
        require_once APP_SET_PATH . 'log.class.php';
    }

    /**
     * @return string
     */
    public function LogClassName()
    {
        return 'app_Log';
    }

    /**
     * @return string
     */
    public function LogSetClassName()
    {
        return $this->LogClassName() . 'Set';
    }

    /**
     * @return app_LogSet
     */
    public function LogSet()
    {
        $this->includeLogSet();
        $className = $this->LogSetClassName();
        $set = new $className($this);
        return $set;
    }


    //Link

    /**
     * Includes LinkSet class definition.
     */
    public function includeLinkSet()
    {
        require_once APP_SET_PATH . 'link.class.php';
    }

    /**
     * @return string
     */
    public function LinkClassName()
    {
        return 'app_Link';
    }

    /**
     * @return string
     */
    public function LinkSetClassName()
    {
        return $this->LinkClassName() . 'Set';
    }

    /**
     * @return app_LinkSet
     */
    public function LinkSet()
    {
        $this->includeLinkSet();
        $className = $this->LinkSetClassName();
        $set = new $className($this);
        return $set;
    }







    /**
     * Returns the app_Record corresponding to the specified
     * reference $ref.
     *
     * @param string 	$ref	A reference string (e.g. Contact:12)
     * @return app_Record	or null if no corresponding record is found.
     */
    public function getRecordByRef($ref)
    {
        $refParts = explode(':', $ref);
        if (count($refParts) !== 2) {
            return null;
        }
        list($classname, $id) = $refParts;
        $classSet = $classname . 'Set';
        $set = $this->$classSet();
        if (isset($set)) {
            return $set->get($id);
        }
        return null;
    }

    /**
     * Returns the reference corresponding to the specified
     * app_Record $record (e.g. Contact:12 or Deal:125)
     *
     * @param app_Record	$record
     * @return string
     */
    public function getRecordRef(app_Record $record)
    {
        $fullClassName = get_class($record);
        list(, $className) = explode('_', $fullClassName);
        return $className . ':' . $record->id;

The property id does not exist on app_Record. Since you implemented __get, consider adding a @property annotation.

    }


    /**
     * Specifies the language to use for translation.
     *
     * If $language is null, the language is reset to
     * the current logged user language.
     *
     * @param string|null $language
     */
    public function setTranslateLanguage($language)
    {
        $this->language = $language;
    }



    /**
     * Translates the string.
     *
     * @param string $str
     * @return string
     */
    public function translate($str, $str_plurals = null, $number = null)
    {
        require_once APP_PHP_PATH . 'functions.php';
        $translation = $str;
        if ($translate = bab_functionality::get('Translate/Gettext')) {
            /* @var $translate Func_Translate_Gettext */
            $translate->setAddonName('libapp');
            $translation = $translate->translate($str, $str_plurals, $number);
        }

        return $translation;
    }

    /**
     * @param string    $str
     * @param string    $str_plurals
     * @param int       $number
     * @return string
     */
    public function translatable($str, $str_plurals = null, $number = null)
    {
        return $str;
    }

    /**
     * Translates all the string in an array and returns a new array.
     *
     * @param array $arr
     * @return array
     */
    public function translateArray($arr)
    {
        $newarr = $arr;

        foreach ($newarr as &$str) {
            $str = $this->translate($str);
        }
        return $newarr;
    }



    /**
     * Returns a link for writting an email to the specified email address.
     *
     * @param string $addr
     * @param string $subject
     * @param string $body
     *
     * @return string
     */
    public function mailTo($addr, $subject = null, $body = null)
    {
        $mailTo = 'mailto:' . $addr;
        $parameters = array();
        if (isset($subject)) {
            $parameters[] = 'subject=' . $subject;
        }
        if (isset($body)) {
            $parameters[] = 'body=' . $body;
        }
        if (!empty($parameters)) {
            $mailTo .= '?' . implode('&', $parameters);
        }

        return $mailTo;
    }



    /**
     * Format a number for display
     *
     * @param   float|string|null   $number     Numeric value with decimal
     * @return string
     */
    public function numberFormat($number, $decimals = 2)
    {
        if (is_null($number)) {
            return '#,##';
        }

        $number = number_format(floatval($number), $decimals, ',', ' ');
        return str_replace(' ', bab_nbsp(), $number);
    }


    /**
     * Format a number with an optional unit.
     *
     * If the value is >= 1000 the value is shortened and the corresponding prexif (k or M) is used.
     *
     * @param float|string|null $number
     * @param string $unitSymbol    (For example $, m2, Wh)
     * @param int $decimals
     * @return string|mixed
     */
    public function shortFormatWithUnit($number, $unitSymbol = '', $decimals = 2)
    {
        if (is_null($number)) {
            return '#,##';
        }

        $prefix = '';
        if ($number >= 1000000) {
            $number /= 1000000;
            $prefix = 'M';
        } elseif ($number >= 1000) {
            $number /= 1000;
            $prefix = 'k';
        }

        $number = number_format($number, $decimals, ',', ' ');

It seems like $number can also be of type string; however, parameter $number of number_format() does only seem to accept double, maybe add an additional type check?

        return str_replace(' ', bab_nbsp(), $number . ' ' . $prefix . $unitSymbol);
    }


    /**
     * Reformat a phone number in the specified format.
     *
     * @param string    $phone      The phone number to be formatted
     * @param int       $format     The format the phone number should be formatted into
     *
     * @return string               The formatted phone number
     */
    public function phoneNumberFormat($phone, $format = null)
    {
        $PhoneNumber = bab_Functionality::get('PhoneNumber');
        if ($PhoneNumber === false) {

The condition $PhoneNumber === false is always false.

            return $phone;
        }

        if (!isset($format)) {
            $format = bab_registry::get('/' . $this->addonName . '/numberFormat', $PhoneNumber->getDefaultFormat());

The method getDefaultFormat() does not exist on bab_functionality. It seems like you code against a sub-type of bab_functionality such as Func_App.

        }
        $phoneNumberUtil = $PhoneNumber->PhoneNumberUtil();

The method PhoneNumberUtil() does not exist on bab_functionality. It seems like you code against a sub-type of bab_functionality such as Func_App.

        try {
            $phoneNumber = $phoneNumberUtil->parse($phone, 'FR');
            $phone = $phoneNumberUtil->format($phoneNumber, $format);
        } catch (\libphonenumber\NumberParseException $e) {

Consider adding a comment why this CATCH block is empty.

The type libphonenumber\NumberParseException was not found. Maybe you did not declare it correctly or list all dependencies?

        }

        return $phone;
    }




    /**
     * Includes Controller class definition.
     */
    public function includeController()
    {
        require_once APP_PHP_PATH . '/controller.class.php';
    }


    /**
     * Includes RecordController class definition.
     */
    public function includeRecordController()
    {
        require_once APP_CTRL_PATH . '/record.ctrl.php';
    }


    /**
     * Instanciates the controller.
     *
     * @return app_Controller
     */
    public function Controller()
    {
        $this->includeController();
        return bab_getInstance($this->classPrefix.'Controller')->setApp($this);
    }


    /**
     * Instanciates a controller class.
     *
     * @return bab_Controller
     */
    public function ControllerProxy($className, $proxy = true)
    {
        $this->includeController();

        if ($proxy) {
            return app_Controller::getProxyInstance($this, $className);
        }

        return new $className($this);
    }



    /**
     * Include class app_Ui
     *
     */
    public function includeUi()
    {
        require_once APP_UI_PATH . 'ui.class.php';
    }


    /**
     * The app_Ui object propose an access to all ui files and ui objects (widgets)
     *
     * @return app_Ui
     */
    public function Ui()
    {
        $this->includeUi();
        return bab_getInstance($this->classPrefix . 'Ui');//->setApp($this);
    }



    protected function includeAccess()
    {
        require_once WORKSPACE_PHP_PATH . '/access.class.php';

The constant WORKSPACE_PHP_PATH was not found. Maybe you did not declare it correctly or list all dependencies?

    }





    /**
     * Get upload path
     * if the method return null, no upload functionality
     *
     * @return bab_Path
     */
    public function getUploadPath()
    {
        require_once $GLOBALS['babInstallPath'].'utilit/path.class.php';
        return new bab_Path(bab_getAddonInfosInstance($this->getAddonName())->getUploadPath());
    }


    /**
     *
     * @param string $name
     * @param mixed $arguments
     * @return mixed
     */
    public function __call($name, $arguments)
    {
        switch (true) {

            case substr($name, -strlen('SetClassName')) === 'SetClassName':
                $setName = substr($name, 0, strlen($name) - strlen('ClassName'));
                return $this->classPrefix . $setName;

            case substr($name, -strlen('ClassName')) === 'ClassName':
                $recordName = substr($name, 0, strlen($name) - strlen('ClassName'));
                return $this->classPrefix . $recordName;

            case substr($name, 0, strlen('include')) === 'include' && substr($name, -strlen('Set')) === 'Set':
                $fileNameBase = strtolower(substr(substr($name, 0, strlen($name) - strlen('Set')), strlen('include')));
                require_once PHP_SET_PATH . $fileNameBase . '.class.php';

The constant PHP_SET_PATH was not found. Maybe you did not declare it correctly or list all dependencies?

                return;

            case substr($name, -strlen('Set')) === 'Set':
                $includeMethod = 'include' . $name;
                $this->$includeMethod();
                $setClassNameMethod = $name . 'ClassName';
                $className = $this->$setClassNameMethod();
                $set = new $className($this);
                return $set;

                //case method_exists($this, $name . 'Set'):
            default:
                $setName = $name . 'Set';
                $recordClassNameMethod = $name . 'ClassName';
                $recordClassName = $this->$recordClassNameMethod();
                if (isset($arguments[0])) {
                    if ($arguments[0] instanceof $recordClassName) {
                        return $arguments[0];
                    }
                    $set = $this->$setName();
                    return $set->get($arguments[0]);
                }
                return null;
        }
    }


    /**
     * Test if this App implementation handles the specified object class.
     *
     * The default is to consider that an object Xxxx implemented if the includeXxxxSet() method is
     * declared public on this App.
     *
     * @param	string	$objectClassName		App object name (eg. 'Contact' or 'CatalogItem')
     * @return bool
     */
    public function __isset($objectClassName)
    {
        if (null === $this->implementedObjects) {

            $this->implementedObjects = array();

The property implementedObjects does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            $className = get_class($this);
            $rClass = new ReflectionClass($className);

            foreach ($rClass->getMethods(ReflectionMethod::IS_PUBLIC) as $m) {

                // We consider object Xxxx implemented if the includeXxxxSet() method is
                // declared public on this.

                if ($m->getDeclaringClass()->name !== $className) {
                    // The method is declared on an ancestor class.
                    continue;
                }

                if (substr($m->name, 0, 7) === 'include' && substr($m->name, -3) === 'Set') {
                    $this->implementedObjects[substr($m->name, 7, -3)] = 1;
                }
            }
        }

        return isset($this->implementedObjects[$objectClassName]);
    }
}

spl_autoload_register(array(app_App(), 'loadObject'));