phpmyadmin/libraries/plugins/export/TableProperty.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Holds the TableProperty class
   5  *
   6  * @package    PhpMyAdmin-Export
   7  * @subpackage CodeGen
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  * TableProperty class
  15  *
  16  * @package    PhpMyAdmin-Export
  17  * @subpackage CodeGen
  18  */
  19 class TableProperty
  20 {
  21     /**
  22      * Name
  23      *
  24      * @var string
  25      */
  26     public $name;
  27
  28     /**
  29      * Type
  30      *
  31      * @var string
  32      */
  33     public $type;
  34
  35     /**
  36      * Wheter the key is nullable or not
  37      *
  38      * @var bool
  39      */
  40     public $nullable;
  41
  42     /**
  43      * The key
  44      *
  45      * @var int
  46      */
  47     public $key;
  48
  49     /**
  50      * Default value
  51      *
  52      * @var mixed
  53      */
  54     public $defaultValue;
  55
  56     /**
  57      * Extension
  58      *
  59      * @var string
  60      */
  61     public $ext;
  62
  63     /**
  64      * Constructor
  65      *
  66      * @param array $row table row
  67      *
  68      * @return void
  69      */
  70     function __construct($row)
  71     {
  72         $this->name = trim($row[0]);
  73         $this->type = trim($row[1]);
  74         $this->nullable = trim($row[2]);
  75         $this->key = trim($row[3]);
  76         $this->defaultValue = trim($row[4]);
  77         $this->ext = trim($row[5]);
  78     }
  79
  80     /**
  81      * Gets the pure type
  82      *
  83      * @return string type
  84      */
  85     function getPureType()
  86     {
  87         $pos = strpos($this->type, "(");
  88         if ($pos > 0) {
  89             return substr($this->type, 0, $pos);
  90         }
  91         return $this->type;
  92     }
  93
  94     /**
  95      * Tells whether the key is null or not
  96      *
  97      * @return bool true if the key is not null, false otherwise
  98      */
  99     function isNotNull()
 100     {
 101         return $this->nullable == "NO" ? "true" : "false";
 102     }
 103
 104     /**
 105      * Tells whether the key is unique or not
 106      *
 107      * @return bool true if the key is unique, false otherwise
 108      */
 109     function isUnique()
 110     {
 111         return $this->key == "PRI" || $this->key == "UNI" ? "true" : "false";
 112     }
 113
 114      /**
 115      * Gets the .NET primitive type
 116      *
 117      * @return string type
 118      */
 119     function getDotNetPrimitiveType()
 120     {
 121         if (strpos($this->type, "int") === 0) {
 122             return "int";
 123         }
 124         if (strpos($this->type, "long") === 0) {
 125             return "long";
 126         }
 127         if (strpos($this->type, "char") === 0) {
 128             return "string";
 129         }
 130         if (strpos($this->type, "varchar") === 0) {
 131             return "string";
 132         }
 133         if (strpos($this->type, "text") === 0) {
 134             return "string";
 135         }
 136         if (strpos($this->type, "longtext") === 0) {
 137             return "string";
 138         }
 139         if (strpos($this->type, "tinyint") === 0) {
 140             return "bool";
 141         }
 142         if (strpos($this->type, "datetime") === 0) {
 143             return "DateTime";
 144         }
 145         return "unknown";
 146     }
 147
 148     /**
 149      * Gets the .NET object type
 150      *
 151      * @return string type
 152      */
 153     function getDotNetObjectType()
 154     {
 155         if (strpos($this->type, "int") === 0) {
 156             return "Int32";
 157         }
 158         if (strpos($this->type, "long") === 0) {
 159             return "Long";
 160         }
 161         if (strpos($this->type, "char") === 0) {
 162             return "String";
 163         }
 164         if (strpos($this->type, "varchar") === 0) {
 165             return "String";
 166         }
 167         if (strpos($this->type, "text") === 0) {
 168             return "String";
 169         }
 170         if (strpos($this->type, "longtext") === 0) {
 171             return "String";
 172         }
 173         if (strpos($this->type, "tinyint") === 0) {
 174             return "Boolean";
 175         }
 176         if (strpos($this->type, "datetime") === 0) {
 177             return "DateTime";
 178         }
 179         return "Unknown";
 180     }
 181
 182     /**
 183      * Gets the index name
 184      *
 185      * @return string containing the name of the index
 186      */
 187     function getIndexName()
 188     {
 189         if (strlen($this->key) > 0) {
 190             return "index=\""
 191                 . htmlspecialchars($this->name, ENT_COMPAT, 'UTF-8')
 192                 . "\"";
 193         }
 194         return "";
 195     }
 196
 197     /**
 198      * Tells whether the key is primary or not
 199      *
 200      * @return bool true if the key is primary, false otherwise
 201      */
 202     function isPK()
 203     {
 204         return $this->key=="PRI";
 205     }
 206
 207     /**
 208      * Formats a string for C#
 209      *
 210      * @param string $text string to be formatted
 211      *
 212      * @return string formatted text
 213      */
 214     function formatCs($text)
 215     {
 216         $text = str_replace(
 217             "#name#",
 218             ExportCodegen::cgMakeIdentifier($this->name, false),
 219             $text
 220         );
 221         return $this->format($text);
 222     }
 223
 224     /**
 225      * Formats a string for XML
 226      *
 227      * @param string $text string to be formatted
 228      *
 229      * @return string formatted text
 230      */
 231     function formatXml($text)
 232     {
 233         $text = str_replace(
 234             "#name#",
 235             htmlspecialchars($this->name, ENT_COMPAT, 'UTF-8'),
 236             $text
 237         );
 238         $text = str_replace(
 239             "#indexName#",
 240             $this->getIndexName(),
 241             $text
 242         );
 243         return $this->format($text);
 244     }
 245
 246     /**
 247      * Formats a string
 248      *
 249      * @param string $text string to be formatted
 250      *
 251      * @return string formatted text
 252      */
 253     function format($text)
 254     {
 255         $text = str_replace(
 256             "#ucfirstName#",
 257             ExportCodegen::cgMakeIdentifier($this->name),
 258             $text
 259         );
 260         $text = str_replace(
 261             "#dotNetPrimitiveType#",
 262             $this->getDotNetPrimitiveType(),
 263             $text
 264         );
 265         $text = str_replace(
 266             "#dotNetObjectType#",
 267             $this->getDotNetObjectType(),
 268             $text
 269         );
 270         $text = str_replace(
 271             "#type#",
 272             $this->getPureType(),
 273             $text
 274         );
 275         $text = str_replace(
 276             "#notNull#",
 277             $this->isNotNull(),
 278             $text
 279         );
 280         $text = str_replace(
 281             "#unique#",
 282             $this->isUnique(),
 283             $text
 284         );
 285         return $text;
 286     }
 287 }
 288 ?>