├── .gitignore
├── application
    ├── config
    │   ├── vendorlibs_site.example.php
    │   └── vendorlibs.php
    └── hooks
    │   └── vendorlibs.php
├── README
├── dd-p2.xml
├── INSTALL
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | build
2 | 


--------------------------------------------------------------------------------
/application/config/vendorlibs_site.example.php:
--------------------------------------------------------------------------------
 1 | <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 2 | /**
 3 |  * Override application vendorlibs configuration specific for a site/deployment.
 4 |  */
 5 | 
 6 | /**
 7 |  * Site paths
 8 |  */
 9 | //$config['vendorlibs_site_paths'][] = '/home/someuser/simplepie-trunk';
10 | //$config['vendorlibs_site_paths'][] = '/home/someuser/safsi-exp/lib';
11 | //$config['vendorlibs_site_paths'][] = '/home/someuser/repose-0.5c/lib';
12 | 
13 | /**
14 |  * Individual path maps
15 |  */
16 | // $config['vendorlibs_map']['simplepie'] = '/home/someuser/simplepie-trunk';
17 | // $config['vendorlibs_map']['safsi'] = '/home/someuser/safsi-exp/lib';
18 | // $config['vendorlibs_map']['repose'] = '/home/someuser/repose-0.5c/lib';
19 | 
20 | ?>
21 | 


--------------------------------------------------------------------------------
/README:
--------------------------------------------------------------------------------
 1 | vendorlibs - Dragonfly Development's Vendor Libs CodeIgniter Add-On
 2 | http://code.google.com/p/dd-ci-vendorlibs/
 3 | 
 4 | 
 5 | vendorlibs for CodeIgniter is intended to allow for easily adding third party
 6 | (vendor) libraries to the include path.
 7 | 
 8 | The implementation involves a pre-system hook and a standardized placement
 9 | of vendor libraries.
10 | 
11 |     APPPATH . 'vendors'
12 |     BASEDIR . 'vendors'
13 | 
14 | Every directory inside of either of these two directories will be added
15 | to the PHP include path. For example:
16 | 
17 |     system/application/vendors/fancy-orm/Orm.php
18 | 
19 | In this case, 'system/application/vendors/fancy-orm' will be added to the
20 | include path and one will be able to require 'Orm.php' with either of the
21 | following:
22 | 
23 |     require 'Orm.php';
24 |     require 'fancy-orm/Orm.php';
25 | 
26 | 
27 | Inspired by CakePHP's Vendor concept.
28 | http://book.cakephp.org/view/538/Loading-Vendor-Files
29 | 


--------------------------------------------------------------------------------
/dd-p2.xml:
--------------------------------------------------------------------------------
 1 | <packages xmlns="http://dd-p2.dflydev.com/2010">
 2 |     <package>
 3 |         <version>0.1.1</version>
 4 |         <name>vendorlibs - Dragonfly Development CodeIgniter Vendor Libs Add-on</name>
 5 |         <url>http://code.google.com/p/dd-ci-vendorlibs/</url>
 6 |         <copyright>Copyright (c) 2010 Dragonfly Development</copyright>
 7 |         <license>Licensed under the New BSD License.</license>
 8 |         <files>
 9 |             <file name="README" />
10 |             <file name="LICENSE" />
11 |             <file name="INSTALL" />
12 |             <glob name="configs" pattern="application/config/*.php" />
13 |             <glob name="hooks" pattern="application/hooks/*.php" />
14 |         </files>
15 |         <outputs>
16 |             <output name="dd-ci-vendorlibs">
17 |                 <includeFile name="README" />
18 |                 <includeFile name="LICENSE" />
19 |                 <includeFile name="INSTALL" />
20 |                 <includeGlob name="configs" />
21 |                 <includeGlob name="hooks" />
22 |             </output>
23 |         </outputs>
24 |     </package>
25 | </packages>
26 | 


--------------------------------------------------------------------------------
/INSTALL:
--------------------------------------------------------------------------------
 1 | vendorlibs - Dragonfly Development's Vendor Libs CodeIgniter Add-On
 2 | http://code.google.com/p/dd-ci-vendorlibs/
 3 | 
 4 | 
 5 | Copy the dd-ci-vendorlibs distribution files:
 6 | 
 7 |     cp dd-ci-vendorlibs/application/hooks/vendorlibs.php \
 8 |         system/application/hooks/
 9 | 
