### Install Sphinx and Dependencies

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/README.rst

Installs the necessary Sphinx version and the sphinxcontrib-phpdomain extension for documenting PHP projects. It also mentions the CI Lexer for syntax highlighting.

```bash
easy_install "sphinx==1.6.3"
easy_install "sphinxcontrib-phpdomain==0.1.3.post1"
```

--------------------------------

### Apache Virtual Host Entry Example

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Sample-Apache-Setup-for-Windows

This snippet provides an example of a virtual host configuration block for Apache. It specifies the ServerName, DocumentRoot, and ErrorLog for a new development site, 'mynew.site'. This configuration is typically added to the httpd-vhosts.conf file.

```apache
<VirtualHost *:80>
  ServerName mynew.site
  DocumentRoot d:/www/php/mynew.site
  ErrorLog logs/mynew-error_log
</VirtualHost>
```

--------------------------------

### Build HTML Documentation

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/README.rst

Command to generate the HTML version of the CodeIgniter user guide from the ReStructured Text source files.

```bash
make html
```

--------------------------------

### Configure Database Settings

Source: https://github.com/bcit-ci/codeigniter/wiki/Installation

Provides example database connection settings for CodeIgniter. These values should be replaced with your actual database credentials.

```php
'hostname' => 'localhost',
'username' => 'exampleuser',
'password' => '6SPLwbEuQTK9v36H',
'database' => 'exampledb',
'dbdriver' => 'mysqli',

```

--------------------------------

### Apache Virtual Host Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Sample-Apache-Setup-for-Windows

This snippet demonstrates how to configure Apache's virtual hosts to map custom domain names to specific project directories. It includes examples for setting up a default host and individual project hosts, along with error log configurations.

```apache
NameVirtualHost *:80

<VirtualHost *:80>
  nServerName stardust
  DocumentRoot d:/www/php
  ErrorLog logs/stardust-error_log
</VirtualHost>

<VirtualHost *:80>
    ServerName blog.stardust
    DocumentRoot d:/www/php/blog
    ErrorLog logs/blog.stardust-error_log
</VirtualHost>
```

--------------------------------

### Download CodeIgniter

Source: https://github.com/bcit-ci/codeigniter/wiki/Installation

Downloads the CodeIgniter 2.2-stable archive from GitHub using wget. Assumes you are in the desired download directory.

```bash
cd ~
wget https://github.com/bcit-ci/CodeIgniter/archive/2.2-stable.zip

```

--------------------------------

### Install wget

Source: https://github.com/bcit-ci/codeigniter/wiki/Installation

Installs the wget utility, used for downloading files from the command line. This is a prerequisite for downloading the CodeIgniter archive.

```bash
sudo apt-get install wget

```

```bash
sudo yum install wget

```

--------------------------------

### Apache httpd.conf Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Sample-Apache-Setup-for-Windows

This snippet shows a comprehensive Apache httpd.conf file configuration. It covers base setup, module loading (including PHP), directory permissions, logging, and module-specific configurations. It's designed for a local development environment.

```apache
#----- Base Setup -----------------------------------------------------------
ServerRoot "d:/dev/apache"
Listen *:80

ThreadsPerChild 50
MaxRequestsPerChild  0

ServerAdmin admin@stardust
ServerName stardust
DocumentRoot "D:/www/php"

EnableSendfile Off
EnableMMAP Off
Win32DisableAcceptEx

#----- Module Loading -------------------------------------------------------
LoadModule authn_default_module modules/mod_authn_default.so
LoadModule authz_host_module modules/mod_authz_host.so
LoadModule dir_module modules/mod_dir.so
LoadModule mime_module modules/mod_mime.so
LoadModule rewrite_module modules/mod_rewrite.so
LoadModule setenvif_module modules/mod_setenvif.so
LoadModule php5_module d:/dev/php/php5apache2.dll

#----- Root Directory -------------------------------------------------------
<Directory />
    Options Indexes FollowSymLinks
    AllowOverride ALL
    Order allow,deny
    Allow from all
</Directory>

<IfModule dir_module>
    DirectoryIndex index.php  dispatch.fcgi index.html
</IfModule>

<FilesMatch "^\.ht">
    Order allow,deny
    Deny from all
</FilesMatch>


#----- Logging Configuration ------------------------------------------------
ErrorLog logs/error.log
LogLevel warn

<IfModule log_config_module>
    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
    LogFormat "%h %l %u %t \"%r\" %>s %b" common

    <IfModule logio_module>
      LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio
    </IfModule>
    CustomLog logs/access.log common
</IfModule>


#----- Module Configurations ------------------------------------------------
DefaultType text/plain
<IfModule mime_module>
  TypesConfig conf/mime.types
  AddType application/x-compress .Z
    AddType application/x-gzip .gz .tgz
  AddType application/x-httpd-php .php
    AddType application/x-httpd-phps .phps
</IfModule>

<IfModule php5>
    PHPIniDir "d:/dev/php"
</IfModule>

<IfModule cgid>
    AddHandler fastcgi-script .fcgi
</IfModule>

<IfModule alias_module>
    ScriptAlias /cgi-bin/ "D:/dev/Apache/cgi-bin/"
</IfModule>


#----- Extra Configurations -------------------------------------------------
Include conf/extra/httpd-vhosts.conf

```

