From: Roland Häder Date: Wed, 2 Dec 2020 05:34:32 +0000 (+0100) Subject: Refacturing: X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=0bd3f6a4242ba7cd9948a5477b22703531706e49;p=core.git Refacturing: - extracted traits for $list and $visitor instances Signed-off-by: Roland Häder --- diff --git a/framework/main/classes/file_directories/class_BaseAbstractFile.php b/framework/main/classes/file_directories/class_BaseAbstractFile.php index ced4f119..171ad3b7 100644 --- a/framework/main/classes/file_directories/class_BaseAbstractFile.php +++ b/framework/main/classes/file_directories/class_BaseAbstractFile.php @@ -58,7 +58,7 @@ abstract class BaseAbstractFile extends BaseFrameworkSystem implements FilePoint * @param $pointerInstance An instance of an FilePointer class * @return void */ - protected final function setPointerInstance (FilePointer $pointerInstance) { + protected final function setPointerInstance (FilePointer $pointerInstance = NULL) { $this->pointerInstance = $pointerInstance; } @@ -83,8 +83,8 @@ abstract class BaseAbstractFile extends BaseFrameworkSystem implements FilePoint * @return void */ protected final function unsetPointerInstance () { - // Simply it to NULL - $this->pointerInstance = NULL; + // Simply invoke setter with no parameter + $this->setPointerInstance(); } /** diff --git a/framework/main/classes/handler/tasks/class_TaskHandler.php b/framework/main/classes/handler/tasks/class_TaskHandler.php index 40badb6f..84b9f603 100644 --- a/framework/main/classes/handler/tasks/class_TaskHandler.php +++ b/framework/main/classes/handler/tasks/class_TaskHandler.php @@ -6,12 +6,12 @@ namespace Org\Mxchange\CoreFramework\Handler\Task; use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap; use Org\Mxchange\CoreFramework\Factory\ObjectFactory; use Org\Mxchange\CoreFramework\Handler\BaseHandler; -use Org\Mxchange\CoreFramework\Lists\Listable; use Org\Mxchange\CoreFramework\Registry\Registerable; use Org\Mxchange\CoreFramework\Task\Taskable; use Org\Mxchange\CoreFramework\Traits\Iterator\IteratorTrait; +use Org\Mxchange\CoreFramework\Traits\Lists\ListableTrait; +use Org\Mxchange\CoreFramework\Traits\Visitor\VisitorTrait; use Org\Mxchange\CoreFramework\Visitor\Visitable; -use Org\Mxchange\CoreFramework\Visitor\Visitor; /** * A Task handler @@ -38,20 +38,12 @@ use Org\Mxchange\CoreFramework\Visitor\Visitor; class TaskHandler extends BaseHandler implements Registerable, HandleableTask { // Load traits use IteratorTrait; + use ListableTrait; + use VisitorTrait; // Exception constants const EXCEPTION_TASK_IS_INVALID = 0xb00; - /** - * Visitor handler instance - */ - private $visitorInstance = NULL; - - /** - * Instance of the list - */ - private $listInstance = NULL; - /** * Protected constructor * @@ -97,44 +89,6 @@ class TaskHandler extends BaseHandler implements Registerable, HandleableTask { return $handlerInstance; } - /** - * Setter for visitor instance - * - * @param $visitorInstance An instance of a Visitor class - * @return void - */ - protected final function setVisitorInstance (Visitor $visitorInstance) { - $this->visitorInstance = $visitorInstance; - } - - /** - * Getter for visitor instance - * - * @return $visitorInstance An instance of a Visitor class - */ - protected final function getVisitorInstance () { - return $this->visitorInstance; - } - - /** - * Setter for the list instance - * - * @param $listInstance A list of Listable - * @return void - */ - protected final function setListInstance (Listable $listInstance) { - $this->listInstance = $listInstance; - } - - /** - * Getter for the list instance - * - * @return $listInstance A list of Listable - */ - protected final function getListInstance () { - return $this->listInstance; - } - /** * Tries to execute the given task. If as task should not be started (yet) * or the interval time (see task_interval_delay) is not yet reached the diff --git a/framework/main/traits/list/class_ListableTrait.php b/framework/main/traits/list/class_ListableTrait.php new file mode 100644 index 00000000..087600dc --- /dev/null +++ b/framework/main/traits/list/class_ListableTrait.php @@ -0,0 +1,55 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program 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 3 of the License, 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, see . + */ +trait ListableTrait { + /** + * Instance of the list + */ + private $listInstance = NULL; + + /** + * Setter for the list instance + * + * @param $listInstance A list of Listable + * @return void + */ + protected final function setListInstance (Listable $listInstance) { + $this->listInstance = $listInstance; + } + + /** + * Getter for the list instance + * + * @return $listInstance A list of Listable + */ + protected final function getListInstance () { + return $this->listInstance; + } + +} diff --git a/framework/main/traits/visitor/class_VisitorTrait.php b/framework/main/traits/visitor/class_VisitorTrait.php new file mode 100644 index 00000000..2a0b5c02 --- /dev/null +++ b/framework/main/traits/visitor/class_VisitorTrait.php @@ -0,0 +1,55 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program 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 3 of the License, 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, see . + */ +trait VisitorTrait { + /** + * Visitor handler instance + */ + private $visitorInstance = NULL; + + /** + * Setter for visitor instance + * + * @param $visitorInstance An instance of a Visitor class + * @return void + */ + protected final function setVisitorInstance (Visitor $visitorInstance) { + $this->visitorInstance = $visitorInstance; + } + + /** + * Getter for visitor instance + * + * @return $visitorInstance An instance of a Visitor class + */ + protected final function getVisitorInstance () { + return $this->visitorInstance; + } + +}