]> git.mxchange.org Git - core.git/blob - inc/classes/main/criteria/dataset/class_DataSetCriteria.php
Copyright year updated, converted double->single quotes
[core.git] / inc / classes / main / criteria / dataset / class_DataSetCriteria.php
1 <?php
2 /**
3  * A set of data storeable in databases
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class DataSetCriteria extends BaseCriteria implements StoreableCriteria {
25         /**
26          * Table name
27          */
28         private $tableName = '';
29
30         /**
31          * Unique key
32          */
33         private $uniqueKey = '';
34
35         /**
36          * Primary key
37          */
38         private $primaryKey = '';
39
40         /**
41          * Protected constructor
42          *
43          * @return      void
44          */
45         protected function __construct () {
46                 // Call parent constructor
47                 parent::__construct(__CLASS__);
48         }
49
50         /**
51          * Creates an instance of this criteria
52          *
53          * @param       $tableName                      Name of the table
54          * @return      $criteriaInstance       An instance of this criteria
55          */
56         public static final function createDataSetCriteria ($tableName) {
57                 // Get a new instance
58                 $criteriaInstance = new DataSetCriteria();
59
60                 // Set table name
61                 $criteriaInstance->setTableName($tableName);
62
63                 // Return the instance
64                 return $criteriaInstance;
65         }
66
67         /**
68          * Setter for table name
69          *
70          * @param       $tableName      Name of the table to set
71          * @return      void
72          */
73         public final function setTableName ($tableName) {
74                 $this->tableName = (string) $tableName;
75         }
76
77         /**
78          * Getter for table name
79          *
80          * @return      $tableName      Name of the table to set
81          */
82         public final function getTableName () {
83                 return $this->tableName;
84         }
85
86         /**
87          * Setter for unique key
88          *
89          * @param       $uniqueKey      Column to use as unique key
90          * @return      void
91          */
92         public final function setUniqueKey ($uniqueKey) {
93                 $this->uniqueKey = (string) $uniqueKey;
94         }
95
96         /**
97          * Getter for unique key
98          *
99          * @return      $uniqueKey      Column to use as unique key
100          */
101         public final function getUniqueKey () {
102                 return $this->uniqueKey;
103         }
104
105         /**
106          * Getter for unique key value
107          *
108          * @return      $uniqueValue    Value of the unique key
109          */
110         public final function getUniqueValue () {
111                 return $this->getCriteriaElemnent($this->getUniqueKey());
112         }
113
114         /**
115          * Getter for primary key or unique key if not set
116          *
117          * @return      $primaryKey             Primary key or unique key if not set
118          */
119         public final function getPrimaryKey () {
120                 // Get primary key by default
121                 $primaryKey = $this->primaryKey;
122
123                 if (empty($primaryKey)) {
124                         // Get uniqueKey
125                         $primaryKey = $this->getUniqueKey();
126                 } // END - if
127
128                 // Return it
129                 return $primaryKey;
130         }
131
132         /**
133          * Setter for primary key
134          *
135          * @param       $primaryKey             Primary key to set
136          * @return      void
137          */
138         public final function setPrimaryKey ($primaryKey) {
139                 $this->primaryKey = (string) $primaryKey;
140         }
141 }
142
143 // [EOF]
144 ?>