--------------------------------

### Codeigniter and BackendPro Setup

Source: https://github.com/bcit-ci/codeigniter/wiki/Contributions/Ajax-Todo-List-system-with-Codeigniter

Instructions for setting up a Codeigniter project with BackendPro, including downloading, installation, database configuration, and user account creation.

```APIDOC
Project Setup:
  1. Download Codeigniter: http://codeigniter.com/downloads/
  2. Download BackendPro: http://www.kaydoo.co.uk/projects/backendpro
  3. Create project folder: C:\xampp\htdocs\ci_bep
  4. Unzip Codeigniter into the project folder.
  5. Move all BackendPro folders into the project folder.

Database Configuration:
  1. Create a database (e.g., 'ci_bep').
  2. Access installation URL: http://127.0.0.1/ci_bep/install/ or http://localhost/ci_bep/install/
  3. Enter database details, user account, and reCAPTCHA keys (optional).
  4. Click 'INSTALL BACKENDPRO'.

Login:
  - Use the email and password created during installation to log in.
```

--------------------------------

### Example Site Requirements

Source: https://github.com/bcit-ci/codeigniter/wiki/Multiple-Applications-via-Symlinks

Outlines the diverse requirements for four different websites that will share a common CodeIgniter codebase.

```php
site #1: one application
site #2: has both frontend and backend applications
     (will also operate on wildcard sub-domains)
site #3: uses ssl with one application
site #4: one application (internal access)
```

--------------------------------

### phpdoc Docblock Example

Source: https://github.com/bcit-ci/codeigniter/wiki/Approaches/I-have-the-welcome-page---but-now-what---jedd

An example of a phpdoc comment block used for documenting PHP code. It includes information such as the class/function description, links to related components, package, version, author, and project URL.

```php
/**
 * Forum
 *
 * Handles public message forums
 *
 * @link        Message (Model) - which handles all message-related tables
 * @package     pdb
 * @version     v0.9
 * @author      jedd
 * @link        http://my.web.site/trac/pdb
 **/
```

--------------------------------

### Lightwindow Usage Examples

Source: https://github.com/bcit-ci/codeigniter/wiki/Lightwindow-with-CI

Illustrates how to integrate the Lightwindow library into a CodeIgniter application. It shows controller setup, view integration with CSS/JS includes, and how to call the library's methods to display pop-ups.

```php
/*
----------------------------------------
in your controller. e.g: 'my_lightwindow.php'
----------------------------------------
function index(){
    $this->load->library('Lightwindow');
    $this->load->view('my_lightwindow');
}
--------------------------------------
in your view ('my_lightwindow.php')
--------------------------------------

<link href="base_url().'javascript/ajax_lightwindow/css/lightwindow.css'" type="text/css" rel=stylesheet />
<script type="text/javascript" src="<?=base_url()?>javascript/prototype/prototype-1.6.0.2.js">
<script type="text/javascript" src="<?=base_url()?>javascript/scriptaculous/scriptaculous.compressed.js?load=effects">


<a href="#" onClick="FuncName(); return false;">Open Lighwindow</a>
<?=$this->lightwindow->ajax('FuncName', 'index.php/file_to_open', 'My LightWindow', 'Good Work', 'My Name');?>
==============================================================================//
*/
```

