Source for file FileUtil.php

Documentation is available at FileUtil.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. /**
  19.  * ディレクトリ・ファイル操作クラス
  20.  *
  21.  * @package     teeple
  22.  */
  23. class Teeple_FileUtil
  24. {
  25.     /**
  26.      * include_pathからファイルを検索し、絶対パスの形で返す
  27.      * 見つからなかった場合はfalseを返す
  28.      * 
  29.      * @author  Hawk <scholar@hawklab.jp>
  30.      * @since   3.2.0
  31.      * @return  String or false
  32.      */
  33.     function findIncludableFile($path)
  34.     {
  35.         if (!is_array($include_paths = explode(PATH_SEPARATOR, get_include_path()))) {
  36.             return realpath($path);
  37.         }
  38.         
  39.         foreach ($include_paths as $include_path) {
  40.             if (($realpath = realpath($include_path . DIRECTORY_SEPARATOR . $path)) !== false) {
  41.                 return $realpath;
  42.             }
  43.         }
  44.         return false;
  45.     }
  46.  
  47.     /**
  48.      * ファイルを読み込む
  49.      *
  50.      * ファイルを読み込んで一つの文字列として返す。
  51.      *
  52.      * @param string $fileName  ファイル名
  53.      * @return string  ファイルの内容
  54.      * @access public
  55.      */
  56.     function read($fileName)
  57.     {
  58.         $buf = '';
  59.         if (file_exists($fileName)) {
  60.             if (function_exists('file_get_contents')) {
  61.                 $buf = file_get_contents($fileName);
  62.             } else {
  63.                 $fh = fopen($fileName, "rb");
  64.                 $buf = fread($fh, filesize($fileName));
  65.                 fclose($fh); 
  66.             }
  67.         }
  68.         return $buf;
  69.     }
  70.  
  71.     /**
  72.      * ファイルに追記する
  73.      *
  74.      * 指定した内容をファイルに追記で書き込む。
  75.      * 途中のフォルダが存在しない場合は自動的に作成する。
  76.      *
  77.      * @param string $fileName  ファイル名
  78.      * @param string $buf  書き込む内容
  79.      * @return boolean 
  80.      * @access public
  81.      */
  82.     function append($fileName, $buf)
  83.     {
  84.         return self::write($fileName, $buf, "ab");
  85.     }
  86.  
  87.     /**
  88.      * ファイルに書き込む
  89.      *
  90.      * 指定した内容をファイルに上書きで書き込む。
  91.      * 途中のフォルダが存在しない場合は自動的に作成する。
  92.      *
  93.      * @param string $fileName  ファイル名
  94.      * @param string $buf  書き込む内容
  95.      * @param string $mode  書き込みモード
  96.      * @return boolean 
  97.      * @access public
  98.      */
  99.     function write($fileName, $buf, $mode = "wb")
  100.     {
  101.         self::makeDir(dirname($fileName));
  102.         
  103.         if (!($fh = fopen($fileName, $mode))) {
  104.             return false;
  105.         }
  106.         if (!fwrite($fh, $buf)) {
  107.             return false;
  108.         }
  109.         if (!fclose($fh)) {
  110.             return false;
  111.         }
  112.         return true;
  113.     }
  114.  
  115.     /**
  116.      * ディレクトリを作成する。
  117.      * 
  118.      * 複数階層のディレクトリを指定した場合に、
  119.      * 途中のディレクトリも自動的に作成する。
  120.      * 
  121.      * @param mixed $dirNames  作成するディレクトリ名、またはその配列
  122.      * @access public
  123.      */
  124.     function makeDir($dirNames)
  125.     {
  126.         if (!is_array($dirNames)) {
  127.             $dirNames = array($dirNames);
  128.         }
  129.         
  130.         foreach($dirNames as $dir){
  131.             self::_makeDir($dir);
  132.         }
  133.     }
  134.  
  135.     /**
  136.      * ディレクトリを削除する
  137.      *
  138.      * 指定したディレクトリより下のディレクトリ・ファイルも
  139.      * 自動的に削除する。
  140.      *
  141.      * @param mixed $dirNames  削除するディレクトリ名、またはその配列
  142.      * @access public
  143.      */
  144.     function removeDir($dirNames)
  145.     {
  146.         if (!is_array($dirNames)) {
  147.             $dirNames = array($dirNames);
  148.         }
  149.         
  150.         foreach($dirNames as $dir){
  151.             self::_removeDir($dir);
  152.         }
  153.     }
  154.  
  155.     /**
  156.      * ディレクトリとファイルのリストを取得する
  157.      *
  158.      * 返値は配列で、最初がディレクトリの配列、次にファイルの配列となる。
  159.      * list($dirs, $files) = self::ls($dirname);
  160.      *
  161.      * @param string $dirName  ディレクトリ名
  162.      * @return array  ディレクトリとファイルの配列
  163.      * @access public
  164.      */
  165.     function ls($dirName)
  166.     {
  167.         if (!$dh = @opendir($dirName)) {
  168.             return false;
  169.         }
  170.  
  171.         $dirs = $files = array();
  172.         while (($file = readdir($dh)) !== false) {
  173.             if (preg_match("/^[.]{1,2}$/", $file)) {
  174.                 continue;
  175.             }
  176.             $fullPath = self::_addTail($dirName, DIRECTORY_SEPARATOR).$file;
  177.             if (is_dir($fullPath)) {
  178.                 $dirs[] = $fullPath;
  179.             } else {
  180.                 $files[] = $fullPath;
  181.             }
  182.         }
  183.         closedir($dh);
  184.         return array($dirs, $files);
  185.     }
  186.  
  187.     /**
  188.      * 指定したディレクトリのファイルリストを取得する
  189.      *
  190.      * @param string $dirName  ディレクトリ名
  191.      * @param string [$regex]  取得するファイル名の正規表現
  192.      * @return array  ファイルの配列
  193.      * @access public
  194.      */
  195.     function find($dirName, $regex = "")
  196.     {
  197.         $data = self::ls($dirName);
  198.         if (!is_array($data)) {
  199.             return array();
  200.         }
  201.         list($dirs, $files) = $data;
  202.  
  203.         if ($regex == "") {
  204.             return $files;
  205.         }
  206.         $found = array();
  207.         foreach ($files as $file) {
  208.             if (preg_match($regex, basename($file))) {
  209.                 $found[] = $file;
  210.             }
  211.         }
  212.         return $found;
  213.     }
  214.  
  215.     /**
  216.      * 指定したディレクトリのファイルリストを取得する
  217.      * 
  218.      * サブディレクトリがある場合は再帰的に取得する
  219.      *
  220.      * @param string $dirName  ディレクトリ名
  221.      * @param string [$regex]  取得するファイル名の正規表現
  222.      * @return array  ファイルの配列
  223.      * @access public
  224.      */
  225.     function findRecursive($dirName, $regex = "")
  226.     {
  227.         $data = self::ls($dirName);
  228.         if (!is_array($data)) {
  229.             return array();
  230.         }
  231.         list($dirs, $files) = $data;
  232.         
  233.         $found = self::find($dirName, $regex);
  234.  
  235.         foreach ($dirs as $dir) {
  236.             $found = array_merge($found, self::findRecursive($dir, $regex));
  237.         }
  238.  
  239.         return $found;
  240.     }
  241.  
  242.     /**
  243.      * ディレクトリを作成する。
  244.      *
  245.      * 親ディレクトリがなければ自動的に作成する。
  246.      *
  247.      * @param string $dirName  ディレクトリ名
  248.      * @access private
  249.      */
  250.     function _makeDir($dirName)
  251.     {
  252.         $dirstack = array();
  253.         while (!@is_dir($dirName) && $dirName != DIRECTORY_SEPARATOR) {
  254.  
  255.             array_unshift($dirstack, $dirName);
  256.             $dirName = dirname($dirName);
  257.         }
  258.         while ($newdir = array_shift($dirstack)) {
  259.             mkdir($newdir);
  260.         }
  261.     }
  262.  
  263.     /**
  264.      * ディレクトリを削除する
  265.      *
  266.      * サブディレクトリがあれば自動的に削除する。
  267.      * 指定したディレクトリ以下のファイルも自動的に削除する。
  268.      *
  269.      * @param string $dirName  ディレクトリ名
  270.      * @access private
  271.      */
  272.     function _removeDir($dirName)
  273.     {
  274.         $data = self::ls($dirName);
  275.         if (!is_array($data)) {
  276.             return;
  277.         }
  278.         list($dirs, $files) = $data;
  279.         
  280.         if (is_dir($dirName)) {
  281.             array_unshift($dirs, $dirName);
  282.         }
  283.  
  284.         foreach($files as $file){
  285.             if (file_exists($file)) {
  286.                 unlink($file);
  287.             }
  288.         }
  289.  
  290.         foreach(array_reverse($dirs) as $dir){
  291.             if (file_exists($dir)) {
  292.                 rmdir($dir);
  293.             }
  294.         }
  295.     }
  296.  
  297.     /**
  298.      * 文字列の末尾に文字列を追加する
  299.      *
  300.      * 文字列の後ろが追加する文字列と同じ場合は
  301.      * 何もしません。
  302.      * 
  303.      * @param string $target  追加対象の文字列
  304.      * @param string $add  追加する文字列
  305.      * @return string 変換後の文字列
  306.      * @access private
  307.      */
  308.     function _addTail($target, $add)
  309.     {
  310.         $regex = preg_quote($add);
  311.         if (!preg_match("|.*{$regex}$|", $target)) {
  312.             $target = $target.$add;
  313.         }
  314.         return $target;
  315.     }
  316. }
  317. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:47 +0900 by phpDocumentor 1.4.3