blob: d7ca13e85e6f740bb4d034123153ef2362f48265 [file] [log] [blame]
Andrey Andreevd1530022012-03-13 12:31:13 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreevd1530022012-03-13 12:31:13 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevd1530022012-03-13 12:31:13 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * 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
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @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
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * CodeIgniter Directory Helpers
30 *
31 * @package CodeIgniter
32 * @subpackage Helpers
33 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050034 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000035 * @link http://codeigniter.com/user_guide/helpers/directory_helper.html
36 */
37
38// ------------------------------------------------------------------------
39
40/**
41 * Create a Directory Map
42 *
43 * Reads the specified directory and builds an array
Andrey Andreevd1530022012-03-13 12:31:13 +020044 * representation of it. Sub-folders contained with the
Derek Allard2067d1a2008-11-13 22:59:24 +000045 * directory will be mapped as well.
46 *
Derek Allard2067d1a2008-11-13 22:59:24 +000047 * @param string path to source
Andrey Andreevd1530022012-03-13 12:31:13 +020048 * @param int depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
Derek Allard2067d1a2008-11-13 22:59:24 +000049 * @return array
Barry Mienydd671972010-10-04 16:33:58 +020050 */
Derek Allard2067d1a2008-11-13 22:59:24 +000051if ( ! function_exists('directory_map'))
52{
Pascal Kriete98a447a2010-01-07 18:14:28 +000053 function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
54 {
Derek Allard2067d1a2008-11-13 22:59:24 +000055 if ($fp = @opendir($source_dir))
56 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000057 $filedata = array();
58 $new_depth = $directory_depth - 1;
Barry Mienydd671972010-10-04 16:33:58 +020059 $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
60
Derek Allard2067d1a2008-11-13 22:59:24 +000061 while (FALSE !== ($file = readdir($fp)))
62 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000063 // Remove '.', '..', and hidden files [optional]
Andrey Andreevd1530022012-03-13 12:31:13 +020064 if ( ! trim($file, '.') OR ($hidden == FALSE && $file[0] === '.'))
Derek Allard2067d1a2008-11-13 22:59:24 +000065 {
66 continue;
67 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000068
69 if (($directory_depth < 1 OR $new_depth > 0) && @is_dir($source_dir.$file))
Derek Allard2067d1a2008-11-13 22:59:24 +000070 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000071 $filedata[$file] = directory_map($source_dir.$file.DIRECTORY_SEPARATOR, $new_depth, $hidden);
Derek Allard2067d1a2008-11-13 22:59:24 +000072 }
73 else
74 {
75 $filedata[] = $file;
76 }
77 }
Barry Mienydd671972010-10-04 16:33:58 +020078
Derek Allard2067d1a2008-11-13 22:59:24 +000079 closedir($fp);
80 return $filedata;
81 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000082
83 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +000084 }
85}
86
Derek Allard2067d1a2008-11-13 22:59:24 +000087/* End of file directory_helper.php */
Andrey Andreevd1530022012-03-13 12:31:13 +020088/* Location: ./system/helpers/directory_helper.php */