--------------------------------

### Hosts File Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Sample-Apache-Setup-for-Windows

Configures local domain name resolution for development. This allows you to map hostnames like 'stardust' and 'blog.stardust' to your local machine (127.0.0.1).

```php
127.0.0.1       stardust
127.0.0.1    blog.stardust
127.0.0.1       localhost

```

--------------------------------

### php.ini Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Sample-Apache-Setup-for-Windows

Specifies key PHP settings for the development environment. Key directives include 'doc_root' for the document root directory and 'extension_dir' for the location of PHP extensions.

```php
doc_root = "c:\dev\www"
extension_dir = "d:\dev\php\ext"

```

--------------------------------

### Python Version Check

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/README.rst

A simple command to check the installed Python version, which must be 2.7 for Sphinx.

```python
python
```

--------------------------------

### Demo and Download Links

Source: https://github.com/bcit-ci/codeigniter/wiki/Course-Schedule-and-Booking-System

Provides links to access the live demo of the back-end and front-end applications, as well as the download page for the project.

```html
<h4>
<a href="http://websiteclub.skagerak.org/booking/index.php/auth/login" target="_blank">Back-end Demo</a></h4> 
<h4>
<a href="http://websiteclub.skagerak.org/booking/index.php/fitness" target="_blank">Front-end Demo</a></h4> 
<h4><a href="http://sourceforge.net/projects/cibooking/">Download page</a></h4>
```

--------------------------------

### Bug Fix - User Guide Typos and Examples

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/changelog.rst

Corrected various typos and examples within the user guide.

```php
/*
 * Fixed assorted user guide typos or examples (#4807, #4812, #4840,
 * #4862, #4864, #4899, #4930, #5006, #5071, #5158, #5229, #5254,
 * #5351).
 */
```

--------------------------------

### Initialize Git Repository

Source: https://github.com/bcit-ci/codeigniter/wiki/Approaches/I-have-the-welcome-page---but-now-what---jedd

Initializes a new Git repository in the current directory. This is the first step in using Git for version control.

```git
git init
```

--------------------------------

### CodeIgniter Video Tutorials

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Tutorials

A collection of video tutorials for learning CodeIgniter, ranging from introductory 'Hello World' examples to building a complete blog. Some tutorials are specific to older versions like CodeIgniter 1.x.

```URL
http://codeigniter.com/tutorials/watch/intro/
```

```URL
http://codeigniter.com/tutorials/watch/blog/
```

```URL
http://www.hectorcyc.com.mx/2012/04/06/codeigniter-crud/
```

```URL
http://tutorialcodeigniter.com/
```

```URL
http://video.derekallard.com/
```

```URL
http://www.filepanda.com/get/pelzttpw/
```

```URL
http://www.filepanda.com/get/gdvfyee3/
```

```URL
http://www.haughin.com/screencasts/
```

```URL
http://www.revver.com/video/366983/ignited-the-screencast-configuration/
```

```URL
http://www.udemy.com/codeigniter-learn-it-correct/
```

--------------------------------

### Unzip CodeIgniter Archive

Source: https://github.com/bcit-ci/codeigniter/wiki/Installation

Extracts the downloaded CodeIgniter zip file. Requires the unzip utility to be installed.

```bash
unzip 2.2-stable.zip

```

--------------------------------

### User Guide Typo Fixes

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/changelog.rst

Corrects various typos and examples in the user guide, referencing issue numbers for the fixes.

```php
-  Fixed assorted user guide typos or examples (#10693, #8951, #7825,
   #8660, #7883, #6771, #10656).
```

--------------------------------

### DX Auth Documentation and Examples

Source: https://github.com/bcit-ci/codeigniter/wiki/Libraries/DX-Auth

Links to the official documentation and a simple example for the DX Auth library. This allows users to find detailed information and see the library in action.

```text
Documentation (very well documented)
 [[http://dexcell.shinsengumiteam.com/dx_auth/]]

Simple example:
 [[http://dexcell.shinsengumiteam.com/dx_auth/examples/simple.html]]
```

--------------------------------

### Install PEAR and PHPUnit on Ubuntu

Source: https://github.com/bcit-ci/codeigniter/blob/develop/tests/README.md

