/application/plugins/reminders/models/base/BaseReminders.class.php

https://github.com/dbernar1/Project-Pier · PHP · 231 lines · 80 code · 18 blank · 133 comment · 24 complexity · b68a02afa10b2fdebe58d5f736ffa48d MD5 · raw file 

    

  1. <?php 

    2. 

  2. 

    3. 

  3.   abstract class BaseReminders extends DataManager {

    4. 

  4.   

    5. 

  5.     /**

    6. 

  6.     * Column name => Column type map

    7. 

  7.     *

    8. 

  8.     * @var array

    9. 

  9.     * @static

    10. 

  10.     */

    11. 

  11.     static private $columns = array('user_id' => DATA_TYPE_INTEGER, 'reminders_enabled' => DATA_TYPE_BOOLEAN, 'summarized_by' => DATA_TYPE_STRING, 'days_in_future' => DATA_TYPE_INTEGER, 'include_everyone' => DATA_TYPE_BOOLEAN, 'reminder_days' => DATA_TYPE_STRING, 'reports_enabled' => DATA_TYPE_BOOLEAN, 'reports_summarized_by' => DATA_TYPE_BOOLEAN, 'reports_include' => DATA_TYPE_BOOLEAN, 'reports_activity' => DATA_TYPE_BOOLEAN, 'report_day' => DATA_TYPE_STRING);

    12. 

  12. //    `user_id` int(10) unsigned NOT NULL default '0',

    13. 

  13. //  `reminders_enabled` boolean,

    14. 

  14. //  `summarize_by` ENUM('all', 'project', 'milestone','task') NOT NULL,

    15. 

  15. //  `days_in_future` int unsigned not null default '0',

    16. 

  16. //  `include_everyone` boolean,

    17. 

  17. //  `reminder_days` SET('Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'), 

    18. 

  18.     /**

    19. 

  19.     * Construct

    20. 

  20.     *

    21. 

  21.     * @return Reminder 

    22. 

  22.     */

    23. 

  23.     function __construct() {

    24. 

  24.       parent::__construct('Reminder', 'reminders', true);

    25. 

  25.     } // __construct

    26. 

  26.     

    27. 

  27.     // -------------------------------------------------------

    28. 

  28.     //  Description methods

    29. 

  29.     // -------------------------------------------------------

    30. 

  30.     

    31. 

  31.     /**

    32. 

  32.     * Return array of object columns

    33. 

  33.     *

    34. 

  34.     * @access public

    35. 

  35.     * @param void

    36. 

  36.     * @return array

    37. 

  37.     */

    38. 

  38.     function getColumns() {

    39. 

  39.       return array_keys(self::$columns);

    40. 

  40.     } // getColumns

    41. 

  41.     

    42. 

  42.     /**

    43. 

  43.     * Return column type

    44. 

  44.     *

    45. 

  45.     * @access public

    46. 

  46.     * @param string $column_name

    47. 

  47.     * @return string

    48. 

  48.     */

    49. 

  49.     function getColumnType($column_name) {

    50. 

  50.       if (isset(self::$columns[$column_name])) {

    51. 

  51.         return self::$columns[$column_name];

    52. 

  52.       } else {

    53. 

  53.         return DATA_TYPE_STRING;

    54. 

  54.       } // if

    55. 

  55.     } // getColumnType

    56. 

  56.     

    57. 

  57.     /**

    58. 

  58.     * Return array of PK columns. If only one column is PK returns its name as string

    59. 

  59.     *

    60. 

  60.     * @access public

    61. 

  61.     * @param void

    62. 

  62.     * @return array or string

    63. 

  63.     */

    64. 

  64.     function getPkColumns() {

    65. 

  65.       return 'user_id';

    66. 

  66.     } // getPkColumns

    67. 

  67.     

    68. 

  68.     /**

    69. 

  69.     * Return name of first auto_incremenent column if it exists

    70. 

  70.     *

    71. 

  71.     * @access public

    72. 

  72.     * @param void

    73. 

  73.     * @return string

    74. 

  74.     */

    75. 

  75.     function getAutoIncrementColumn() {

    76. 

  76.       return null;

    77. 

  77.     } // getAutoIncrementColumn

    78. 

  78.     

    79. 

  79.     // -------------------------------------------------------

    80. 

  80.     //  Finders

    81. 

  81.     // -------------------------------------------------------

    82. 

  82.     

    83. 

  83.     /**

    84. 

  84.     * Do a SELECT query over database with specified arguments

    85. 

  85.     *

    86. 

  86.     * @access public

    87. 

  87.     * @param array $arguments Array of query arguments. Fields:

    88. 

  88.     * 

    89. 

  89.     *  - one - select first row

    90. 

  90.     *  - conditions - additional conditions

    91. 

  91.     *  - order - order by string

    92. 

  92.     *  - offset - limit offset, valid only if limit is present

    93. 

  93.     *  - limit

    94. 

  94.     * 

    95. 

  95.     * @return one or Reminders objects

    96. 

  96.     * @throws DBQueryError

    97. 

  97.     */

    98. 

  98.     function find($arguments = null) {

    99. 

  99.       if (isset($this) && instance_of($this, 'Reminders')) {

    100. 

  100.         return parent::find($arguments);

    101. 

  101.       } else {

    102. 

  102.         return Reminders::instance()->find($arguments);

    103. 

  103.       } // if

    104. 

  104.     } // find

    105. 

  105.     

    106. 

  106.     /**

    107. 

  107.     * Find all records

    108. 

  108.     *

    109. 

  109.     * @access public

    110. 

  110.     * @param array $arguments

    111. 

  111.     * @return one or Reminders objects

    112. 

  112.     */

    113. 

  113.     function findAll($arguments = null) {

    114. 

  114.       if (isset($this) && instance_of($this, 'Reminders')) {

    115. 

  115.         return parent::findAll($arguments);

    116. 

  116.       } else {

    117. 

  117.         return Reminders::instance()->findAll($arguments);

    118. 

  118.         //$instance =& Reminders::instance();

    119. 

  119.         //return $instance->findAll($arguments);

    120. 

  120.       } // if

    121. 

  121.     } // findAll

    122. 

  122.     

    123. 

  123.     /**

    124. 

  124.     * Find one specific record

    125. 

  125.     *

    126. 

  126.     * @access public

    127. 

  127.     * @param array $arguments

    128. 

  128.     * @return ProjectForm 

    129. 

  129.     */

    130. 

  130.     function findOne($arguments = null) {

    131. 

  131.       if (isset($this) && instance_of($this, 'Reminders')) {

    132. 

  132.         return parent::findOne($arguments);

    133. 

  133.       } else {

    134. 

  134.         return Reminders::instance()->findOne($arguments);

    135. 

  135.         //$instance =& Reminders::instance();

    136. 

  136.         //return $instance->findOne($arguments);

    137. 

  137.       } // if

    138. 

  138.     } // findOne

    139. 

  139.     

    140. 

  140.     /**

    141. 

  141.     * Return object by its PK value

    142. 

  142.     *

    143. 

  143.     * @access public

    144. 

  144.     * @param mixed $id

    145. 

  145.     * @param boolean $force_reload If true cache will be skipped and data will be loaded from database

    146. 

  146.     * @return ProjectForm 

    147. 

  147.     */

    148. 

  148.     function findById($id, $force_reload = false) {

    149. 

  149.       if (isset($this) && instance_of($this, 'Reminders')) {

    150. 

  150.         return parent::findById($id, $force_reload);

    151. 

  151.       } else {

    152. 

  152.         return Reminders::instance()->findById($id, $force_reload);

    153. 

  153.         //$instance =& Reminders::instance();

    154. 

  154.         //return $instance->findById($id, $force_reload);

    155. 

  155.       } // if

    156. 

  156.     } // findById

    157. 

  157.     

    158. 

  158.     /**

    159. 

  159.     * Return number of rows in this table

    160. 

  160.     *

    161. 

  161.     * @access public

    162. 

  162.     * @param string $conditions Query conditions

    163. 

  163.     * @return integer

    164. 

  164.     */

    165. 

  165.     function count($condition = null) {

    166. 

  166.       if (isset($this) && instance_of($this, 'Reminders')) {

    167. 

  167.         return parent::count($condition);

    168. 

  168.       } else {

    169. 

  169.         return Reminders::instance()->count($condition);

    170. 

  170.         //$instance =& Reminders::instance();

    171. 

  171.         //return $instance->count($condition);

    172. 

  172.       } // if

    173. 

  173.     } // count

    174. 

  174.     

    175. 

  175.     /**

    176. 

  176.     * Delete rows that match specific conditions. If $conditions is NULL all rows from table will be deleted

    177. 

  177.     *

    178. 

  178.     * @access public

    179. 

  179.     * @param string $conditions Query conditions

    180. 

  180.     * @return boolean

    181. 

  181.     */

    182. 

  182.     function delete($condition = null) {

    183. 

  183.       if (isset($this) && instance_of($this, 'Reminders')) {

    184. 

  184.         return parent::delete($condition);

    185. 

  185.       } else {

    186. 

  186.         return Reminders::instance()->delete($condition);

    187. 

  187.         //$instance =& Reminders::instance();

    188. 

  188.         //return $instance->delete($condition);

    189. 

  189.       } // if

    190. 

  190.     } // delete

    191. 

  191.     

    192. 

  192.     /**

    193. 

  193.     * This function will return paginated result. Result is an array where first element is 

    194. 

  194.     * array of returned object and second populated pagination object that can be used for 

    195. 

  195.     * obtaining and rendering pagination data using various helpers.

    196. 

  196.     * 

    197. 

  197.     * Items and pagination array vars are indexed with 0 for items and 1 for pagination

    198. 

  198.     * because you can't use associative indexing with list() construct

    199. 

  199.     *

    200. 

  200.     * @access public

    201. 

  201.     * @param array $arguments Query argumens (@see find()) Limit and offset are ignored!

    202. 

  202.     * @param integer $items_per_page Number of items per page

    203. 

  203.     * @param integer $current_page Current page number

    204. 

  204.     * @return array

    205. 

  205.     */

    206. 

  206.     function paginate($arguments = null, $items_per_page = 10, $current_page = 1) {

    207. 

  207.       if (isset($this) && instance_of($this, 'Reminders')) {

    208. 

  208.         return parent::paginate($arguments, $items_per_page, $current_page);

    209. 

  209.       } else {

    210. 

  210.         return Reminders::instance()->paginate($arguments, $items_per_page, $current_page);

    211. 

  211.         //$instance =& Reminders::instance();

    212. 

  212.         //return $instance->paginate($arguments, $items_per_page, $current_page);

    213. 

  213.       } // if

    214. 

  214.     } // paginate

    215. 

  215.     

    216. 

  216.     /**

    217. 

  217.     * Return manager instance

    218. 

  218.     *

    219. 

  219.     * @return Reminders 

    220. 

  220.     */

    221. 

  221.     function instance() {

    222. 

  222.       static $instance;

    223. 

  223.       if (!instance_of($instance, 'Reminders')) {

    224. 

  224.         $instance = new Reminders();

    225. 

  225.       } // if

    226. 

  226.       return $instance;

    227. 

  227.     } // instance

    228. 

  228.   

    229. 

  229.   } // Reminders 

    230. 

  230. 

    231. 

  231. ?>
    232.