Documentation/libraries/loader.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>Loader Library</h1>
  61
  62                 <p>This is the class that loads the various elements within the framework.  These elements can be, models,
  63                 views, utilities, and even your own files.</p>
  64
  65                 <p><i>Note</i>: this library is loaded automatically by CarbonPHP.</p>
  66         </div>
  67
  68         <div class="content">
  69                 <h1>$this->load->library('class_name')</h1>
  70
  71                 <p>This method loads the core CarbonPHP libraries.  <b>class_name</b> is the name of the class you wish to
  72                 load.  For example if you wish to load the pagination library you would do the following.</p>
  73
  74                 <div class="example">
  75                         $this->load->library('<b>pagination</b>');
  76                 </div>
  77
  78                 <p>Once the library has been loaded it will be accessible via the object in the <b>$this</b> object.  Each
  79                 library is outlined on its own page.</p>
  80         </div>
  81
  82         <div class="content">
  83                 <h1>$this->load->view('view_name', $data, true/false)</h1>
  84
  85                 <p>This method is used to load a view file.  The first parameter is required and is the name of the view file
  86                 to load without the file extension.</p>
  87
  88                 <p>The second parameter is an optional parameter that can take an array or an object, which it runs through
  89                 the PHP function <b>extract</b> to convert to variables that can be accessed in the view file.</p>
  90
  91                 <p>The third parameter is another optional parameter that changes how the method returns.  If the parameter
  92                 is set to <b>true</b> the method will return the data instead of sending it to the browser.</p>
  93
  94                 <div class="example">
  95                         $data = $this->load->view('<b>myview</b>', '', <b>true</b>);
  96                 </div>
  97         </div>
  98
  99         <div class="content">
 100                 <h1>$this->load->database('options', true/false)</h1>
 101
 102                 <p>This method loads the database class which connects to a database.  This method is outlined more in the
 103                 database pages.</p>
 104         </div>
 105
 106         <div class="content">
 107                 <h1>$this->load->scaffolding('table_name')</h1>
 108
 109                 <p>This method enables scaffolding.  This method is outlined more in the scaffolding page.</p>
 110         </div>
 111
 112         <div class="content">
 113                 <h1>$this->load->var($array)</h1>
 114
 115                 <p>This method takes an array as input and generates variables.  This method produces the same result as
 116                 using the second parameter of <b>$this->load->view()</b> explained above.  The main reason you may wish to
 117                 use this is if you wish to set some global variables in the constructor of your controller and have them
 118                 become available in any view file.</p>
 119         </div>
 120
 121         <div class="content">
 122                 <h1>$this->load->utility('file_name')</h1>
 123
 124                 <p>This method loads any utility files, where <b>file_name</b> is the name of the utility without the
 125                 <b>_utility.php</b> on the end.</p>
 126         </div>
 127
 128         <div class="content">
 129                 <h1>$this->load->file('filepath/filename', true/false)</h1>
 130
 131                 <p>This method will load any file.  If the second parameter is set to <b>true</b> the data from the file will
 132                 be returned as a string, instead of being sent to the browser.</p>
 133         </div>
 134
 135         <div class="content">
 136                 <h1>$this->load->language('file_name')</h1>
 137
 138                 <p>This method is an alias of the <b>$this->lang->load()</b> method.</p>
 139         </div>
 140
 141         <div class="content">
 142                 <h1>$this->load->config('file_name')</h1>
 143
 144                 <p>This method is an alias of the <b>$this->config->load()</b> method.</p>
 145         </div>
 146 </body>
 147
 148 </html>