Provides step-by-step instructions for installing the PEAR package manager and the PHPUnit testing framework, along with vfsStream, on Ubuntu systems. It includes commands for adding PEAR channels and installing dependencies.

```bash
sudo apt-get install php-pear

pear channel-discover pear.phpunit.de
pear channel-discover pear.symfony-project.com
pear channel-discover components.ez.no
pear channel-discover pear.bovigo.org

pear install --alldeps phpunit/PHPUnit
pear install --alldeps bovigo/vfsStream-beta
```

--------------------------------

### CodeIgniter Typo and Example Corrections

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/changelog.rst

Addresses assorted typos and corrects examples within the user guide for better clarity and accuracy.

```php
// Fixed assorted user guide typos or examples (#4574, #4706).
```

--------------------------------

### Advanced OAuthr Request with GET Method

Source: https://github.com/bcit-ci/codeigniter/wiki/Libraries/Oauthr

An example of making a more customized OAuthr request, including adding cURL options and parameters, and specifying the GET HTTP method.

```php
$this->load->library('oauthr');

$opts = array(CURLOPT_BUFFERSIZE     => 200,
              CURLOPT_CONNECTTIMEOUT => 0);

$this->oauthr->add_opt($opts);

$params = array('oauth_version' => '2.0',
                'somethingelse' => 'blah');

$this->oauthr->add_param($params);

$response = $this->oauthr->request('http://term.ie/oauth/example/request_token.php', 'GET');

```

--------------------------------

### ViewRegistry Class Example

Source: https://github.com/bcit-ci/codeigniter/wiki/View-Registry

An example of a controller class extending ViewRegistry, demonstrating constructor setup, setting the master view, and registering a view in the index method.

```php
class MyTestPage extends ViewRegistry {

    Function MyTestPage()
    {
        Parent::ViewRegistry();

        $this->setMasterView(‘master_view’);
    }

    Function index()
    {
        $this->regView(‘content’, ‘content_view’);
    }

}
```

--------------------------------

### Article Structure Example (Wiki Markup)

Source: https://github.com/bcit-ci/codeigniter/wiki/Wiki/Language-Article-Blueprint

An example of the expected wiki markup structure for a language contribution article, including sections for CodeIgniter language packs, user guide translations, and category links.

```wiki
**CodeIgniter language packs**
[quote]
[File:file.zip|Version x.x.x] translated by author
[File:file.zip|Version x.x.x] translated by author
[/quote]

**User Guide translations**
[quote]
None available.
[/quote]

[[Category:Contributions::Languages]]
```

--------------------------------

### CodeIgniter Debug Toolbar Installation Steps

Source: https://github.com/bcit-ci/codeigniter/wiki/Debug-toolbar

A summary of the steps required to install the debug toolbar. This includes copying files to the application directory, enabling hooks, and configuring the toolbar.

```bash
1. Copy the contents of 'application' folder to your application dir
2. Copy the icon images from the 'images' directory to your site's image directory
3. Enable Hooks (application/config/config.php)
4. Edit application/config/hooks.php add the hook configuration.
5. Configure your toolbar using application/config/debug_toolbar.php file
```

--------------------------------

### CodeIgniter Captcha Controller Example

Source: https://github.com/bcit-ci/codeigniter/wiki/Plugin/How-to-use-Codeigniter-captcha-plug-in-Part-1

A CodeIgniter controller example demonstrating how to generate a captcha image, save its details to the database, and display it to the user. It also includes logic for checking user input against the generated captcha.

