| Total Complexity | 161 |
| Total Lines | 1089 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 2 | Features | 0 |
Complex classes like Func_App often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Func_App, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 56 | class Func_App extends \bab_Functionality |
||
| 57 | { |
||
| 58 | public $addonPrefix; |
||
| 59 | public $classPrefix; |
||
| 60 | public $addonName; |
||
| 61 | public $controllerTg; |
||
| 62 | public $phpPath; |
||
| 63 | public $recordSetPath; |
||
| 64 | public $ctrlPath; |
||
| 65 | public $uiPath; |
||
| 66 | |||
| 67 | private $components = array(); |
||
| 68 | private $currentComponent; |
||
| 69 | |||
| 70 | |||
| 71 | /** |
||
| 72 | * @var string |
||
| 73 | */ |
||
| 74 | private $language = null; |
||
| 75 | |||
| 76 | |||
| 77 | public function __construct() |
||
| 78 | { |
||
| 79 | $this->addonName = 'libapp'; |
||
| 80 | $this->addonPrefix = 'app'; |
||
| 81 | |||
| 82 | $this->classPrefix = 'App'; |
||
| 83 | $this->controllerTg = 'addon/' . $this->addonName . '/main'; |
||
| 84 | |||
| 85 | $addon = bab_getAddonInfosInstance($this->addonName); |
||
| 86 | $this->phpPath = $addon->getPhpPath(); |
||
| 87 | $this->recordSetPath = $this->phpPath; |
||
| 88 | $this->ctrlPath = $this->phpPath; |
||
| 89 | $this->uiPath = $this->phpPath . 'ui/'; |
||
| 90 | |||
| 91 | $babDB = bab_getDB(); |
||
| 92 | |||
| 93 | /** @var $LibOrm Func_LibOrm */ |
||
| 94 | $LibOrm = \bab_Functionality::get('LibOrm'); |
||
| 95 | |||
| 96 | $LibOrm->initMysql(); |
||
| 97 | ORMRecordSet::setBackend(new ORMMySqlBackend($babDB)); |
||
| 98 | } |
||
| 99 | |||
| 100 | public function addComponentsFromName($componentName) |
||
| 101 | { |
||
| 102 | $componentDefinitionObjectName = 'Capwelton\App\\'.$componentName.'\ComponentDefinition\ComponentDefinition'; |
||
| 103 | if (class_exists($componentDefinitionObjectName)) { |
||
| 104 | $componentDefinition = new $componentDefinitionObjectName; |
||
| 105 | $components = $componentDefinition->getComponents($this); |
||
| 106 | foreach ($components as $singleName => $singleComponent){ |
||
| 107 | $this->addComponent($singleName, $singleComponent); |
||
| 108 | } |
||
| 109 | } |
||
| 110 | |||
| 111 | return $this; |
||
| 112 | } |
||
| 113 | |||
| 114 | public function createComponent($set, $ctrl, $ui) |
||
| 115 | { |
||
| 116 | return new AppComponent($this, $set, $ctrl, $ui); |
||
| 117 | } |
||
| 118 | |||
| 119 | public function addComponent($componentName, AppComponent $component) |
||
| 120 | { |
||
| 121 | $this->components[$componentName] = $component; |
||
| 122 | return $this; |
||
| 123 | } |
||
| 124 | |||
| 125 | /** |
||
| 126 | * @param string $componentName |
||
| 127 | * @return AppComponent|NULL |
||
| 128 | */ |
||
| 129 | public function getComponentByName($componentName) |
||
| 130 | { |
||
| 131 | $componentName = explode('_', $componentName); |
||
| 132 | $nbElem = count($componentName); |
||
| 133 | $componentName = $componentName[$nbElem - 1]; |
||
| 134 | $componentName = strtoupper($componentName); |
||
| 135 | if(isset($this->components[$componentName])){ |
||
| 136 | return $this->components[$componentName]; |
||
| 137 | } |
||
| 138 | return null; |
||
| 139 | } |
||
| 140 | |||
| 141 | public function setCurrentComponent(AppComponent $component = null) |
||
| 142 | { |
||
| 143 | $this->currentComponent = $component; |
||
| 144 | return $this; |
||
| 145 | } |
||
| 146 | |||
| 147 | public function setCurrentComponentByName($componentName = null) |
||
| 148 | { |
||
| 149 | $component = $this->getComponentByName($componentName); |
||
| 150 | $this->currentComponent = $component; |
||
| 151 | return $this; |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * @return AppComponent|null |
||
| 156 | */ |
||
| 157 | public function getCurrentComponent() |
||
| 158 | { |
||
| 159 | return $this->currentComponent; |
||
| 160 | } |
||
| 161 | |||
| 162 | public function __get($componentName) |
||
| 163 | { |
||
| 164 | if(isset($this->components[$componentName])){ |
||
| 165 | return $this->components[$componentName]; |
||
| 166 | }else{ |
||
| 167 | return null; |
||
| 168 | } |
||
| 169 | } |
||
| 170 | |||
| 171 | /** |
||
| 172 | * @return AppComponent[] |
||
| 173 | */ |
||
| 174 | public function getComponents() |
||
| 175 | { |
||
| 176 | return $this->components; |
||
| 177 | } |
||
| 178 | |||
| 179 | public function checkComponentsDependencies() |
||
| 180 | { |
||
| 181 | $components = $this->getComponents(); |
||
| 182 | |||
| 183 | $messages = array(); |
||
| 184 | |||
| 185 | foreach ($components as $componentName => $component){ |
||
| 186 | $dependencies = $component->checkDependencies(); |
||
| 187 | foreach($dependencies['requiredComponents'] as $requiredComponent){ |
||
| 188 | $messages['requiredComponents'][$componentName][] = $requiredComponent; |
||
| 189 | } |
||
| 190 | foreach($dependencies['optionalComponents'] as $optionalComponent){ |
||
| 191 | $messages['optionalComponents'][$componentName][] = $optionalComponent; |
||
| 192 | } |
||
| 193 | } |
||
| 194 | |||
| 195 | return $messages; |
||
| 196 | } |
||
| 197 | |||
| 198 | public function getComponentDefinitions() |
||
| 199 | { |
||
| 200 | $components = $this->getComponents(); |
||
| 201 | $componentDefinitions = array(); |
||
| 202 | foreach ($components as $component){ |
||
| 203 | $packageName = $component->getPackageName(); |
||
| 204 | if(isset($componentDefinitions[$packageName]) && !empty($componentDefinitions[$packageName])){ |
||
| 205 | continue; |
||
| 206 | } |
||
| 207 | $componentDefinitions[$packageName] = $component->getDefinition(); |
||
| 208 | } |
||
| 209 | return $componentDefinitions; |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * @param string $class |
||
| 214 | * @return boolean |
||
| 215 | */ |
||
| 216 | public function loadObject($class) |
||
| 217 | { |
||
| 218 | $classPrefix = $this->classPrefix; |
||
| 219 | |||
| 220 | if (substr($class, 0, strlen($classPrefix)) === $classPrefix) { |
||
| 221 | if (substr($class, -3) === 'Set') { |
||
| 222 | $pathname = $this->getRecordSetPathname($class); |
||
| 223 | if (file_exists($pathname)) { |
||
| 224 | require $pathname; |
||
| 225 | return true; |
||
| 226 | } |
||
| 227 | } else { |
||
| 228 | $pathname = $this->getRecordPathname($class); |
||
| 229 | if (file_exists($pathname)) { |
||
| 230 | require $pathname; |
||
| 231 | return true; |
||
| 232 | } |
||
| 233 | } |
||
| 234 | } |
||
| 235 | return false; |
||
| 236 | } |
||
| 237 | |||
| 238 | /** |
||
| 239 | * Returns the expected pathname for the file containing the definition of the record set class. |
||
| 240 | * |
||
| 241 | * @param string $class |
||
| 242 | * @return string |
||
| 243 | */ |
||
| 244 | public function getRecordSetPathname($class) |
||
| 249 | } |
||
| 250 | |||
| 251 | /** |
||
| 252 | * Returns the expected pathname for the file containing the definition of the record class. |
||
| 253 | * |
||
| 254 | * @param string $class |
||
| 255 | * @return string |
||
| 256 | */ |
||
| 257 | public function getRecordPathname($class) |
||
| 258 | { |
||
| 259 | // $App->MyRecord() -> myrecord.class.php |
||
| 260 | $file = strtolower(substr($class, strlen($this->classPrefix))) . '.class.php'; |
||
| 261 | return $this->recordSetPath . $file; |
||
| 262 | } |
||
| 263 | |||
| 264 | /** |
||
| 265 | * @return string |
||
| 266 | */ |
||
| 267 | public function getUiPath() |
||
| 268 | { |
||
| 269 | return APP_UI_PATH; |
||
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * @return string |
||
| 274 | */ |
||
| 275 | public function getSetPath() |
||
| 276 | { |
||
| 277 | return APP_SET_PATH; |
||
| 278 | } |
||
| 279 | |||
| 280 | /** |
||
| 281 | * @return string |
||
| 282 | */ |
||
| 283 | public function getCtrlPath() |
||
| 284 | { |
||
| 285 | return APP_CTRL_PATH; |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * @return string |
||
| 290 | */ |
||
| 291 | public function getPhpPath() |
||
| 292 | { |
||
| 293 | return APP_PHP_PATH; |
||
| 294 | } |
||
| 295 | |||
| 296 | |||
| 297 | /** |
||
| 298 | * @return string |
||
| 299 | * |
||
| 300 | */ |
||
| 301 | public function getDescription() |
||
| 302 | { |
||
| 303 | return 'Application framework.'; |
||
| 304 | } |
||
| 305 | |||
| 306 | |||
| 307 | /** |
||
| 308 | * Get the addon name |
||
| 309 | * @return string |
||
| 310 | */ |
||
| 311 | public function getAddonName() |
||
| 312 | { |
||
| 313 | return $this->addonName; |
||
| 314 | } |
||
| 315 | |||
| 316 | |||
| 317 | /** |
||
| 318 | * @return \bab_addonInfos |
||
| 319 | */ |
||
| 320 | public function getAddon() |
||
| 321 | { |
||
| 322 | return bab_getAddonInfosInstance($this->getAddonName()); |
||
| 323 | } |
||
| 324 | |||
| 325 | |||
| 326 | /** |
||
| 327 | * Register myself as a functionality. |
||
| 328 | * |
||
| 329 | */ |
||
| 330 | public static function register() |
||
| 331 | { |
||
| 332 | $addon = bab_getAddonInfosInstance('libapp'); |
||
| 333 | |||
| 334 | $addon->registerFunctionality('App', 'app.php'); |
||
| 335 | } |
||
| 336 | |||
| 337 | |||
| 338 | /** |
||
| 339 | * Synchronize sql tables for all classes found in Application object |
||
| 340 | * using methods 'includeXxxxxClassName' |
||
| 341 | * sychronize if the two correspond methods are met and the set classname match the prefix from parameter |
||
| 342 | * do not synchronize if the set method has a VueSet suffix, in this case the table si juste a readonly vue |
||
| 343 | * |
||
| 344 | * @param string $prefix tables and classes prefix |
||
| 345 | * @return \bab_synchronizeSql |
||
| 346 | */ |
||
| 347 | public function synchronizeSql($prefix) |
||
| 348 | { |
||
| 349 | if (!$prefix) { |
||
| 350 | return null; |
||
| 351 | } |
||
| 352 | |||
| 353 | require_once $GLOBALS['babInstallPath'].'utilit/devtools.php'; |
||
| 354 | $mysqlbackend = new ORMMySqlBackend($GLOBALS['babDB']); |
||
| 355 | $sql = 'SET FOREIGN_KEY_CHECKS=0; |
||
| 356 | '; |
||
| 357 | |||
| 358 | foreach (get_class_methods($this) as $method) { |
||
| 359 | |||
| 360 | if (substr($method, 0, 7) === 'include' && substr($method, -3) === 'Set') { |
||
| 361 | $incl = $method; |
||
| 362 | $classNameMethod = substr($method, strlen('include')) . 'ClassName'; |
||
| 363 | |||
| 364 | |||
| 365 | $classname = $this->$classNameMethod(); |
||
| 366 | |||
| 367 | if ($prefix === substr($classname, 0, strlen($prefix)) |
||
| 368 | && 'Set' === substr($classname, -3) |
||
| 369 | && 'ViewSet' !== substr($classname, -7)) { |
||
| 370 | if (method_exists($this, $incl)) { |
||
| 371 | $this->$incl(); |
||
| 372 | |||
| 373 | $call = substr($classname, strlen($prefix)); |
||
| 374 | |||
| 375 | if (class_exists($classname)) { |
||
| 376 | |||
| 377 | /* @var $set ORMRecordSet */ |
||
| 378 | $set = $this->$call(); |
||
| 379 | if (method_exists($set, 'useLang')) { |
||
| 380 | // This is necessary if the recordSet constructor uses a setLang(). |
||
| 381 | // We need to revert to multilang fields before synchronizing. |
||
| 382 | $set->useLang(false); |
||
| 383 | } |
||
| 384 | $sql .= $mysqlbackend->setToSql($set) . "\n"; |
||
| 385 | } |
||
| 386 | } |
||
| 387 | } |
||
| 388 | } |
||
| 389 | } |
||
| 390 | |||
| 391 | require_once $GLOBALS['babInstallPath'].'utilit/devtools.php'; |
||
| 392 | $synchronize = new \bab_synchronizeSql(); |
||
| 393 | |||
| 394 | $synchronize->fromSqlString($sql); |
||
| 395 | |||
| 396 | return $synchronize; |
||
| 397 | } |
||
| 398 | |||
| 399 | public function synchronizeComponentsSql($prefix) |
||
| 400 | { |
||
| 401 | if (!$prefix) { |
||
| 402 | return null; |
||
| 403 | } |
||
| 404 | |||
| 405 | require_once $GLOBALS['babInstallPath'].'utilit/devtools.php'; |
||
| 406 | $mysqlbackend = new ORMMySqlBackend($GLOBALS['babDB']); |
||
| 407 | $sql = 'SET FOREIGN_KEY_CHECKS=0; |
||
| 408 | '; |
||
| 409 | |||
| 410 | $noPackageNames = array(); |
||
| 411 | foreach ($this->components as $component){ |
||
| 412 | /* @var $component AppComponent */ |
||
| 413 | try{ |
||
| 414 | /* @var $set ORMRecordSet */ |
||
| 415 | $set = $component->recordSet(); |
||
| 416 | //Check if the component is not overriden by the addon |
||
| 417 | //This is to prevent the destruction of non-generic fields on addon update, that will next be re-created by the overriden set |
||
| 418 | //In case the set has been overriden, we simply do nothing here, as it will be instanciated by the synchronizeSql method |
||
| 419 | $cmprc = new \ReflectionClass($set); |
||
| 420 | $componentSetClass = $cmprc->getShortName(); |
||
| 421 | if(method_exists($this, $componentSetClass)){ |
||
| 422 | continue; |
||
| 423 | } |
||
| 424 | if(method_exists($set, 'useLang')){ |
||
| 425 | // This is necessary if the recordSet constructor uses a setLang(). |
||
| 426 | // We need to revert to multilang fields before synchronizing. |
||
| 427 | $set->useLang(false); |
||
| 428 | } |
||
| 429 | $sql .= $mysqlbackend->setToSql($set) . "\n"; |
||
| 430 | |||
| 431 | if(empty($component->getPackageName())){ |
||
| 432 | $noPackageNames[] = $component->getName(); |
||
| 433 | } |
||
| 434 | } |
||
| 435 | catch (\Exception $e){ |
||
| 436 | |||
| 437 | } |
||
| 438 | } |
||
| 439 | |||
| 440 | if(!empty($noPackageNames)){ |
||
| 441 | $errorMessage = implode(', ', $noPackageNames); |
||
| 442 | \bab_installWindow::message( |
||
| 443 | sprintf( |
||
| 444 | $this->translate( |
||
| 445 | 'The following component does not have a package name : %s. The method setPackageName must be called on the component creation', |
||
| 446 | 'The following components do not have a package name : %s. The method setPackageName must be called on the components creation', |
||
| 447 | count($noPackageNames) |
||
| 448 | ), |
||
| 449 | $errorMessage |
||
| 450 | ) |
||
| 451 | ); |
||
| 452 | \bab_installWindow::message( |
||
| 453 | $this->translate('Terminating script with errors') |
||
| 454 | ); |
||
| 455 | throw new AppException($this->translate('Components package name error')); |
||
| 456 | } |
||
| 457 | |||
| 458 | require_once $GLOBALS['babInstallPath'].'utilit/devtools.php'; |
||
| 459 | $synchronize = new \bab_synchronizeSql(); |
||
| 460 | |||
| 461 | $synchronize->fromSqlString($sql); |
||
| 462 | |||
| 463 | $dependencies = $this->checkComponentsDependencies(); |
||
| 464 | foreach ($dependencies['requiredComponents'] as $componentName => $requiredComponents){ |
||
| 465 | foreach ($requiredComponents as $requiredComponent){ |
||
| 466 | $hasComponent = $this->getComponentByName($requiredComponent); |
||
| 467 | if(!$hasComponent){ |
||
| 468 | \bab_installWindow::message(sprintf($this->translate('The component %s is required for the component %s to work. You will encounter fatal errors'), $requiredComponent, $componentName)); |
||
| 469 | } |
||
| 470 | } |
||
| 471 | } |
||
| 472 | foreach ($dependencies['optionalComponents'] as $componentName => $optionalComponents){ |
||
| 473 | foreach ($optionalComponents as $optionalComponent){ |
||
| 474 | $hasComponent = $this->getComponentByName($optionalComponent); |
||
| 475 | if(!$hasComponent){ |
||
| 476 | \bab_installWindow::message(sprintf($this->translate('The optional component %s has not been added. The component %s may have reduced functionalities'), $optionalComponent, $componentName)); |
||
| 477 | } |
||
| 478 | } |
||
| 479 | } |
||
| 480 | |||
| 481 | return $synchronize; |
||
| 482 | } |
||
| 483 | |||
| 484 | public function componentsOnUpdate() |
||
| 485 | { |
||
| 486 | $components = $this->getComponents(); |
||
| 487 | |||
| 488 | foreach ($components as $component){ |
||
| 489 | $component->onUpdate(); |
||
| 490 | } |
||
| 491 | |||
| 492 | return $this; |
||
| 493 | } |
||
| 494 | |||
| 495 | public function getSynchronizeSql($prefix) |
||
| 496 | { |
||
| 497 | if (!$prefix) { |
||
| 498 | return null; |
||
| 499 | } |
||
| 500 | |||
| 501 | require_once $GLOBALS['babInstallPath'].'utilit/devtools.php'; |
||
| 502 | $mysqlbackend = new ORMMySqlBackend($GLOBALS['babDB']); |
||
| 503 | $sql = ''; |
||
| 504 | |||
| 505 | foreach (get_class_methods($this) as $method) { |
||
| 506 | |||
| 507 | if (substr($method, 0, strlen('include')) === 'include' && substr($method, -strlen('Set')) === 'Set') { |
||
| 508 | $incl = $method; |
||
| 509 | $classNameMethod = substr($method, strlen('include')) . 'ClassName'; |
||
| 510 | |||
| 511 | $classname = $this->$classNameMethod(); |
||
| 512 | |||
| 513 | if ($prefix === substr($classname, 0, strlen($prefix)) |
||
| 514 | && 'Set' === substr($classname, -3) |
||
| 515 | && 'ViewSet' !== substr($classname, -6) |
||
| 516 | ) { |
||
| 517 | if (method_exists($this, $incl)) { |
||
| 518 | $this->$incl(); |
||
| 519 | $call = substr($classname, strlen($prefix)); |
||
| 520 | |||
| 521 | if (class_exists($classname) && method_exists($this, $call)) { |
||
| 522 | $set = $this->$call(); |
||
| 523 | $sql .= $mysqlbackend->setToSql($set) . "\n"; |
||
| 524 | } |
||
| 525 | } |
||
| 526 | } |
||
| 527 | } |
||
| 528 | } |
||
| 529 | |||
| 530 | return $sql; |
||
| 531 | } |
||
| 532 | |||
| 533 | |||
| 534 | |||
| 535 | public function includeBase() |
||
| 536 | { |
||
| 537 | require_once APP_PHP_PATH . 'base.class.php'; |
||
| 538 | } |
||
| 539 | |||
| 540 | /** |
||
| 541 | * Includes app_RecordSet class definition. |
||
| 542 | */ |
||
| 543 | public function includeRecordSet() |
||
| 544 | { |
||
| 545 | // require_once APP_SET_PATH . 'record.class.php'; |
||
| 546 | } |
||
| 547 | |||
| 548 | |||
| 549 | /** |
||
| 550 | * Includes app_TraceableRecordSet class definition. |
||
| 551 | */ |
||
| 552 | public function includeTraceableRecordSet() |
||
| 553 | { |
||
| 554 | // require_once APP_SET_PATH . 'traceablerecord.class.php'; |
||
| 555 | } |
||
| 556 | |||
| 557 | |||
| 558 | /** |
||
| 559 | * |
||
| 560 | * @return AppAccessManager |
||
| 561 | */ |
||
| 562 | public function AccessManager() |
||
| 563 | { |
||
| 564 | static $accessManager = null; |
||
| 565 | if (!isset($accessManager)) { |
||
| 566 | $accessManager = new AppAccessManager($this); |
||
| 567 | } |
||
| 568 | |||
| 569 | return $accessManager; |
||
| 570 | } |
||
| 571 | |||
| 572 | |||
| 573 | |||
| 574 | /** |
||
| 575 | * |
||
| 576 | * @param string $recordClassname |
||
| 577 | * |
||
| 578 | * @return ORMRecordSet |
||
| 579 | */ |
||
| 580 | public function getRecordSetByRef($recordClassname) |
||
| 586 | } |
||
| 587 | |||
| 588 | /** |
||
| 589 | * Returns the app_Record corresponding to the specified |
||
| 590 | * reference $ref. |
||
| 591 | * |
||
| 592 | * @param string $ref A reference string (e.g. Contact:12) |
||
| 593 | * @return AppRecord or null if no corresponding record is found. |
||
| 594 | */ |
||
| 595 | public function getRecordByRef($ref, $noDefaultCriteria = false) |
||
| 596 | { |
||
| 597 | $refParts = explode(':', $ref); |
||
| 598 | if (count($refParts) !== 2) { |
||
| 599 | return null; |
||
| 600 | } |
||
| 601 | list($recordClassname, $id) = $refParts; |
||
| 602 | $set = $this->getRecordSetByRef($recordClassname); |
||
| 603 | if (isset($set)) { |
||
| 604 | if($noDefaultCriteria){ |
||
| 605 | $set->setDefaultCriteria(null); |
||
| 606 | } |
||
| 607 | return $set->get($id); |
||
| 608 | } |
||
| 609 | return null; |
||
| 610 | } |
||
| 611 | |||
| 612 | /** |
||
| 613 | * Returns the reference corresponding to the specified |
||
| 614 | * app_Record $record (e.g. Contact:12 or Deal:125) |
||
| 615 | * |
||
| 616 | * @param AppRecord $record |
||
| 617 | * @return string |
||
| 618 | */ |
||
| 619 | public function getRecordRef(AppRecord $record) |
||
| 620 | { |
||
| 621 | $fullClassName = get_class($record); |
||
| 622 | list(, $className) = explode('_', $fullClassName); |
||
| 623 | return $className . ':' . $record->id; |
||
| 624 | } |
||
| 625 | |||
| 626 | |||
| 627 | /** |
||
| 628 | * |
||
| 629 | * @return \Func_Translate_Gettext |
||
| 630 | */ |
||
| 631 | private static function getTranslator() |
||
| 632 | { |
||
| 633 | /** @var $translator \Func_Translate_Gettext */ |
||
| 634 | static $translator = null; |
||
| 635 | if (!isset($translator)) { |
||
| 636 | |||
| 637 | $translator = \bab_functionality::get('Translate/Gettext', false); |
||
| 638 | $translator->setAddonName('libapp'); |
||
| 639 | } |
||
| 640 | |||
| 641 | return $translator; |
||
| 642 | } |
||
| 643 | |||
| 644 | |||
| 645 | /** |
||
| 646 | * Specifies the language to use for translation. |
||
| 647 | * |
||
| 648 | * If $language is null, the language is reset to |
||
| 649 | * the current logged user language. |
||
| 650 | * |
||
| 651 | * @param string|null $language |
||
| 652 | */ |
||
| 653 | public function setTranslateLanguage($language) |
||
| 654 | { |
||
| 655 | $this->language = $language; |
||
| 656 | } |
||
| 657 | |||
| 658 | |||
| 659 | |||
| 660 | /** |
||
| 661 | * Translates the string. |
||
| 662 | * |
||
| 663 | * @param string $str Text to translate or singular form |
||
| 664 | * @param string $str_plurals Plurals form string |
||
| 665 | * @param int $number Number of items for plurals |
||
| 666 | * @return string |
||
| 667 | */ |
||
| 668 | public function translate($str, $str_plurals = null, $number = null) |
||
| 669 | { |
||
| 670 | //First, check if current addon has a translation |
||
| 671 | $translator = self::getTranslator(); |
||
| 672 | $translator->setAddonName($this->addonName); |
||
| 673 | $translator->setLangPath(null); |
||
| 674 | $translation = $translator->translate($str, $str_plurals, $number); |
||
| 675 | |||
| 676 | //Then, check if current component has a translation |
||
| 677 | if ($translation === $str) { |
||
| 678 | if($currentComponent = $this->getCurrentComponent()){ |
||
| 679 | $translator->setAddonName($currentComponent->getPackageName()); |
||
| 680 | $translator->setLangPath($currentComponent->getLangPath()); |
||
| 681 | $translation = $translator->translate($str, $str_plurals, $number); |
||
| 682 | |||
| 683 | } |
||
| 684 | } |
||
| 685 | //Then, check if libapp has a translation |
||
| 686 | if ($translation === $str) { |
||
| 687 | $translator->setLangPath(null);//Reset lang path |
||
| 688 | $translator->setAddonName('libapp'); |
||
| 689 | $translation = $translator->translate($str, $str_plurals, $number); |
||
| 690 | } |
||
| 691 | |||
| 692 | return $translation; |
||
| 693 | } |
||
| 694 | |||
| 695 | /** |
||
| 696 | * @param string $str |
||
| 697 | * @param string $str_plurals |
||
| 698 | * @param int $number |
||
| 699 | * @return string |
||
| 700 | */ |
||
| 701 | public function translatable($str, $str_plurals = null, $number = null) |
||
| 702 | { |
||
| 703 | return $str; |
||
| 704 | } |
||
| 705 | |||
| 706 | /** |
||
| 707 | * Translates all the string in an array and returns a new array. |
||
| 708 | * |
||
| 709 | * @param array $arr |
||
| 710 | * @return array |
||
| 711 | */ |
||
| 712 | public function translateArray($arr) |
||
| 713 | { |
||
| 714 | $newarr = $arr; |
||
| 715 | |||
| 716 | foreach ($newarr as &$str) { |
||
| 717 | $str = $this->translate($str); |
||
| 718 | } |
||
| 719 | return $newarr; |
||
| 720 | } |
||
| 721 | |||
| 722 | |||
| 723 | |||
| 724 | /** |
||
| 725 | * Returns a link for writting an email to the specified email address. |
||
| 726 | * |
||
| 727 | * @param string $addr |
||
| 728 | * @param string $subject |
||
| 729 | * @param string $body |
||
| 730 | * |
||
| 731 | * @return string |
||
| 732 | */ |
||
| 733 | public function mailTo($addr, $subject = null, $body = null) |
||
| 734 | { |
||
| 735 | $mailTo = 'mailto:' . $addr; |
||
| 736 | $parameters = array(); |
||
| 737 | if (isset($subject)) { |
||
| 738 | $parameters[] = 'subject=' . $subject; |
||
| 739 | } |
||
| 740 | if (isset($body)) { |
||
| 741 | $parameters[] = 'body=' . $body; |
||
| 742 | } |
||
| 743 | if (!empty($parameters)) { |
||
| 744 | $mailTo .= '?' . implode('&', $parameters); |
||
| 745 | } |
||
| 746 | |||
| 747 | return $mailTo; |
||
| 748 | } |
||
| 749 | |||
| 750 | |||
| 751 | |||
| 752 | /** |
||
| 753 | * Format a number for display |
||
| 754 | * |
||
| 755 | * @param float|string|null $number Numeric value with decimal |
||
| 756 | * @return string |
||
| 757 | */ |
||
| 758 | public function numberFormat($number, $decimals = 2) |
||
| 759 | { |
||
| 760 | if (is_null($number)) { |
||
| 761 | return '#,##'; |
||
| 762 | } |
||
| 763 | |||
| 764 | $number = number_format(floatval($number), $decimals, ',', ' '); |
||
| 765 | return str_replace(' ', bab_nbsp(), $number); |
||
| 766 | } |
||
| 767 | |||
| 768 | |||
| 769 | /** |
||
| 770 | * Format a number with an optional unit. |
||
| 771 | * |
||
| 772 | * If the value is >= 1000 the value is shortened and the corresponding prexif (k or M) is used. |
||
| 773 | * |
||
| 774 | * @param float|string|null $number |
||
| 775 | * @param string $unitSymbol (For example $, m2, Wh) |
||
| 776 | * @param int $decimals |
||
| 777 | * @return string|mixed |
||
| 778 | */ |
||
| 779 | public function shortFormatWithUnit($number, $unitSymbol = '', $decimals = 2) |
||
| 780 | { |
||
| 781 | if (is_null($number)) { |
||
| 782 | return '#,##'; |
||
| 783 | } |
||
| 784 | |||
| 785 | $prefix = ''; |
||
| 786 | if ($number >= 1000000) { |
||
| 787 | $number /= 1000000; |
||
| 788 | $prefix = 'M'; |
||
| 789 | } elseif ($number >= 1000) { |
||
| 790 | $number /= 1000; |
||
| 791 | $prefix = 'k'; |
||
| 792 | } |
||
| 793 | |||
| 794 | $number = number_format($number, $decimals, ',', ' '); |
||
| 795 | return str_replace(' ', bab_nbsp(), $number . ' ' . $prefix . $unitSymbol); |
||
| 796 | } |
||
| 797 | |||
| 798 | |||
| 799 | /** |
||
| 800 | * Reformat a phone number in the specified format. |
||
| 801 | * |
||
| 802 | * @param string $phone The phone number to be formatted |
||
| 803 | * @param int $format The format the phone number should be formatted into |
||
| 804 | * |
||
| 805 | * @return string The formatted phone number |
||
| 806 | */ |
||
| 807 | public function phoneNumberFormat($phone, $format = null) |
||
| 808 | { |
||
| 809 | $PhoneNumber = \bab_Functionality::get('PhoneNumber'); |
||
| 810 | if ($PhoneNumber === false) { |
||
| 811 | return $phone; |
||
| 812 | } |
||
| 813 | |||
| 814 | if (!isset($format)) { |
||
| 815 | $format = \bab_registry::get('/' . $this->addonName . '/numberFormat', $PhoneNumber->getDefaultFormat()); |
||
| 816 | } |
||
| 817 | $phoneNumberUtil = $PhoneNumber->PhoneNumberUtil(); |
||
| 818 | |||
| 819 | try { |
||
| 820 | $phoneNumber = $phoneNumberUtil->parse($phone, 'FR'); |
||
| 821 | $phone = $phoneNumberUtil->format($phoneNumber, $format); |
||
| 822 | } catch (\libphonenumber\NumberParseException $e) { |
||
| 823 | } |
||
| 824 | |||
| 825 | return $phone; |
||
| 826 | } |
||
| 827 | |||
| 828 | |||
| 829 | |||
| 830 | |||
| 831 | /** |
||
| 832 | * Includes Controller class definition. |
||
| 833 | */ |
||
| 834 | public function includeController() |
||
| 835 | { |
||
| 836 | } |
||
| 837 | |||
| 838 | |||
| 839 | /** |
||
| 840 | * Includes RecordController class definition. |
||
| 841 | */ |
||
| 842 | public function includeRecordController() |
||
| 844 | } |
||
| 845 | |||
| 846 | |||
| 847 | /** |
||
| 848 | * Instanciates the controller. |
||
| 849 | * |
||
| 850 | * @return AppController |
||
| 851 | */ |
||
| 852 | public function Controller() |
||
| 853 | { |
||
| 854 | $rc = new \ReflectionClass($this); |
||
| 855 | $namespace = $rc->getNamespaceName(); |
||
| 856 | $prefix = ''; |
||
| 857 | if(!empty($namespace)){ |
||
| 858 | $namespaces = explode('\\', $namespace); |
||
| 859 | $prefix = $namespaces[0].'\\'.$namespaces[1].'\Ctrl\\'; |
||
| 860 | } |
||
| 861 | $this->includeController(); |
||
| 862 | return bab_getInstance($prefix.$this->classPrefix . 'Controller')->setApp($this); |
||
| 863 | } |
||
| 864 | |||
| 865 | |||
| 866 | /** |
||
| 867 | * Instanciates a controller class. |
||
| 868 | * |
||
| 869 | * @return \bab_Controller |
||
| 870 | */ |
||
| 871 | public function ControllerProxy($className, $proxy = true) |
||
| 872 | { |
||
| 873 | $this->includeController(); |
||
| 874 | if ($proxy) { |
||
| 875 | return AppController::getProxyInstance($this, $className); |
||
| 876 | } |
||
| 877 | |||
| 878 | return new $className($this); |
||
| 879 | } |
||
| 880 | |||
| 881 | |||
| 882 | |||
| 883 | /** |
||
| 884 | * Include class app_Ui |
||
| 885 | * |
||
| 886 | */ |
||
| 887 | public function includeUi() |
||
| 888 | { |
||
| 889 | // require_once APP_UI_PATH . 'ui.class.php |
||
| 890 | } |
||
| 891 | |||
| 892 | |||
| 893 | /** |
||
| 894 | * The app_Ui object propose an access to all ui files and ui objects (widgets) |
||
| 895 | * |
||
| 896 | * @return AppUi |
||
| 897 | */ |
||
| 898 | public function Ui() |
||
| 899 | { |
||
| 900 | $rc = new \ReflectionClass($this); |
||
| 901 | $namespace = $rc->getNamespaceName(); |
||
| 902 | $prefix = ''; |
||
| 903 | if(!empty($namespace)){ |
||
| 904 | $namespaces = explode('\\', $namespace); |
||
| 905 | $prefix = $namespaces[0].'\\'.$namespaces[1].'\Ui\\'; |
||
| 906 | } |
||
| 907 | $this->includeUi(); |
||
| 908 | return bab_getInstance($prefix.$this->classPrefix . 'Ui')->setApp($this); |
||
| 909 | } |
||
| 910 | |||
| 911 | /** |
||
| 912 | * Get upload path |
||
| 913 | * if the method return null, no upload functionality |
||
| 914 | * |
||
| 915 | * @return \bab_Path |
||
| 916 | */ |
||
| 917 | public function getUploadPath() |
||
| 918 | { |
||
| 919 | require_once $GLOBALS['babInstallPath'].'utilit/path.class.php'; |
||
| 920 | return new \bab_Path(bab_getAddonInfosInstance($this->getAddonName())->getUploadPath()); |
||
| 921 | } |
||
| 922 | |||
| 923 | |||
| 924 | /** |
||
| 925 | * |
||
| 926 | * @param string $name |
||
| 927 | * @param mixed $arguments |
||
| 928 | * @return mixed |
||
| 929 | */ |
||
| 930 | public function __call($name, $arguments) |
||
| 931 | { |
||
| 932 | switch (true) { |
||
| 933 | |||
| 934 | case substr($name, -strlen('SetClassName')) === 'SetClassName': |
||
| 935 | $className = substr($name, 0, strlen($name) - strlen('SetClassName')); |
||
| 936 | if($component = $this->getComponentByName($className)){ |
||
| 937 | return $component->getSetClassName(); |
||
| 938 | } |
||
| 939 | $setName = $className.'Set'; |
||
| 940 | return $this->classPrefix . $setName; |
||
| 941 | |||
| 942 | case substr($name, -strlen('ClassName')) === 'ClassName': |
||
| 943 | $recordName = substr($name, 0, strlen($name) - strlen('ClassName')); |
||
| 944 | if($component = $this->getComponentByName($recordName)){ |
||
| 945 | return $component->getRecordClassName(); |
||
| 946 | } |
||
| 947 | return $this->classPrefix . $recordName; |
||
| 948 | |||
| 949 | case substr($name, 0, strlen('include')) === 'include' && substr($name, -strlen('Set')) === 'Set': |
||
| 950 | $fileNameBase = strtolower(substr(substr($name, 0, strlen($name) - strlen('Set')), strlen('include'))); |
||
| 951 | if($this->getComponentByName($fileNameBase)){ |
||
| 952 | return; |
||
| 953 | } |
||
| 954 | $path = APP_SET_PATH . $fileNameBase . '.class.php'; |
||
| 955 | if(is_file($path)){ |
||
| 956 | require_once $path; |
||
| 957 | } |
||
| 958 | return; |
||
| 959 | |||
| 960 | case substr($name, -strlen('Set')) === 'Set': |
||
| 961 | if($component = $this->getComponentByName(substr($name, 0, strlen($name) -strlen('Set')))){ |
||
| 962 | return $component->recordSet(); |
||
| 963 | } |
||
| 964 | |||
| 965 | $includeMethod = 'include' . $name; |
||
| 966 | $this->$includeMethod(); |
||
| 967 | $setClassNameMethod = $name . 'ClassName'; |
||
| 968 | $className = $this->$setClassNameMethod(); |
||
| 969 | $set = new $className($this); |
||
| 970 | return $set; |
||
| 971 | |||
| 972 | case ($component = $this->getComponentByName($name)) != false: |
||
| 973 | return $component; |
||
| 974 | default: |
||
| 975 | $setName = $name . 'Set'; |
||
| 976 | $recordClassNameMethod = $name . 'ClassName'; |
||
| 977 | $recordClassName = $this->$recordClassNameMethod(); |
||
| 978 | if (isset($arguments[0])) { |
||
| 979 | if ($arguments[0] instanceof $recordClassName) { |
||
| 980 | return $arguments[0]; |
||
| 981 | } |
||
| 982 | $set = $this->$setName(); |
||
| 983 | return $set->get($arguments[0]); |
||
| 984 | } |
||
| 985 | return null; |
||
| 986 | } |
||
| 987 | } |
||
| 988 | |||
| 989 | |||
| 990 | public function LinkSet(){ |
||
| 991 | return $this->AppLinkSet(); |
||
| 992 | } |
||
| 993 | public function AppLinkSet(){ |
||
| 994 | return new AppLinkSet($this); |
||
| 995 | } |
||
| 996 | |||
| 997 | public function CustomFieldSet(){ |
||
| 998 | return $this->AppCustomFieldSet(); |
||
| 999 | } |
||
| 1000 | public function AppCustomFieldSet(){ |
||
| 1001 | return new AppCustomFieldSet($this); |
||
| 1002 | } |
||
| 1003 | |||
| 1004 | public function CustomContainerSet(){ |
||
| 1005 | return $this->AppCustomContainerSet(); |
||
| 1006 | } |
||
| 1007 | public function AppCustomContainerSet(){ |
||
| 1008 | return new AppCustomContainerSet($this); |
||
| 1009 | } |
||
| 1010 | |||
| 1011 | public function CustomSectionSet(){ |
||
| 1012 | return $this->AppCustomSectionSet(); |
||
| 1013 | } |
||
| 1014 | public function AppCustomSectionSet(){ |
||
| 1015 | return new AppCustomSectionSet($this); |
||
| 1016 | } |
||
| 1017 | |||
| 1018 | public function LogSet(){ |
||
| 1019 | return $this->AppLogSet(); |
||
| 1020 | } |
||
| 1021 | public function AppLogSet(){ |
||
| 1022 | return new AppLogSet($this); |
||
| 1023 | } |
||
| 1024 | |||
| 1025 | public function SSESet() |
||
| 1026 | { |
||
| 1027 | return $this->AppSSESet(); |
||
| 1028 | } |
||
| 1029 | public function AppSSESet() |
||
| 1030 | { |
||
| 1031 | return new AppSSESet($this); |
||
| 1032 | } |
||
| 1033 | public function NotificationSet() |
||
| 1034 | { |
||
| 1035 | return $this->AppNotificationSet(); |
||
| 1036 | } |
||
| 1037 | public function AppNotificationSet() |
||
| 1038 | { |
||
| 1039 | return new AppNotificationSet($this); |
||
| 1040 | } |
||
| 1041 | |||
| 1042 | |||
| 1043 | |||
| 1044 | /** |
||
| 1045 | * Test if this App implementation handles the specified object class. |
||
| 1046 | * |
||
| 1047 | * The default is to consider that an object Xxxx implemented if the includeXxxxSet() method is |
||
| 1048 | * declared public on this App. |
||
| 1049 | * |
||
| 1050 | * @param string $objectClassName App object name (eg. 'Contact' or 'CatalogItem') |
||
| 1051 | * @return bool |
||
| 1052 | */ |
||
| 1053 | public function __isset($objectClassName) |
||
| 1054 | { |
||
| 1055 | if (null === $this->implementedObjects) { |
||
| 1056 | |||
| 1057 | $this->implementedObjects = array(); |
||
| 1058 | |||
| 1059 | $className = get_class($this); |
||
| 1060 | $rClass = new \ReflectionClass($className); |
||
| 1061 | |||
| 1062 | foreach ($rClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $m) { |
||
| 1063 | |||
| 1064 | // We consider object Xxxx implemented if the includeXxxxSet() method is |
||
| 1065 | // declared public on this. |
||
| 1066 | |||
| 1067 | if ($m->getDeclaringClass()->name !== $className) { |
||
| 1068 | // The method is declared on an ancestor class. |
||
| 1069 | continue; |
||
| 1070 | } |
||
| 1071 | |||
| 1072 | if (substr($m->name, 0, 7) === 'include' && substr($m->name, -3) === 'Set') { |
||
| 1073 | $this->implementedObjects[substr($m->name, 7, -3)] = 1; |
||
| 1074 | } |
||
| 1075 | } |
||
| 1076 | } |
||
| 1077 | |||
| 1078 | return isset($this->implementedObjects[$objectClassName]); |
||
| 1079 | } |
||
| 1080 | |||
| 1081 | /** |
||
| 1082 | * Returns the current user id. |
||
| 1083 | * |
||
| 1084 | * @return string The current user id or '' if the user is not logged in. |
||
| 1085 | */ |
||
| 1086 | public function getCurrentUser() |
||
| 1089 | } |
||
| 1090 | |||
| 1091 | public function isSSEEnabled() |
||
| 1092 | { |
||
| 1093 | $registry = app_getRegistry(); |
||
| 1094 | $registry->changeDirectory('configuration'); |
||
| 1095 | $registry->changeDirectory('SSE'); |
||
| 1096 | return $registry->getValue('enabled', false); |
||
| 1097 | } |
||
| 1098 | |||
| 1099 | public function getLoggedUsers() |
||
| 1100 | { |
||
| 1101 | global $babDB; |
||
| 1102 | $users = array(); |
||
| 1103 | $res = $babDB->db_query("SELECT DISTINCT(id_user) FROM ".BAB_USERS_LOG_TBL." WHERE id_user != 0"); |
||
| 1104 | while (list($id_user) = $babDB->db_fetch_array($res)) |
||
| 1105 | { |
||
| 1106 | $users[] = $id_user; |
||
| 1107 | } |
||
| 1108 | return $users; |
||
| 1109 | } |
||
| 1110 | |||
| 1111 | /** |
||
| 1112 | * Get upload path |
||
| 1113 | * if the method return null, no upload functionality |
||
| 1114 | * |
||
| 1115 | * @return \bab_Path |
||
| 1116 | */ |
||
| 1117 | public function uploadPath() |
||
| 1118 | { |
||
| 1119 | require_once $GLOBALS['babInstallPath'].'utilit/path.class.php'; |
||
| 1120 | return new \bab_Path(bab_getAddonInfosInstance($this->getAddonName())->getUploadPath()); |
||
| 1121 | } |
||
| 1122 | |||
| 1123 | /** |
||
| 1124 | * @see AppSSESet::newBrowserNotification() |
||
| 1125 | * @param array $data |
||
| 1126 | * @param mixed $for |
||
| 1127 | * @return boolean |
||
| 1128 | */ |
||
| 1129 | public function createBrowserNotification($data, $for = null) |
||
| 1130 | { |
||
| 1131 | $sseSet = $this->SSESet(); |
||
| 1132 | return $sseSet->newBrowserNotification($data, $for); |
||
| 1133 | } |
||
| 1134 | |||
| 1135 | /** |
||
| 1136 | * @see AppSSESet::newReloadSelector() |
||
| 1137 | * @param string $data |
||
| 1138 | * @param mixed $for |
||
| 1139 | * @return boolean |
||
| 1140 | */ |
||
| 1141 | public function createReloadSelector($reloadSelector, $for = null) |
||
| 1145 | } |
||
| 1146 | } |
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths