| [ Index ] |
PHP Cross Reference of Nucleus CMS 3.32 |
[Summary view] [Print] [Text view]
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 2 <html xml:lang="en" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <!-- $Id: sqltables.html 1177 2007-06-22 12:37:32Z kaigreve $ --> 5 <title>Nucleus - SQL Table Structure</title> 6 <link rel="stylesheet" type="text/css" href="styles/manual.css" /> 7 <style type="text/css"> 8 /* auto increment table columns*/ 9 .autoinc { 10 } 11 12 /* primary-keys */ 13 .primary { 14 text-decoration: underline; 15 font-weight: bold; 16 } 17 18 /* NOT NULL */ 19 .notnull { 20 } 21 22 /* unique key */ 23 .unique { 24 } 25 26 /* foreign keys */ 27 .foreign { 28 font-style: italic; 29 } 30 31 /* auto increment table columns*/ 32 .autoinc { 33 } 34 35 /* fulltext index */ 36 .fulltext { 37 } 38 39 /* columns/tables to remove in later versions */ 40 .toremove { 41 color: red; 42 } 43 44 45 46 47 </style> 48 </head> 49 <body> 50 51 <a name="top" id="top"></a> 52 53 <div class="heading"> 54 SQL Table Reference 55 <i>March 13, 2007</i> 56 </div> 57 58 <h1>Introduction</h1> 59 60 <p> 61 <a href="index.html">Back to the developer docs index</a> 62 </p> 63 64 <p> 65 This document contains information on the fields inside the Nucleus database tables. 66 </p> 67 68 <p class="note">The structure as presented here is for <strong>Nucleus v3.2</strong>.</p> 69 70 <h1><a name="toc" id="toc"></a>Table Of Contents</h1> 71 72 <ul> 73 <li><a href="#legend">Color codes in this document</a></li> 74 <li> 75 76 Blogs 77 78 <ul> 79 <li><a href="#nucleus_blog">nucleus_blog</a></li> 80 <li><a href="#nucleus_category">nucleus_category</a></li> 81 <li><a href="#nucleus_item">nucleus_item</a></li> 82 <li><a href="#nucleus_comment">nucleus_comment</a></li> 83 <li><a href="#nucleus_member">nucleus_member</a></li> 84 <li><a href="#nucleus_team">nucleus_team</a></li> 85 </ul> 86 </li> 87 <li> 88 Plugins 89 <ul> 90 <li><a href="#nucleus_plugin">nucleus_plugin</a></li> 91 <li><a href="#nucleus_plugin_event">nucleus_plugin_event</a></li> 92 <li><a href="#nucleus_plugin_option">nucleus_plugin_option</a></li> 93 <li><a href="#nucleus_plugin_option_desc">nucleus_plugin_option_desc</a></li> 94 </ul> 95 </li> 96 <li> 97 Skins and templates 98 <ul> 99 <li><a href="#nucleus_skin">nucleus_skin</a></li> 100 <li><a href="#nucleus_skin_desc">nucleus_skin_desc</a></li> 101 <li><a href="#nucleus_template">nucleus_template</a></li> 102 <li><a href="#nucleus_template_desc">nucleus_template_desc</a></li> 103 </ul> 104 </li> 105 <li> 106 Administration 107 <ul> 108 <li><a href="#nucleus_actionlog">nucleus_actionlog</a></li> 109 <li> 110 <a href="#nucleus_config">nucleus_config</a> 111 <ul> 112 <li><a href="#nucleus_config_options">Available Options</a></li> 113 </ul> 114 </li> 115 <li><a href="#nucleus_tickets">nucleus_tickets</a></li> 116 <li><a href="#nucleus_activation">nucleus_activation</a></li> 117 </ul> 118 </li> 119 <li> 120 Extras 121 <ul> 122 <li><a href="#nucleus_karma">nucleus_karma</a></li> 123 <li><a href="#nucleus_ban">nucleus_ban</a></li> 124 </ul> 125 </li> 126 127 128 </ul> 129 130 <a id="legend" name="legend"></a> 131 <h1>Color codes<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 132 133 <p>This document uses some visual styles to indicate the type of columns. An overview is listed below:</p> 134 135 <table><tr> 136 <td class="primary">primary</td> 137 <td>Primary keys</td> 138 </tr><tr> 139 <td class="foreign">foreign</td> 140 <td>Foreign keys (click to go to the references value in other columns). Please note that MySQL does not enforce foreign key restrictions.</td> 141 </tr><tr> 142 <td class="toremove">toremove</td> 143 <td>Tables/columns that will probably be removed in upcoming Nucleus version, in favor of plugins that provide the same functionality.</td> 144 </tr><tr> 145 <td class="fulltext">fulltext</td> 146 <td>There is a fulltext index on the column (used for searches).</td> 147 </tr></table> 148 149 150 <a id="nucleus_blog" name="nucleus_blog"></a> 151 <h1>Table nucleus_blog<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 152 153 <table><tr> 154 <th>Column Name</th> 155 <th>Type</th> 156 <th>Default</th> 157 <th>Description</th> 158 159 </tr><tr> 160 <td class="notnull autoinc primary">bnumber</td> 161 <td>int(11)</td> 162 <td></td> 163 <td>Blog ID</td> 164 165 </tr><tr> 166 <td class="notnull">bname</td> 167 <td>varchar(60)</td> 168 <td>''</td> 169 <td>Blog Name</td> 170 171 </tr><tr> 172 <td class="notnull unique">bshortname</td> 173 <td>varchar(15)</td> 174 <td>''</td> 175 <td>Short Blog Name (as used in skinvars <code><%blog%></code> etc.)</td> 176 177 </tr><tr> 178 <td>bdesc</td> 179 <td>varchar(200)</td> 180 <td>NULL</td> 181 <td>Blog Description</td> 182 183 </tr><tr> 184 <td class="notnull">bcomments</td> 185 <td>tinyint(2)</td> 186 <td>'1'</td> 187 <td>Enable comments (1=true, 0=false)</td> 188 189 </tr><tr> 190 <td class="notnull">bmaxcomments</td> 191 <td>int(11)</td> 192 <td>'0'</td> 193 <td>Maximum amount of comments to show on <code>index</code> skintypes (inline comments). The default value (0) means that there is no limit. If you don't use inline comments, you shouldn't edit this.</td> 194 195 </tr><tr> 196 <td class="notnull">btimeoffset</td> 197 <td>decimal(3,1)</td> 198 <td>'0.0'</td> 199 <td>Time offset to use. The items will be stored in the database using the correct time (server time+offset).</td> 200 201 </tr><tr> 202 <td class="toremove">bnotify</td> 203 <td>varchar(60)</td> 204 <td>NULL</td> 205 <td>Notify e-mail address. On certain events (see <code>bnotifytype</code> for the exact definition of these events), a notification e-mail is sent out to this e-mail address.</td> 206 207 </tr><tr> 208 <td>burl</td> 209 <td>varchar(100)</td> 210 <td>NULL</td> 211 <td>Blog URL</td> 212 213 </tr><tr> 214 <td class="toremove">bupdate</td> 215 <td>varchar(60)</td> 216 <td>NULL</td> 217 <td>Update file that needs to be altered each time a new item is posted to the weblog. Its an absolute path of a file on the server.</td> 218 219 </tr><tr> 220 <td class="notnull foreign"><a href="#nucleus_skin_desc">bdefskin</a></td> 221 <td>int(11)</td> 222 <td>'1'</td> 223 <td>Default skin to use when displaying this weblog</td> 224 225 </tr><tr> 226 <td class="notnull">bpublic</td> 227 <td>tinyint(2)</td> 228 <td>'1'</td> 229 <td>Allow comments by non-registered members? (1=true/0=false)</td> 230 231 </tr><tr> 232 <td class="notnull toremove">bsendping</td> 233 <td>tinyint(2)</td> 234 <td>'0'</td> 235 <td>Send a ping to various weblog listing services on update? (1=true/0=false) This option is only visible when NP_Ping plugin is installed</td> 236 237 </tr><tr> 238 <td class="notnull toremove">bconvertbreaks</td> 239 <td>tinyint(2)</td> 240 <td>'1'</td> 241 <td>Convert line breaks to <code><br /></code>? (1=true/0=false)</td> 242 243 </tr><tr> 244 <td class="foreign"><a href="#nucleus_category">bdefcat</a></td> 245 <td>int(11)</td> 246 <td>NULL</td> 247 <td>Default category. This category will be selected by default when no other category is selected.</td> 248 249 </tr><tr> 250 <td class="notnull">bnotifytype</td> 251 <td>int(11)</td> 252 <td>'15'</td> 253 <td> 254 Which events to send notification e-mails on (see <code>bnotify</code> for the specification of the e-mail address). It's a combination of three values (multiply the values to get the notify type): 255 <ul> 256 <li>3: New comment</li> 257 <li>5: New karma vote</li> 258 <li>7: New item</li> 259 </ul> 260 Default = New comments & New karma votes (3*5=15) 261 </td> 262 263 </tr><tr> 264 <td class="notnull">ballowpast</td> 265 <td>tinyint(2)</td> 266 <td>'0'</td> 267 <td>Allow backdating of items and editing the timestamp of an item (1=true/0=false)</td> 268 269 </tr><tr> 270 <td class="notnull">bincludesearch</td> 271 <td>tinyint(2)</td> 272 <td>'0'</td> 273 <td>Always include in search queries, even if the query is on another blog (1=true/0=false)</td> 274 </tr></table> 275 276 277 <a id="nucleus_category" name="nucleus_category"></a> 278 <h1>Table nucleus_category<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 279 280 <table><tr> 281 <th>Column Name</th> 282 <th>Type</th> 283 <th>Default</th> 284 <th>Description</th> 285 </tr><tr> 286 <td class="notnull autoinc primary">catid</td> 287 <td>int(11)</td> 288 <td></td> 289 <td>Category ID</td> 290 291 </tr><tr> 292 <td class="notnull foreign"><a href="#nucleus_blog">cblog</a></td> 293 <td>int(11)</td> 294 <td>'0'</td> 295 <td>Blog to which the category belongs</td> 296 297 </tr><tr> 298 <td>cname</td> 299 <td>varchar(40)</td> 300 <td>NULL</td> 301 <td>Category Name</td> 302 303 </tr><tr> 304 <td>cdesc</td> 305 <td>varchar(200)</td> 306 <td>NULL</td> 307 <td>Category Description</td> 308 </tr></table> 309 310 311 <a id="nucleus_item" name="nucleus_item"></a> 312 <h1>Table nucleus_item<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 313 314 <table><tr> 315 <th>Column Name</th> 316 <th>Type</th> 317 <th>Default</th> 318 <th>Description</th> 319 </tr><tr> 320 <td class="notnull autoinc primary">inumber</td> 321 <td>int(11)</td> 322 <td></td> 323 <td>Item ID</td> 324 325 </tr><tr> 326 <td class="fulltext">ititle</td> 327 <td>varchar(160)</td> 328 <td>NULL</td> 329 <td>Title</td> 330 331 </tr><tr> 332 <td class="notnull fulltext">ibody</td> 333 <td>text</td> 334 <td></td> 335 <td>Body text</td> 336 337 </tr><tr> 338 <td class="fulltext">imore</td> 339 <td>text</td> 340 <td></td> 341 <td>Extended text</td> 342 343 </tr><tr> 344 <td class="notnull foreign"><a href="#nucleus_blog">iblog</a></td> 345 <td>int(11)</td> 346 <td>'0'</td> 347 <td>Blog to which the item belongs to</td> 348 349 </tr><tr> 350 <td class="notnull foreign"><a href="#nucleus_member">iauthor</a></td> 351 <td>int(11)</td> 352 <td>'0'</td> 353 <td>Member that is the author of the item</td> 354 355 </tr><tr> 356 <td class="notnull">itime</td> 357 <td>datetime</td> 358 <td>'0000-00-00 00:00:00'</td> 359 <td>Item time (this is the corrected time, with offset already applies)</td> 360 361 </tr><tr> 362 <td class="notnull">iclosed</td> 363 <td>tinyint(2)</td> 364 <td>'0'</td> 365 <td>Is item closed? (1=true/0=false). When an item is closed, it's no longer possible to add new comments or cast 'karma votes'</td> 366 367 </tr><tr> 368 <td class="notnull">idraft</td> 369 <td>tinyint(2)</td> 370 <td>'0'</td> 371 <td>Is the item a draft version? Draft versions only show up in the admin area.</td> 372 373 </tr><tr> 374 <td class="notnull toremove">ikarmapos</td> 375 <td>int(11)</td> 376 <td>'0'</td> 377 <td>Total amount of positive karma votes casted</td> 378 379 </tr><tr> 380 <td class="notnull toremove">ikarmaneg</td> 381 <td>int(11)</td> 382 <td>'0'</td> 383 <td>Total amount of negative karma votes casted</td> 384 385 </tr><tr> 386 <td class="foreign"><a href="#nucleus_category">icat</a></td> 387 <td>int(11)</td> 388 <td>NULL</td> 389 <td>Category to which the item belongs</td> 390 391 </tr></table> 392 393 394 <a id="nucleus_comment" name="nucleus_comment"></a> 395 <h1>Table nucleus_comment<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 396 397 <table><tr> 398 <th>Column Name</th> 399 <th>Type</th> 400 <th>Default</th> 401 <th>Description</th> 402 </tr><tr> 403 <td class="notnull autoinc primary">cnumber</td> 404 <td>int(11)</td> 405 <td></td> 406 <td>Comment ID</td> 407 408 </tr><tr> 409 <td class="notnull fulltext">cbody</td> 410 <td>text</td> 411 <td></td> 412 <td>Comment text</td> 413 414 </tr><tr> 415 <td>cuser</td> 416 <td>varchar(40)</td> 417 <td>NULL</td> 418 <td>Anonymous user name (only used when comment was placed by a non-member. For members, see <code>cmember</code>)</td> 419 420 </tr><tr> 421 <td>cmail</td> 422 <td>varchar(100)</td> 423 <td>NULL</td> 424 <td>E-mail address or URL (only used when comment was placed by a non-member. For members, see <code>cmember</code>)</td> 425 426 </tr><tr> 427 <td class="foreign"><a href="#nucleus_member">cmember</a></td> 428 <td>int(11)</td> 429 <td>NULL</td> 430 <td>ID of site member that placed the commend (0 for comments by non-members)</td> 431 432 </tr><tr> 433 <td class="notnull foreign"><a href="#nucleus_item">citem</a></td> 434 <td>int(11)</td> 435 <td>'0'</td> 436 <td>Item ID to which the comment is attached</td> 437 438 </tr><tr> 439 <td class="notnull">ctime</td> 440 <td>datetime</td> 441 <td>'0000-00-00 00:00:00'</td> 442 <td>Time of comment</td> 443 444 </tr><tr> 445 <td>chost</td> 446 <td>varchar(60)</td> 447 <td>NULL</td> 448 <td>Hostname from where the comment was placed</td> 449 450 </tr><tr> 451 <td class="notnull">cip</td> 452 <td>varchar(15)</td> 453 <td>''</td> 454 <td>IP address from where the comment was placed</td> 455 456 </tr><tr> 457 <td class="notnull foreign"><a href="#nucleus_blog">cblog</a></td> 458 <td>int(11)</td> 459 <td>'0'</td> 460 <td>Blog to which the comment belongs (this is redundant information)</td> 461 462 </tr></table> 463 464 465 466 <a id="nucleus_member" name="nucleus_member"></a> 467 <h1>Table nucleus_member<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 468 469 <table><tr> 470 <th>Column Name</th> 471 <th>Type</th> 472 <th>Default</th> 473 <th>Description</th> 474 </tr><tr> 475 <td class="notnull autoinc primary">mnumber</td> 476 <td>int(11)</td> 477 <td></td> 478 <td>Member ID</td> 479 480 </tr><tr> 481 <td class="notnull unique">mname</td> 482 <td>varchar(16)</td> 483 <td>''</td> 484 <td>Display name (the one used to login)</td> 485 486 </tr><tr> 487 <td>mrealname</td> 488 <td>varchar(60)</td> 489 <td>NULL</td> 490 <td>Full name</td> 491 492 </tr><tr> 493 <td class="notnull">mpassword</td> 494 <td>varchar(40)</td> 495 <td>''</td> 496 <td>password (<a href="http://www.php.net/md5" title="Info about the PHP md5() function">md5</a> hash)</td> 497 498 </tr><tr> 499 <td>memail</td> 500 <td>varchar(60)</td> 501 <td>NULL</td> 502 <td>E-mail address. This should always be a valid address.</td> 503 504 </tr><tr> 505 <td>murl</td> 506 <td>varchar(100)</td> 507 <td>NULL</td> 508 <td>URL of members site</td> 509 510 </tr><tr> 511 <td>mnotes</td> 512 <td>varchar(100)</td> 513 <td>NULL</td> 514 <td>Extra notes (members can fill these out themselves)</td> 515 516 </tr><tr> 517 <td class="notnull">madmin</td> 518 <td>tinyint(2)</td> 519 <td>'0'</td> 520 <td>Is super-admin? (1=true/0=false; super-admins have all rights; there must be at least one super-admin in the system)</td> 521 522 </tr><tr> 523 <td class="notnull">mcanlogin</td> 524 <td>tinyint(2)</td> 525 <td>'1'</td> 526 <td>Can logon to admin area? (1=true/0=false)</td> 527 528 </tr><tr> 529 <td>mcookiekey</td> 530 <td>varchar(40)</td> 531 <td>NULL</td> 532 <td>A copy of the key that is stored in the users cookie. This key is used to log on. When a member logs on, a random cookiekey is generated. One copy goes into the database, another one goes into a cookie on the users computer. (together with the username).</td> 533 534 </tr><tr> 535 <td class="notnull">deflang</td> 536 <td>varchar(20)</td> 537 <td>''</td> 538 <td>Language file to use for this member. When empty, uses the default site language.</td> 539 </tr></table> 540 541 542 543 544 <a id="nucleus_team" name="nucleus_team"></a> 545 <h1>Table nucleus_team<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 546 547 <p>For each team member of a blog, there is a row in this table.</p> 548 549 <table><tr> 550 <th>Column Name</th> 551 <th>Type</th> 552 <th>Default</th> 553 <th>Description</th> 554 </tr><tr> 555 <td class="notnull primary foreign"><a href="#nucleus_member">tmember</a></td> 556 <td>int(11)</td> 557 <td>'0'</td> 558 <td>Member ID</td> 559 560 </tr><tr> 561 <td class="notnull primary foreign"><a href="#nucleus_blog">tblog</a></td> 562 <td>int(11)</td> 563 <td>'0'</td> 564 <td>Blog of which member is on team</td> 565 566 </tr><tr> 567 <td class="notnull">tadmin</td> 568 <td>tinyint(2)</td> 569 <td>'0'</td> 570 <td>Is blog admin? (0=false/1=true; each blog must have at least one admin)</td> 571 </tr></table> 572 573 574 <a id="nucleus_plugin" name="nucleus_plugin"></a> 575 <h1>Table nucleus_plugin<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 576 577 <table><tr> 578 <th>Column Name</th> 579 <th>Type</th> 580 <th>Default</th> 581 <th>Description</th> 582 </tr><tr> 583 <td class="notnull autoinc primary">pid</td> 584 <td>int(11)</td> 585 <td></td> 586 <td>Plugin ID</td> 587 588 </tr><tr> 589 <td class="notnull">pfile</td> 590 <td>varchar(40)</td> 591 <td>''</td> 592 <td>Filename (e.g. <code>NP_CommentControl</code>) of plugin. This must be a file in the plugins directory (.php extension).</td> 593 594 </tr><tr> 595 <td class="notnull">porder</td> 596 <td>int(11)</td> 597 <td>'0'</td> 598 <td>Order in which the plugins are called, and in which they are displayed on the plugins page. A lower order number places the plugin earlier in the list.</td> 599 </tr></table> 600 601 <a id="nucleus_plugin_event" name="nucleus_plugin_event"></a> 602 <h1>Table nucleus_plugin_event<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 603 604 <p>A cache that remembers which plugins are registered to which events. Thsi information is stored to avoid having to load all plugins on each requests just to find out which events they want to have. <a href="plugins.html#events">More info on plugins events</a></p> 605 606 <table><tr> 607 <th>Column Name</th> 608 <th>Type</th> 609 <th>Default</th> 610 <th>Description</th> 611 </tr><tr> 612 <td class="notnull foreign"><a href="#nucleus_plugin">pid</a></td> 613 <td>int(11)</td> 614 <td>'0'</td> 615 <td>Plugin ID</td> 616 617 </tr><tr> 618 <td>event</td> 619 <td>varchar(40)</td> 620 <td>NULL</td> 621 <td>Name of event</td> 622 </tr></table> 623 624 <a id="nucleus_plugin_option" name="nucleus_plugin_option"></a> 625 <h1>Table nucleus_plugin_option<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 626 627 <p>Values for the plugin options. See the <a href="#nucleus_plugin_option_desc">nucleus_plugin_option_desc</a> table for the definition of the options itself.</p> 628 629 <table><tr> 630 <th>Column Name</th> 631 <th>Type</th> 632 <th>Default</th> 633 <th>Description</th> 634 635 </tr><tr> 636 <td class="notnull autoinc primary foreign"><a href="#nucleus_plugin_option_desc">oid</a></td> 637 <td>int(11)</td> 638 <td></td> 639 <td>Identification of the option (See the <a href="#nucleus_plugin_option_desc">nucleus_plugin_option_desc</a> table)</td> 640 641 </tr><tr> 642 <td class="notnull">ovalue</td> 643 <td>TEXT</td> 644 <td>''</td> 645 <td>Value of the option</td> 646 647 </tr><tr> 648 <td class="notnull primary">ocontextid</td> 649 <td>int(11)</td> 650 <td>'0'</td> 651 <td> 652 Semantics depend on the option context type, 653 <ul> 654 <li>global context: not used</li> 655 <li>blog context: <a href="#nucleus_blog">blog id</a></li> 656 <li>category context: <a href="#nucleus_category">category id</a></li> 657 <li>member context: <a href="#nucleus_member">member id</a></li> 658 </ul> 659 </td> 660 </tr></table> 661 662 663 <a id="nucleus_plugin_option_desc" name="nucleus_plugin_option_desc"></a> 664 <h1>Table nucleus_plugin_option_desc<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 665 666 <p>For each option created by a plugin, a row is present in this table.</p> 667 668 <table><tr> 669 <th>Column Name</th> 670 <th>Type</th> 671 <th>Default</th> 672 <th>Description</th> 673 </tr><tr> 674 <td class="notnull autoinc unique">oid</td> 675 <td>int(11)</td> 676 <td></td> 677 <td>Option ID. Used from <a href="#nucleus_plugin_option">nucleus_plugin_option</a></td> 678 679 </tr><tr> 680 <td class="notnull primary foreign"><a href="#nucleus_plugin">opid</a></td> 681 <td>int(11)</td> 682 <td>'0'</td> 683 <td>Plugin to which the option belongs</td> 684 685 </tr><tr> 686 <td class="notnull primary">oname</td> 687 <td>varchar(20)</td> 688 <td>''</td> 689 <td>Name of the option</td> 690 691 </tr><tr> 692 <td class="notnull primary">ocontext</td> 693 <td>varchar(20)</td> 694 <td>''</td> 695 <td>Context of the option (<code>global</code>, <code>blog</code>, <code>category</code>, <code>member</code>)</td> 696 697 </tr><tr> 698 <td>odesc</td> 699 <td>varchar(255)</td> 700 <td>NULL</td> 701 <td>Option description</td> 702 703 </tr><tr> 704 <td>otype</td> 705 <td>varchar(20)</td> 706 <td>NULL</td> 707 <td>option type. <a href="plugins.html#options" title="Nucleus Plugin API - Option types">See plugin documentation</a>.</td> 708 709 </tr><tr> 710 <td>odef</td> 711 <td>text</td> 712 <td></td> 713 <td>Default value for options</td> 714 715 </tr><tr> 716 <td>oextra</td> 717 <td>text</td> 718 <td></td> 719 <td>Extra data needed for some option types (e.g. <code>select</code> option type)</td> 720 </tr></table> 721 722 <a id="nucleus_skin" name="nucleus_skin"></a> 723 <h1>Table nucleus_skin<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 724 725 <table><tr> 726 <th>Column Name</th> 727 <th>Type</th> 728 <th>Default</th> 729 <th>Description</th> 730 </tr><tr> 731 <td class="notnull primary foreign"><a href="#nucleus_skin_desc">sdesc</a></td> 732 <td>int(11)</td> 733 <td>'0'</td> 734 <td>Reference to the skin description</td> 735 736 </tr><tr> 737 <td class="notnull primary">stype</td> 738 <td>varchar(20)</td> 739 <td>''</td> 740 <td> 741 Skinpart type 742 <ul> 743 <li><code>index</code></li> 744 <li><code>item</code></li> 745 <li><code>archive</code></li> 746 <li><code>archivelist</code></li> 747 <li><code>search</code></li> 748 <li><code>error</code></li> 749 <li><code>member</code></li> 750 <li><code>imagepopup</code></li> 751 </ul> 752 </td> 753 754 </tr><tr> 755 <td class="notnull">scontent</td> 756 <td>text</td> 757 <td></td> 758 <td>Contents of the skinpart</td> 759 </tr></table> 760 761 <a id="nucleus_skin_desc" name="nucleus_skin_desc"></a> 762 <h1>Table nucleus_skin_desc<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 763 764 <table><tr> 765 <th>Column Name</th> 766 <th>Type</th> 767 <th>Default</th> 768 <th>Description</th> 769 </tr><tr> 770 <td class="notnull autoinc primary">sdnumber</td> 771 <td>int(11)</td> 772 <td></td> 773 <td>Skin ID</td> 774 775 </tr><tr> 776 <td class="notnull unique">sdname</td> 777 <td>varchar(20)</td> 778 <td>''</td> 779 <td>Name of skin</td> 780 781 </tr><tr> 782 <td>sddesc</td> 783 <td>varchar(200)</td> 784 <td>NULL</td> 785 <td>Skin description</td> 786 787 </tr><tr> 788 <td class="notnull">sdtype</td> 789 <td>varchar(40)</td> 790 <td>'text/html'</td> 791 <td>mimetype of skin</td> 792 793 </tr><tr> 794 <td class="notnull">sdincmode</td> 795 <td>varchar(10)</td> 796 <td>'normal'</td> 797 <td> 798 Include mode 799 <ul> 800 <li><code>normal</code></li> 801 <li><code>skindir</code></li> 802 </ul> 803 </td> 804 805 </tr><tr> 806 <td class="notnull">sdincpref</td> 807 <td>varchar(50)</td> 808 <td>''</td> 809 <td>Prefix to use when including files</td> 810 </tr></table> 811 812 <a id="nucleus_template" name="nucleus_template"></a> 813 <h1>Table nucleus_template<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 814 815 <table><tr> 816 <th>Column Name</th> 817 <th>Type</th> 818 <th>Default</th> 819 <th>Description</th> 820 </tr><tr> 821 <td class="notnull primary foreign"><a href="#nucleus_template_desc">tdesc</a></td> 822 <td>int(11)</td> 823 <td>'0'</td> 824 <td>Reference to template description info</td> 825 826 </tr><tr> 827 <td class="notnull primary">tpartname</td> 828 <td>varchar(20)</td> 829 <td>''</td> 830 <td> 831 Name of template part 832 <ul> 833 <li>ARCHIVELIST_FOOTER</li> 834 <li>ARCHIVELIST_HEADER</li> 835 <li>ARCHIVELIST_LISTITEM</li> 836 <li>CATLIST_FOOTER</li> 837 <li>CATLIST_HEADER</li> 838 <li>CATLIST_LISTITEM</li> 839 <li>COMMENTS_BODY</li> 840 <li>COMMENTS_MANY</li> 841 <li>COMMENTS_NONE</li> 842 <li>COMMENTS_ONE</li> 843 <li>COMMENTS_TOOMUCH</li> 844 <li>DATE_HEADER</li> 845 <li>EDITLINK</li> 846 <li>FORMAT_DATE</li> 847 <li>FORMAT_TIME</li> 848 <li>IMAGE_CODE</li> 849 <li>ITEM</li> 850 <li>LOCALE</li> 851 <li>MEDIA_CODE</li> 852 <li>MORELINK</li> 853 <li>POPUP_CODE</li> 854 <li>SEARCH_HIGHLIGHT</li> 855 <li>SEARCH_NOTHINGFOUND</li> 856 </ul> 857 </td> 858 859 </tr><tr> 860 <td class="notnull">tcontent</td> 861 <td>text</td> 862 <td></td> 863 <td>Contents of templatepart</td> 864 </tr></table> 865 866 867 <a id="nucleus_template_desc" name="nucleus_template_desc"></a> 868 <h1>Table nucleus_template_desc<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 869 870 <table><tr> 871 <th>Column Name</th> 872 <th>Type</th> 873 <th>Default</th> 874 <th>Description</th> 875 </tr><tr> 876 <td class="notnull autoinc primary unique">tdnumber</td> 877 <td>int(11)</td> 878 <td></td> 879 <td>Template ID</td> 880 881 </tr><tr> 882 <td class="notnull unique">tdname</td> 883 <td>varchar(20)</td> 884 <td>''</td> 885 <td>Name of template</td> 886 887 </tr><tr> 888 <td>tddesc</td> 889 <td>varchar(200)</td> 890 <td>NULL</td> 891 <td>Template description</td> 892 </tr></table> 893 894 <a id="nucleus_actionlog" name="nucleus_actionlog"></a> 895 <h1>Table nucleus_actionlog<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 896 897 <p>[[general purpose description]]</p> 898 899 <table><tr> 900 <th>Column Name</th> 901 <th>Type</th> 902 <th></th> 903 <th>Description</th> 904 </tr><tr> 905 <td class="notnull">timestamp</td> 906 <td>datetime</td> 907 <td>'0000-00-00 00:00:00'</td> 908 <td>Time of action</td> 909 910 </tr><tr> 911 <td class="notnull">message</td> 912 <td>varchar(255)</td> 913 <td>''</td> 914 <td>Action message</td> 915 </tr></table> 916 917 918 919 <a id="nucleus_config" name="nucleus_config"></a> 920 <h1>Table nucleus_config<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 921 922 <p>Nucleus stores some global options in the <code>nucleus_config</code> table. They can be accessed at any time using <code>$CONF['OptionName']</code> (the values are read on each request and stored in a global array named <code>$CONF</code>)</p> 923 924 <table><tr> 925 <th>Column Name</th> 926 <th>Type</th> 927 <th>Default</th> 928 <th>Description</th> 929 </tr><tr> 930 <td class="notnull primary">name</td> 931 <td>varchar(20)</td> 932 <td>''</td> 933 <td>Option name</td> 934 935 </tr><tr> 936 <td>value</td> 937 <td>varchar(128)</td> 938 <td>NULL</td> 939 <td>Option value</td> 940 </tr></table> 941 942 <a name="nucleus_config_options" id="nucleus_config_options"></a> 943 <h2>Available Options</h2> 944 945 <p>An overview of available options is given below:</p> 946 947 <p>Options for yes/no options are represented using 1/0 (1=yes/true, 0=no/false)</p> 948 949 <table><tr> 950 <th>Name</th> 951 <th>Default Value</th> 952 <th>Description</th> 953 </tr><tr> 954 <td class="foreign"><a href="#nucleus_blog">DefaultBlog</a></td> 955 <td>1</td> 956 <td>Default weblog. This is the blog that will be used when no other blog has been specified in the request.</td> 957 </tr><tr> 958 <td>AdminEmail</td> 959 <td></td> 960 <td>E-mail address of site administrator</td> 961 </tr><tr> 962 <td>IndexURL</td> 963 <td></td> 964 <td>URL of website. Should end with a slash.</td> 965 </tr><tr> 966 <td>Language</td> 967 <td>english</td> 968 <td>Language file to use by default. A file <strong>languagename.php</strong> must exist in the languages directory.</td> 969 </tr><tr> 970 <td>SessionCookie</td> 971 <td>0</td> 972 <td>Use session cookie instead of cookies with a lifetime of one month?</td> 973 </tr><tr> 974 <td>AllowMemberCreate</td> 975 <td>0</td> 976 <td>Allow visitors to create their own account?</td> 977 </tr><tr> 978 <td>AllowMemberMail</td> 979 <td>1</td> 980 <td>Allow members to send messages to each other through the member mail forms (e-mail addresses remain hidden)</td> 981 </tr><tr> 982 <td>SiteName</td> 983 <td></td> 984 <td>Name of the website</td> 985 </tr><tr> 986 <td>AdminURL</td> 987 <td></td> 988 <td>URL of admin area. Should end with a slash.</td> 989 </tr><tr> 990 <td>NewMemberCanLogon</td> 991 <td>1</td> 992 <td>Can newly registered members login right away? If not, the administrator will have to change their 'can login' option first</td> 993 </tr><tr> 994 <td class="toremove">DisableSite</td> 995 <td>0</td> 996 <td>Is the website disabled? If so, only the administrator can access it. All other visitors are redirected to <code>DisableSiteURL</code>.</td> 997 </tr><tr> 998 <td class="toremove">DisableSiteURL</td> 999 <td></td> 1000 <td>An URL to redirect to when the site is disabled.</td> 1001 </tr><tr> 1002 <td class="toremove">LastVisit</td> 1003 <td>0</td> 1004 <td>Save 'Last Visit' cookies</td> 1005 </tr><tr> 1006 <td>MediaURL</td> 1007 <td></td> 1008 <td>URL of media folder. Should end with a slash.</td> 1009 </tr><tr> 1010 <td>AllowedTypes</td> 1011 <td>jpg, jpeg, gif, mpg, mpeg, avi, mov, mp3, swf, png</td> 1012 <td>Filetypes that can be uploaded</td> 1013 </tr><tr> 1014 <td>AllowLoginEdit</td> 1015 <td>0</td> 1016 <td>Allow members to edit their login name and password?</td> 1017 </tr><tr> 1018 <td>AllowUpload</td> 1019 <td>1</td> 1020 <td>Allow file uploads?</td> 1021 </tr><tr> 1022 <td class="toremove">DisableJsTools</td> 1023 <td>2</td> 1024 <td> 1025 Style of the javascript toolbar: 1026 <ul> 1027 <li>0: full featured (IE)</li> 1028 <li>1: toolbar disabled</li> 1029 <li>2: simpler (Gecko)</li> 1030 </ul> 1031 </td> 1032 </tr><tr> 1033 <td>CookiePath</td> 1034 <td>/</td> 1035 <td>Path to set cookie on</td> 1036 </tr><tr> 1037 <td>CookiePrefix</td> 1038 <td></td> 1039 <td>String to prefix cookie names with. This is useful when multiple Nucleus installs are on the same domain, as it prevents login sessions to interfere with each other.</td> 1040 </tr><tr> 1041 <td>CookieDomain</td> 1042 <td></td> 1043 <td>Domain to set cookie on</td> 1044 </tr><tr> 1045 <td>CookieSecure</td> 1046 <td>0</td> 1047 <td>Secure cookie (https)</td> 1048 </tr><tr> 1049 <td>MediaPrefix</td> 1050 <td>1</td> 1051 <td>If true, the uploaded files get the current date in their filename.</td> 1052 </tr><tr> 1053 <td>MaxUploadSize</td> 1054 <td>1048576</td> 1055 <td>Max. size of uploaded files (in bytes)</td> 1056 </tr><tr> 1057 <td>NonmemberMail</td> 1058 <td>0</td> 1059 <td>Allow non-members to send e-mail messages to site members?</td> 1060 </tr><tr> 1061 <td>PluginURL</td> 1062 <td></td> 1063 <td>URL of plugin folder. Should end with a slash.</td> 1064 </tr><tr> 1065 <td>ProtectMemNames</td> 1066 <td>1</td> 1067 <td>When this option is enabled, non-logged in members cannot add comments using the same name as registered members. The reason to do this would be to avoid guest impersonating members.</td> 1068 </tr><tr> 1069 <td class="foreign"><a href="#nucleus_skin_desc">BaseSkin</a></td> 1070 <td>1</td> 1071 <td>The option tells Nucleus which skin to fall back to when no such decision can be automatically made. This happens when skin parts are empty, when no blog or skin is implicitly/explicitly selected.</td> 1072 </tr><tr> 1073 <td>SkinsURL</td> 1074 <td></td> 1075 <td>URL of skins folder. Should end with a slash.</td> 1076 </tr><tr> 1077 <td>ActionURL</td> 1078 <td></td> 1079 <td>URL of <code>action.php</code> script.</td> 1080 </tr><tr> 1081 <td>URLMode</td> 1082 <td>normal</td> 1083 <td>either <code>normal</code> or <code>pathinfo</code></td> 1084 </tr><tr> 1085 <td>DatabaseVersion</td> 1086 <td>250</td> 1087 <td>Last Nucleus version for which the database structure has been updated (introduced in Nucleus v2.5)</td> 1088 </tr></table 1089 1090 <a id="nucleus_tickets" name="nucleus_tickets"></a> 1091 <h1>Table nucleus_tickets<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 1092 1093 <p>Nucleus uses the <code>nucleus_tickets</code> to prevent against certain security issues. In particular: each action on the admin area that affects the settings or database contents, requires a ticket. These tickets are generated when requesting an admin area page and passed along with the form. Tickets are destroyed one hour after their creation.</p> 1094 1095 <table><tr> 1096 <th>Column Name</th> 1097 <th>Type</th> 1098 <th>Default</th> 1099 <th>Description</th> 1100 </tr><tr> 1101 <td class="notnull primary">ticket</td> 1102 <td>varchar(40)</td> 1103 <td></td> 1104 <td>Unique ticket, valid for one particular member. A typical ticket looks like this: <code>65303a785423b4d53c7b3e6579766f26</code></td> 1105 </tr><tr> 1106 <td class="notnull foreign primary"><a href="#nucleus_member">member</a></td> 1107 <td>int(11)</td> 1108 <td></td> 1109 <td>Member for which this ticket is valid.</td> 1110 </tr><tr> 1111 <td class="notnull">ctime</td> 1112 <td>datetime</td> 1113 <td></td> 1114 <td>Time of ticket creation. A ticket is valid no longer than one hour.</td> 1115 </tr></table> 1116 1117 1118 <a id="nucleus_activation" name="nucleus_activation"></a> 1119 <h1>Table nucleus_activation<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 1120 1121 <p>When a new member registers, Nucleus doesn't allow that member to log in before his account is activated. This activation is done by sending out an activation link to the members email address. The <code>nucleus_activation</code> table keeps track of the activations that are in progress.</p> 1122 1123 <table><tr> 1124 <th>Column Name</th> 1125 <th>Type</th> 1126 <th>Default</th> 1127 <th>Description</th> 1128 </tr><tr> 1129 <td class="notnull primary">vkey</td> 1130 <td>varchar(40)</td> 1131 <td></td> 1132 <td>Activation key. This key needs to be passed to the member activation code. A typical key looks like this: <code>41cf637d4fbeeff954b4ca70b8bde9dd</code></td> 1133 </tr><tr> 1134 <td class="notnull foreign"><a href="#nucleus_member">vmember</a></td> 1135 <td>int(11)</td> 1136 <td></td> 1137 <td>Member which needs to be activated.</td> 1138 </tr><tr> 1139 <td class="notnull">vtime</td> 1140 <td>datetime</td> 1141 <td></td> 1142 <td>Time at which activation key was generated. Each activation key is valid no longer than 2 days.</td> 1143 </tr><tr> 1144 <td class="notnull">vtype</td> 1145 <td>varchar(15)</td> 1146 <td></td> 1147 <td>Type of activation. 1148 <ul> 1149 <li><code>forgot</code>: member forgot his password.</li> 1150 <li><code>register</code>: new member registration.</li> 1151 <li><code>addresschange</code>: member changed his e-mail address.</li> 1152 </ul> 1153 </td> 1154 </tr><tr> 1155 <td class="notnull">vextra</td> 1156 <td>varchar(128)</td> 1157 <td></td> 1158 <td>Extra information. For an <code>addresschange</code> type of activation, this contains <code>oldemailaddress/x</code> with x either 0 or 1 and refering to the previous value of the <code>mcanlogin</code> field in the <a href="#nucleus_member">member</a> table. (untill fully re-activated, a user cannot login)</td> 1159 </tr></table> 1160 1161 1162 <a id="nucleus_karma" name="nucleus_karma"></a> 1163 <h1>Table nucleus_karma<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 1164 1165 <p class="toremove">This table will most likely be removed in future Nucleus version, in favor of plugins with the same functionality.</p> 1166 1167 <p>This table keeps track of IP addresses that have already voted for an item. This way, each IP address can cast only one vote.</p> 1168 1169 <table><tr> 1170 <th>Column Name</th> 1171 <th>Type</th> 1172 <th>Default</th> 1173 <th>Description</th> 1174 </tr><tr> 1175 <td class="notnull foreign"><a href="#nucleus_item">itemid</a></td> 1176 <td>int(11)</td> 1177 <td>'0'</td> 1178 <td>Item ID</td> 1179 1180 </tr><tr> 1181 <td class="notnull">ip</td> 1182 <td>char(15)</td> 1183 <td>''</td> 1184 <td>IP address of voter</td> 1185 </tr></table> 1186 1187 <a id="nucleus_ban" name="nucleus_ban"></a> 1188 <h1>Table nucleus_ban<a href="#top" class="toplink"><img src="../icon-up.gif" width="15" height="15" alt="back to top" /></a></h1> 1189 1190 <p class="toremove">This table will most likely be removed in future Nucleus version, in favor of plugins with the same functionality.</p> 1191 1192 <p>IP bans. These people cannot comment or cast karma votes.</p> 1193 1194 <table><tr> 1195 <th>Column Name</th> 1196 <th>Type</th> 1197 <th>Default</th> 1198 <th>Description</th> 1199 </tr><tr> 1200 <td class="notnull">iprange</td> 1201 <td>varchar(15)</td> 1202 <td>''</td> 1203 <td>IP 'range'. This can either be a full IP address or part of an IP address (starting from the left) to ban ranges</td> 1204 1205 </tr><tr> 1206 <td class="notnull">reason</td> 1207 <td>varchar(255)</td> 1208 <td>''</td> 1209 <td>A message with the reason why someone was banned. This message will be shown when they try to add a comment/cast a vote.</td> 1210 </tr><tr> 1211 <td class="notnull foreign"><a href="#nucleus_blog">blogid</a></td> 1212 <td>int(11)</td> 1213 <td>'0'</td> 1214 <td>Blog for which the ban is active</td> 1215 </tr></table> 1216 1217 1218 </body> 1219 </html>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Tue Feb 12 15:34:36 2008 | Cross-referenced by PHPXref 0.7 |