```php
<?php if ( !defined( 'BASEPATH' ) ) exit( 'No direct script access allowed' );

class Myexample_captcha extends Controller {
  function Myexample_captcha()
  {
    parent :: Controller();
  }
  function index()
  {
    $captcha_result = '';
    $data["cap_img"] = $this -> _make_captcha();
    if ( $this -> input -> post( 'submit' ) ) {
      if ( $this -> _check_capthca() ) {
        $captcha_result = 'GOOD';
      }else {
        $captcha_result = 'BAD';
      }
    }
    $data["cap_msg"] = $captcha_result;
    $this -> load -> view( 'testcaptcha_view', $data );
  }
  function _make_captcha()
  {
    $this -> load -> plugin( 'captcha' );
    $vals = array(
      'img_path' => './captcha/', // PATH for captcha ( *Must mkdir (htdocs)/captcha )
      'img_url' => 'http://127.0.0.1/ci_captcha/captcha/', // URL for captcha img
      'img_width' => 200, // width
      'img_height' => 60, // height
      // 'font_path'     => '../system/fonts/2.ttf',
      // 'expiration' => 7200 ,
      );
    // Create captcha
    $cap = create_captcha( $vals );
    // Write to DB
    if ( $cap ) {
      $data = array(
        'captcha_id' => '',
        'captcha_time' => $cap['time'],
        'ip_address' => $this -> input -> ip_address(),
        'word' => $cap['word'] ,
        );
      $query = $this -> db -> insert_string( 'captcha', $data );
      $this -> db -> query( $query );
    }else {
      return "Umm captcha not work" ;
    }
    return $cap['image'] ;
  }

  function _check_capthca()

```

--------------------------------

### CodeIgniter Written Tutorials

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Tutorials

A curated list of written tutorials covering various aspects of CodeIgniter development, including installation, MVC principles, database interaction, security best practices, and integration with external libraries like PEAR and Swift Mailer.

```URL
http://codeigniter.com/wiki/PEAR_integration/
```

```URL
http://capsizedesigns.com/blog/2008/05/getting-started-with-codeigniter-part-1/
```

```URL
http://capsizedesigns.com/blog/2008/05/getting-started-with-codeigniter-part-2/
```

```URL
http://capsizedesigns.com/blog/2008/05/getting-started-with-codeigniter-part-3-database/
```

```URL
http://capsizedesigns.com/blog/2008/06/getting-started-with-codeigniter-part-4-security/
```

```URL
http://capsizedesigns.com/blog/2008/06/getting-started-with-codeigniter-part-5-loose-ends/
```

```URL
http://godbit.com/article/introduction-to-code-igniter
```

```URL
http://godbit.com/article/introduction-to-code-igniter-part-2
```

```URL
http://godbit.com/article/introduction-to-code-igniter-part-3
```

```URL
http://godbit.com/article/pagination-with-code-igniter
```

```URL
http://www.4webby.com/freakauth/tutorials/ci-swift-mailer
```

```URL
http://www.4webby.com/freakauth/tutorials/using-zend-framework-components-in-code-igniter
```

```URL
http://www.derekallard.com/blog/post/building-an-rss-feed-in-code-igniter/
```

```URL
http://pr0digy.com/codeigniter/unobtrusive-ajax-with-codeigniter-and-mootools/
```

```URL
http://pr0digy.com/codeigniter/live-search-with-codeigniter-and-mootools/
```

```URL
http://www.zenperfect.com/2007/07/12/model-view-controller-and-codeigniter/
```

```URL
http://www.zenperfect.com/2007/07/27/sample-codeigniter-application/
```

```URL
http://www.devshed.com/c/a/PHP/Introduction-to-the-CodeIgniter-PHP-Framework/
```

```URL
http://codesamplez.com/codeigniter-tutorials
```

--------------------------------

### Configure Encryption Key

Source: https://github.com/bcit-ci/codeigniter/wiki/Installation

Sets a random, 32-character encryption key for CodeIgniter. This is used for encryption and session security.

```php
$config['encryption_key'] = 'UEmQQkxr9o6qJ054rWh3feD2admpiK6O';

```

--------------------------------

### CodeIgniter Test Environment Setup

Source: https://github.com/bcit-ci/codeigniter/blob/develop/tests/README.md

Illustrates how the CodeIgniter test environment is established using vfsStream. It details the creation of global constants like BASEPATH and APPPATH, pointing to virtual file system locations, and introduces helper functions for managing VFS directory objects.

```php
// Example of VFS directory objects available within test cases:
// ci_vfs_root: VFS filesystem root
// ci_app_root: Application directory
// ci_base_root: System directory
// ci_view_root: Views directory

// The SYSTEM_PATH constant always points to the real system directory.
```

--------------------------------

### CodeIgniter Database Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Plugin/How-to-use-Codeigniter-captcha-plug-in-Part-1

Example of how to configure the database connection details in CodeIgniter's database.php file.

