interface/forms/painmap/FormPainMap.php

   1 <?php
   2 /*
   3  * Copyright Medical Information Integration,LLC info@mi-squared.com
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * @file FormPainMap.php
  10  *
  11  * @brief This file ontains the FormPainMap class, used to model the data contents of a clickmap based form.
  12  */
  13 /* include the class we are extending. */
  14 require_once($GLOBALS['fileroot'] . "/interface/clickmap/AbstractClickmapModel.php");
  15
  16 /**
  17  * @class FormPainMap
  18  *
  19  * @brief This class extends the AbstractClickmapModel class, to create a class for modelling the data in a pain form.
  20  */
  21 class FormPainMap extends AbstractClickmapModel
  22 {
  23
  24     /**
  25      * The database table to place form data in/read form data from.
  26      *
  27      * @var TABLE_NAME
  28      */
  29
  30     static $TABLE_NAME = "form_painmap";
  31
  32     /* Initializer. just calls parent's initializer. */
  33     function __construct($id = "")
  34     {
  35         parent::__construct(FormPainMap::$TABLE_NAME, $id);
  36     }
  37
  38     /**
  39      * @brief Return the Title of the form, Useful when calling addform().
  40      */
  41     public function getTitle()
  42     {
  43         return C_FormPainMap::$FORM_TITLE;
  44     }
  45
  46     /**
  47      * @brief Return the 'Code' of the form. Again, used when calling addform().
  48      */
  49     public function getCode()
  50     {
  51         return C_FormPainMap::$FORM_CODE;
  52     }
  53 }