blob: 73777bfb54f1597977b0bf45f3cc173f715e6c10 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreevd1530022012-03-13 12:31:13 +02008 *
Instructor, BCIT0e59db62019-01-01 08:34:36 -08009 * Copyright (c) 2014 - 2019, British Columbia Institute of Technology
Andrey Andreevd1530022012-03-13 12:31:13 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Derek Jonesf4a4bd82011-10-20 12:18:42 -050017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Instructor, BCIT0e59db62019-01-01 08:34:36 -080032 * @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
33 * @license https://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 1.0.0
Derek Allard2067d1a2008-11-13 22:59:24 +000036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000039
Derek Allard2067d1a2008-11-13 22:59:24 +000040/**
41 * CodeIgniter Directory Helpers
42 *
43 * @package CodeIgniter
44 * @subpackage Helpers
45 * @category Helpers
Derek Jonesf4a4bd82011-10-20 12:18:42 -050046 * @author EllisLab Dev Team
Andrey Andreevbd202c92016-01-11 12:50:18 +020047 * @link https://codeigniter.com/user_guide/helpers/directory_helper.html
Derek Allard2067d1a2008-11-13 22:59:24 +000048 */
49
50// ------------------------------------------------------------------------
51
Derek Allard2067d1a2008-11-13 22:59:24 +000052if ( ! function_exists('directory_map'))
53{
Timothy Warren01b129a2012-04-27 11:36:50 -040054 /**
55 * Create a Directory Map
56 *
57 * Reads the specified directory and builds an array
58 * representation of it. Sub-folders contained with the
59 * directory will be mapped as well.
60 *
Andrey Andreevba77f8a2012-11-06 15:40:48 +020061 * @param string $source_dir Path to source
62 * @param int $directory_depth Depth of directories to traverse
63 * (0 = fully recursive, 1 = current dir, etc)
64 * @param bool $hidden Whether to show hidden files
Timothy Warren01b129a2012-04-27 11:36:50 -040065 * @return array
66 */
Pascal Kriete98a447a2010-01-07 18:14:28 +000067 function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
68 {
Derek Allard2067d1a2008-11-13 22:59:24 +000069 if ($fp = @opendir($source_dir))
70 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000071 $filedata = array();
72 $new_depth = $directory_depth - 1;
Barry Mienydd671972010-10-04 16:33:58 +020073 $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
74
Derek Allard2067d1a2008-11-13 22:59:24 +000075 while (FALSE !== ($file = readdir($fp)))
76 {
Pascal Kriete98a447a2010-01-07 18:14:28 +000077 // Remove '.', '..', and hidden files [optional]
vlakoff82808852012-09-13 05:19:59 +020078 if ($file === '.' OR $file === '..' OR ($hidden === FALSE && $file[0] === '.'))
Derek Allard2067d1a2008-11-13 22:59:24 +000079 {
80 continue;
81 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000082
Andrey Andreev382b5132014-02-26 18:41:59 +020083 is_dir($source_dir.$file) && $file .= DIRECTORY_SEPARATOR;
Andrey Andreeve8b89042012-11-06 15:50:17 +020084
Andrey Andreev382b5132014-02-26 18:41:59 +020085 if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir.$file))
Derek Allard2067d1a2008-11-13 22:59:24 +000086 {
Andrey Andreevba77f8a2012-11-06 15:40:48 +020087 $filedata[$file] = directory_map($source_dir.$file, $new_depth, $hidden);
Derek Allard2067d1a2008-11-13 22:59:24 +000088 }
89 else
90 {
91 $filedata[] = $file;
92 }
93 }
Barry Mienydd671972010-10-04 16:33:58 +020094
Derek Allard2067d1a2008-11-13 22:59:24 +000095 closedir($fp);
96 return $filedata;
97 }
Pascal Kriete98a447a2010-01-07 18:14:28 +000098
99 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000100 }
101}