blob: cb37446f8b28be1c60976a1e26a2a2344896db20 [file] [log] [blame]
Derek Jones37f4b9c2011-07-01 17:56:50 -05001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
8 *
9 * Licensed under the Open Software License version 3.0
10 *
11 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
21 * @copyright Copyright (c) 2008 - 2011, EllisLab, Inc. (http://ellislab.com/)
22 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
28// ------------------------------------------------------------------------
29
30/**
31 * CodeIgniter Directory Helpers
32 *
33 * @package CodeIgniter
34 * @subpackage Helpers
35 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050036 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000037 * @link http://codeigniter.com/user_guide/helpers/directory_helper.html
38 */
39
40// ------------------------------------------------------------------------
41
42/**
43 * Create a Directory Map
44 *
45 * Reads the specified directory and builds an array
Derek Jones37f4b9c2011-07-01 17:56:50 -050046 * representation of it. Sub-folders contained with the
Derek Allard2067d1a2008-11-13 22:59:24 +000047 * directory will be mapped as well.
48 *
49 * @access public
50 * @param string path to source
Pascal Kriete98a447a2010-01-07 18:14:28 +000051 * @param int depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
Derek Allard2067d1a2008-11-13 22:59:24 +000052 * @return array
Barry Mienydd671972010-10-04 16:33:58 +020053 */
Derek Allard2067d1a2008-11-13 22:59:24 +000054if ( ! function_exists('directory_map'))
55{
Pascal Kriete98a447a2010-01-07 18:14:28 +000056 function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
57 {
Derek Allard2067d1a2008-11-13 22:59:24 +000058 if ($fp = @opendir($source_dir))
59 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000060 $filedata = array();
61 $new_depth = $directory_depth - 1;
Barry Mienydd671972010-10-04 16:33:58 +020062 $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
63
Derek Allard2067d1a2008-11-13 22:59:24 +000064 while (FALSE !== ($file = readdir($fp)))
65 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000066 // Remove '.', '..', and hidden files [optional]
67 if ( ! trim($file, '.') OR ($hidden == FALSE && $file[0] == '.'))
Derek Allard2067d1a2008-11-13 22:59:24 +000068 {
69 continue;
70 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000071
72 if (($directory_depth < 1 OR $new_depth > 0) && @is_dir($source_dir.$file))
Derek Allard2067d1a2008-11-13 22:59:24 +000073 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000074 $filedata[$file] = directory_map($source_dir.$file.DIRECTORY_SEPARATOR, $new_depth, $hidden);
Derek Allard2067d1a2008-11-13 22:59:24 +000075 }
76 else
77 {
78 $filedata[] = $file;
79 }
80 }
Barry Mienydd671972010-10-04 16:33:58 +020081
Derek Allard2067d1a2008-11-13 22:59:24 +000082 closedir($fp);
83 return $filedata;
84 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000085
86 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +000087 }
88}
89
90
91/* End of file directory_helper.php */
Derek Jonesa3ffbbb2008-05-11 18:18:29 +000092/* Location: ./system/helpers/directory_helper.php */