Documentation/libraries/controller.html

   1 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   2 <head>
   3         <title>CarbonPHP Documentation</title>
   4         <style type="text/css">
   5                 * {
   6                         margin: 0;
   7                         padding: 0;
   8                 }
   9
  10                 html {
  11                         font-family: "Lucida Sans Unicode", "Lucida Grande";
  12                         font-size: 12px;
  13                 }
  14
  15                 body {
  16                         background: #fff;
  17                         color: #666;
  18                 }
  19
  20                 h1 {
  21                         font-size: 15px;
  22                         font-weight: bold;
  23                         margin: 0 0 5px 0;
  24                 }
  25
  26                 h2 {
  27                         font-size: 13px;
  28                         font-weight: bold;
  29                         margin: 5px 0 5px 0;
  30                 }
  31
  32                 ol, ul {
  33                         margin: 10px 0 10px 0;
  34                         list-style-position: inside;
  35                 }
  36
  37                 p {
  38                         margin: 5px 0 5px 0;
  39                 }
  40
  41                 .content {
  42                         border: 1px dotted #444;
  43                         margin: 10px;
  44                         padding: 10px;
  45                         text-align: justify;
  46                         width: 700px;
  47                 }
  48
  49                 .example {
  50                         border: 1px solid #ccc;
  51                         background: #eee;
  52                         margin: 10px;
  53                         padding: 10px;
  54                 }
  55         </style>
  56 </head>
  57
  58 <body>
  59         <div class="content">
  60                 <h1>Controller Library</h1>
  61
  62                 <p>This library is a core library and you probably won't have any interaction with it, however the following
  63                 methods are present in the class.</p>
  64         </div>
  65
  66         <div class="content">
  67                 <h1>Controller Class Methods</h1>
  68
  69                 <h2>public function __construct()</h2>
  70                 <p>This method initialises the class and calls the <b>c_initialise()</b> method.</p>
  71
  72                 <h2>private function c_initialise()</h2>
  73                 <p>This method loads and initialises the core CarbonPHP libraries, and then loads any files that are in the
  74                 autoload configuration file.</p>
  75
  76                 <h2>public function c_scaffolding()</h2>
  77                 <p>This method is called if scaffolding is requested, and this method loads the scaffolding class, and
  78                 displays the scaffolding.</p>
  79
  80                 <h2>public function set_scaffolding($scaffolding)</h2>
  81                 <p>This method sets whether the request is a scaffolding request or not. <b>$scaffolding</b> being <b>true</b>
  82                 or <b>false</b>.</p>
  83
  84                 <h2>public function set_scaff_table($scaff_table)</h2>
  85                 <p>This method sets the name of the database table that is being scaffolded.</p>
  86         </div>
  87 </body>
  88
  89 </html>