]> git.mxchange.org Git - core.git/blob - framework/main/classes/database/class_BaseDatabaseResult.php
Continued:
[core.git] / framework / main / classes / database / class_BaseDatabaseResult.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Result\Database;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\Local\LocalUpdateCriteria;
7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
8
9 /**
10  * A general class for database results
11  *
12  * @see                 DatabaseBackend - An interface for database backends
13  * @author              Roland Haeder <webmaster@ship-simu.org>
14  * @version             0.0.0
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
16  * @license             GNU GPL 3.0 or any newer version
17  * @link                http://www.ship-simu.org
18  *
19  * This program is free software: you can redistribute it and/or modify
20  * it under the terms of the GNU General Public License as published by
21  * the Free Software Foundation, either version 3 of the License, or
22  * (at your option) any later version.
23  *
24  * This program is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License
30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
31  */
32 abstract class BaseDatabaseResult extends BaseFrameworkSystem {
33         // Result array names
34         const RESULT_NAME_ROWS      = 'rows';
35         const RESULT_NAME_STATUS    = 'status';
36         const RESULT_NAME_EXCEPTION = 'exception';
37
38         /**
39          * Update criteria instance
40          */
41         private $updateInstance = NULL;
42
43         /**
44          * Protected constructor
45          *
46          * @return      void
47          */
48         protected function __construct (string $className) {
49                 // Call parent constructor
50                 parent::__construct($className);
51         }
52
53         /**
54          * Setter for update instance
55          *
56          * @param       $updateInstance         An instance of a LocalUpdateCriteria clase
57          * @return      void
58          */
59         public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
60                 $this->updateInstance = $updateInstance;
61         }
62
63         /**
64          * Getter for update instance
65          *
66          * @return      $updateInstance         Updateable criteria instance
67          */
68         public final function getUpdateInstance () {
69                 return $this->updateInstance;
70         }
71
72 }