```php
$db['default']['hostname'] = "localhost";
$db['default']['username'] = "root1";
$db['default']['password'] = "root";
$db['default']['database'] = "ci_captcha";
$db['default']['dbdriver'] = "mysql";
```

--------------------------------

### CodeIgniter Pagination Initialization Example

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/libraries/pagination.rst

Demonstrates how to load the Pagination library and initialize it with basic configuration settings in a CodeIgniter controller.

```php
$this->load->library('pagination');

$config['base_url'] = 'http://example.com/index.php/test/page/';
$config['total_rows'] = 200;
$config['per_page'] = 20;

$this->pagination->initialize($config);

echo $this->pagination->create_links();
```

--------------------------------

### SimpleTester Installation and Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Library/SimpleTester---Unit-testing-library

This section outlines the steps to install SimpleTester in a CodeIgniter project. It involves downloading the library, the SimpleTest framework, and configuring CodeIgniter's autoloading. It also mentions how to verify the installation and troubleshoot IP address issues.

```bash
1. Download SimpleTester 1.1: [[File:simpletester1.1.zip]]
2. Unzip to application folder.
3. Download SimpleTest framework: http://simpletest.org/en/download.html
4. Gunzip to application/libraries (creates 'simpletest' folder).
5. Add 'simpletester' to application/config/autoload.php.
6. Place test files in application/tests.
```

```php
// In config/autoload.php
$autoload['libraries'] = array('database', 'session', 'simpletester');
```

```php
// Configuration for non-127.0.0.1 IPs
// Modify application/config/config.php or a dedicated SimpleTester config file
// Example: $config['simpletester_allowed_ips'] = array('192.168.1.100');
```

--------------------------------

### Code Block Syntax

Source: https://github.com/bcit-ci/codeigniter/wiki/pMCode-Reference

Shows how to wrap HTML or PHP code examples using the [code] tag for proper display.

```php
[code]A code example here [/code]

```

--------------------------------

### Configure Base URL

Source: https://github.com/bcit-ci/codeigniter/wiki/Installation

Sets the base URL for the CodeIgniter application in the main configuration file. This is essential for the framework to function correctly.

```php
$config['base_url'] = 'http://www.example.com/';

```

--------------------------------

### Install Sphinx and PHP Domain

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/documentation/index.rst

Installs Sphinx, the PHP domain extension for Sphinx, and the CI Lexer for Pygments to enable proper highlighting of PHP code blocks in the documentation.

```bash
easy_install "sphinx==1.2.3"
easy_install "sphinxcontrib-phpdomain==0.1.3.post1"
```

--------------------------------

### Download Doctrine using SVN

Source: https://github.com/bcit-ci/codeigniter/wiki/Using-Doctrine-with-Code-Igniter-Conventions

This command downloads the Doctrine ORM version 1.1.0-RC1 into the application/libraries/doctrine folder of a CodeIgniter installation using Subversion.

```bash
cd /path/to/ci/install/
svn co http://svn.doctrine-project.org/tags/1.1.0-RC1 system/application/libraries/doctrine
```

--------------------------------

### Header Partial Content

Source: https://github.com/bcit-ci/codeigniter/wiki/Library/codeigniter-template

Provides example content for a header partial, including setting the page title and meta information.

```php
<title><?php echo $template['title'];?> | Example Site </title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
```

--------------------------------

### APC Caching Example (PHP)

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/libraries/caching.rst

Demonstrates how to use the APC caching driver to save data. It requires the APC extension to be installed and enabled.

```php
$this->load->driver('cache');
$this->cache->apc->save('foo', 'bar', 10);
```

--------------------------------

### Installation Instructions

Source: https://github.com/bcit-ci/codeigniter/wiki/SEAuth---Session-Extension-for-Authorization

Provides step-by-step instructions for installing the session extension, including placing files in the correct directories and updating configuration.

```text
1. Install auth.php in to the /application/configs directory 

2. Install MY_Session.php in to the /application/librariess directory

3. Update the config.php according to the directions in the auth.php

4. Setup the session database

```

--------------------------------

### CodeIgniter Error Reporting Check

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/general/styleguide.rst

Provides an example of how to check if display_errors is enabled in PHP, a crucial step for ensuring error-free code execution.

```php
if (ini_get('display_errors') == 1)
{
	exit "Enabled";
}
```

--------------------------------