10 |     cp dd-ci-vendorlibs/application/config/vendorlibs.php \
11 |         system/application/config/
12 | 
13 |     cp dd-ci-vendorlibs/application/config/vendorlibs_site.example.php \
14 |         system/application/config/
15 | 
16 | Modify path/to/system/application/config/hooks.php and add the following:
17 | 
18 |     $hook['pre_system'][] = array(
19 |         'class' => 'dd_ci_VendorLibs',
20 |         'function' => 'preSystem',
21 |         'filename' => 'vendorlibs.php',
22 |         'filepath' => 'hooks'
23 |     );
24 | 
25 | 
26 | Create a system and/or application vendors folders.
27 | 
28 | For libraries used by potentially more than one CodeIgniter application, create
29 | a vendors/lib folder under BASEDIR:
30 | 
31 |     mkdir -p path/to/your/system/vendors/lib
32 | 
33 | 
34 | For libraries used by a specific application, create a vendors/lib folder under
35 | APPPATH:
36 | 
37 |     mkdir -p path/to/your/system/application/vendors/lib
38 | 
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2010, Dragonfly Development Inc 
 2 | All rights reserved. 
 3 | 
 4 | Redistribution and use in source and binary forms, with or without 
 5 | modification, are permitted provided that the following conditions are met: 
 6 | 
 7 |  * Redistributions of source code must retain the above copyright notice, 
 8 |    this list of conditions and the following disclaimer. 
 9 |  * Redistributions in binary form must reproduce the above copyright 
10 |    notice, this list of conditions and the following disclaimer in the 
11 |    documentation and/or other materials provided with the distribution. 
12 |  * Neither the name of Dragonfly Development Inc nor the names of its 
13 |    contributors may be used to endorse or promote products derived from 
14 |    this software without specific prior written permission. 
15 | 
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
17 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
18 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
19 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
20 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
21 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
22 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
23 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
24 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
25 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
26 | POSSIBILITY OF SUCH DAMAGE.
27 | 


--------------------------------------------------------------------------------
/application/hooks/vendorlibs.php:
--------------------------------------------------------------------------------
 1 | <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 2 | /**
 3 |  * CodeIgniter VendorLibs Add-on
 4 |  * @package vendorlibs
 5 |  */
 6 | 
 7 | /**
 8 |  * CodeIgniter Vendor Libs
 9 |  * @package vendorlibs
10 |  */
11 | class dd_ci_VendorLibs {
12 | 
13 |     /**
14 |      * Read directories at path
15 |      * @param string $path Path
16 |      * @return array Paths
17 |      */
18 |     function readDirs($path) {
19 |         $paths = array();
20 |         $vendorsPath = $path . 'vendors';
21 |         if ( $vendorsPath and file_exists($vendorsPath) ) {
22 |             $handle = opendir($vendorsPath);
23 |             while (false !== ($file = readdir($handle))) {
24 |                 if ( preg_match('/\.+$/', $file) ) continue;
25 |                 $subPath = $vendorsPath . '/' . $file;
26 |                 if ( is_dir($subPath) ) {
27 |                     $paths[] = $subPath;
28 |                 }
29 |             }
30 |             closedir($handle);
31 |             $paths[] = $vendorsPath;
32 |         }
33 |         return $paths;
34 |     }
35 | 
36 |     /**
37 |      * Pre System hook
38 |      *
39 |      * Will scan the vendors directories for additional directories
40 |      * to be added to the include_path.
41 |      *
42 |      * http://codeigniter.com/user_guide/general/hooks.html
43 |      */
44 |     function preSystem() {
45 | 
46 |         $CFG =& load_class('Config');
47 |         $CFG->load('vendorlibs', null, true);
48 | 
49 |         $allPaths = array();
50 | 
51 |         $allPaths[] = $CFG->item('vendorlibs_site_paths');
52 |         $allPaths[] = $CFG->item('vendorlibs_paths');
53 | 
54 |         $allPaths[] = array_values($CFG->item('vendorlibs_map'));
55 | 
56 |         if ( $CFG->item('vendorlibs_scan') ) {
57 |             $allPaths[] = $this->readDirs(APPPATH);
58 |             $allPaths[] = $this->readDirs(BASEPATH);
59 |         } else {
60 |             $staticVendors = array();
61 |             foreach ( $CFG->item('vendorlibs_vendors') as $vendor ) {
62 |                 $vendorApp = APPPATH . 'vendors/' . $vendor;
63 |                 $vendorBase = BASEPATH . 'vendors/' . $vendor;
64 |                 if ( file_exists($vendorApp) ) $staticVendors[] = $vendorApp;
65 |                 if ( file_exists($vendorBase) ) $staticVendors[] = $vendorBase;
66 |             }
67 |             $allPaths[] = $staticVendors;
68 |         }
69 | 
70 |         $allPaths[] = explode(PATH_SEPARATOR, get_include_path());
71 |         $allPathsFinal = array('.');
72 |         foreach ( $allPaths as $allPathsPart ) {
73 |             foreach ( $allPathsPart as $path ) {
74 |                 if ( $path != '.' ) $allPathsFinal[] = $path;
75 |             }
76 |         }
77 | 
78 |         set_include_path(implode(PATH_SEPARATOR, $allPathsFinal));
79 | 
80 |     }
81 | 
82 | }
83 | ?>
84 | 


