blob: e90c92d79f0d94a98eee9216a43b14641c32273f [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
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 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * CodeIgniter Directory Helpers
31 *
32 * @package CodeIgniter
33 * @subpackage Helpers
34 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050035 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @link http://codeigniter.com/user_guide/helpers/directory_helper.html
37 */
38
39// ------------------------------------------------------------------------
40
Derek Allard2067d1a2008-11-13 22:59:24 +000041if ( ! function_exists('directory_map'))
42{
Timothy Warren01b129a2012-04-27 11:36:50 -040043 /**
44 * Create a Directory Map
45 *
46 * Reads the specified directory and builds an array
47 * representation of it. Sub-folders contained with the
48 * directory will be mapped as well.
49 *
Andrey Andreevba77f8a2012-11-06 15:40:48 +020050 * @param string $source_dir Path to source
51 * @param int $directory_depth Depth of directories to traverse
52 * (0 = fully recursive, 1 = current dir, etc)
53 * @param bool $hidden Whether to show hidden files
Timothy Warren01b129a2012-04-27 11:36:50 -040054 * @return array
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]
vlakoff82808852012-09-13 05:19:59 +020067 if ($file === '.' OR $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 {
Andrey Andreevba77f8a2012-11-06 15:40:48 +020074 $file .= DIRECTORY_SEPARATOR;
75 $filedata[$file] = directory_map($source_dir.$file, $new_depth, $hidden);
Derek Allard2067d1a2008-11-13 22:59:24 +000076 }
77 else
78 {
79 $filedata[] = $file;
80 }
81 }
Barry Mienydd671972010-10-04 16:33:58 +020082
Derek Allard2067d1a2008-11-13 22:59:24 +000083 closedir($fp);
84 return $filedata;
85 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000086
87 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +000088 }
89}
90
Derek Allard2067d1a2008-11-13 22:59:24 +000091/* End of file directory_helper.php */
Andrey Andreeve92df332012-03-26 22:44:20 +030092/* Location: ./system/helpers/directory_helper.php */