### OAuthr Library Installation and Configuration

Source: https://github.com/bcit-ci/codeigniter/wiki/Libraries/Oauthr

Instructions for installing the OAuthr library by downloading it from Google Code and extracting it into the application folder. It also mentions the need to configure the 'oauthr.php' file with default settings.

```text
Download the OAuthr library from Google Code: http://code.google.com/p/oauthr/, and extract it into your application folder. Setup the config-file (oauthr.php) to your default settings.
```

--------------------------------

### Typecasting Example

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/general/styleguide.rst

Demonstrates typecasting a variable to a string in PHP. This process converts various data types (NULL, booleans, numbers) into their string representations.

```php
$str = (string) $str; // cast $str as a string
```

--------------------------------

### Git for Version Control

Source: https://github.com/bcit-ci/codeigniter/wiki/Approaches/I-have-the-welcome-page---but-now-what---jedd

Git is a distributed version control system that allows developers to track changes in their code over time. It facilitates easy reverting to previous states and managing project history. Recommended resource: Git for the lazy person.

```git
# Git is insanely easy to set up - pretty much 'git init'
# It's about a half hour to get your head around the basic functions.
# Git lets you easily revert to a 'given point in time copy' assuming you commit regularly.
```

--------------------------------

### CodeIgniter Controller for Xajax Testing

Source: https://github.com/bcit-ci/codeigniter/wiki/Library/Xajax-perfect-setup

A CodeIgniter controller example that loads the Xajax library, registers a function, processes requests, and renders a view with Xajax integration.

```php
class Testxajax extends Controller
{
 
    function Testxajax()
    {
      parent::controller();
      $this->load->library('xajax');
      $this->xajax->registerFunction(array('test_function',&$this,'test_function'));
      $this->xajax->processRequest();
    }
   
    function test_function($number)
    {
      $objResponse = new xajaxResponse();
      $objResponse->Assign("SomeElementId","innerHTML", "Xajax is working. Lets add: ".($number+3));
      return $objResponse;
    }
    function index()
    {
      $template['xajax_js'] = $this->xajax->getJavascript(base_url());
      $template['content'] = '<div id="SomeElementId"></div>&lt;input type="button" value="test"  onclick="xajax_test_function(2);"&gt;';
      $this->load->view('template/index', $template);
     }
   
}
```

--------------------------------

### DX Auth Installation and Download

Source: https://github.com/bcit-ci/codeigniter/wiki/Libraries/DX-Auth

Provides links for downloading and contributing to the DX Auth library. It includes a link for the latest version compatible with CodeIgniter 1.7+ and a link to the GitHub repository.

```text
Contribute on Github
 [[https://github.com/yoosuf/DX-Auth]]

Download for version 1.7+
 [[https://github.com/yoosuf/DX-Auth/zipball/initial]]
```

--------------------------------

### phpdoc Configuration Script

Source: https://github.com/bcit-ci/codeigniter/wiki/Approaches/I-have-the-welcome-page---but-now-what---jedd

A bash script to generate documentation for a CodeIgniter project using phpdoc. It specifies the directories to parse, includes specific library files, sets a default package name, enables private parsing, defines the output directory, and sets the title.

```bash
#!/bin/bash
phpdoc -d /var/www/devel/pdb/app \
        -f /var/www/devel/pdb/system/libraries/Model.php \
        -f /var/www/devel/pdb/system/libraries/Controller.php \
        --defaultpackagename "pdb" \
        --parseprivate \
        -t /var/www/devel/pdbdoc/ \
        -ti DOC-pdb
```

--------------------------------

### Index.php Configuration for Root Site

Source: https://github.com/bcit-ci/codeigniter/wiki/Help/Multiple-Sitessubdomains-for-Single-CI-system

Modifications required for the main index.php file at the root of the CodeIgniter installation to point to the common system folder and the primary application folder.

```php
$systemfolder="CommonCI"
$application="./Application_1"
```

--------------------------------

### String Splitting Example

Source: https://github.com/bcit-ci/codeigniter/blob/develop/user_guide_src/source/general/styleguide.rst

This code snippet demonstrates how to split a string into an array of parts based on newline characters. It's a common operation for processing multi-line strings.

```php
// break up the string by newlines
$parts = explode("\n", $str);
```