--------------------------------------------------------------------------------
/application/config/vendorlibs.php:
--------------------------------------------------------------------------------
  1 | <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');
  2 | 
  3 | /**
  4 |  * Automatically scan vendor directory
  5 |  *
  6 |  * If set to true (default), APPPATH . 'vendors' and BASEDIR . 'vendors'
  7 |  * are scanned and added to the include path automatically.
  8 |  *
  9 |  * This has the potential to impact performance so disabling this may be
 10 |  * appropriate in some cases if other vendorlibs features are used instead.
 11 |  */
 12 | $config['vendorlibs_scan'] = true;
 13 | 
 14 | /**
 15 |  * Paths, Maps and Vendors
 16 |  *
 17 |  * In general, there are three types of settings for vendorlibs.
 18 |  *
 19 |  * Paths are used when specifying an array of paths to third-party libraries.
 20 |  * This is a good general case, though in development enviornment this could
 21 |  * lead to potential bloat of the include path if many vendor libraries are
 22 |  * used and many or all of them have site overrides.
 23 |  *
 24 |  * Maps are used if there is a preference to specify paths in such a way
 25 |  * that the site configuration can override specific paths based on names.
 26 |  * This can be useful if there are many vendor libraries specified and
 27 |  * it is not desired to have the include path bloated in dev environment
 28 |  * with many overrides.
 29 |  *
 30 |  * Vendors are used if scanning has been disabled ('vendorlibs_scan' = false)
 31 |  * and a fixed list of vendor entries are desired. The values on this array
 32 |  * will have APPPATH . 'vendors' and BASEDIR . 'vendors' appended to them.
 33 |  *
 34 |  * Include paths will be built in the following order:
 35 |  *
 36 |  *  - .
 37 |  *  - paths 
 38 |  *  - maps 
 39 |  *  - vendors (scanned or specified)
 40 |  *  - original include path
 41 |  *
 42 |  */
 43 | 
 44 | /**
 45 |  * Site paths
 46 |  *
 47 |  * These should generally only be set in the vendorlibs_site.php file
 48 |  * on a site-by-site basis.
 49 |  */
 50 | $config['vendorlibs_site_paths'] = array();
 51 | 
 52 | /**
 53 |  * Paths
 54 |  *
 55 |  * In general, it would be good to set specific paths here for the
 56 |  * "usual" case (i.e., production environment) and in special cases
 57 |  * (i.e., dev enviornment) add their override paths to the
 58 |  * 'vendorlibs_site_paths' configuration.
 59 |  *
 60 |  * Example:
 61 |  *
 62 |  * $config['vendorlibs_paths'] = array(
 63 |  *     '/opt/rmccue-SimplePie-9a1ebc0',
 64 |  *     '/opt/safsi-1.2/lib',
 65 |  *     '/opt/repose-0.5b/lib'
 66 |  * );
 67 |  *
 68 |  */
 69 | $config['vendorlibs_paths'] = array();
 70 | 
 71 | /**
 72 |  * Vendor library map
 73 |  *
 74 |  * Maps a name to a path. Useful for adding specific paths for specific
 75 |  * projects that can be easily overridden in a development environment.
 76 |  */
 77 | $config['vendorlibs_map'] = array();
 78 | 
 79 | /**
 80 |  * Individual path maps
 81 |  */
 82 | // $config['vendorlibs_map']['simplepie'] = '/opt/rmccue-SimplePie-9a1ebc0';
 83 | // $config['vendorlibs_map']['safsi'] = '/opt/safsi-1.2/lib';
 84 | // $config['vendorlibs_map']['repose'] = '/opt/repose-0.5b/lib';
 85 | 
 86 | /**
 87 |  * Vendor paths
 88 |  *
 89 |  * This configuration is ignored unless 'vendorlibs_scan' is set to false
 90 |  * as it would not make sense.
 91 |  *
 92 |  * These values will have APPPATH . 'vendors' and BASEDIR . 'vendors'
 93 |  * prepended. This is useful if it is perceived that scanning the vendors
 94 |  * folder would take too much time.
 95 |  */
 96 | $config['vendorlibs_vendors'] = array();
 97 | 
 98 | // Include site-specific vendorlibs configuration if it exists.
 99 | $siteConfig = APPPATH.'config/vendorlibs_site'.EXT;
100 | if ( file_exists($siteConfig) ) include($siteConfig);
101 | 
102 | ?>
103 | 


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