フォルダ関連のライブラリについてアドバイスしてもらえないでしょうか？

Question

phpのフォルダ関連の操作がそのままだと少し面倒な感じがしたので
自分でライブラリのようなものを作りたいと思いました。
------------------------------------------------------------------------------------------
calss My_Directory {
    const SIZE_FORMAT_B = 0;
    const SIZE_FORMAT_KB = 1;
    const SIZE_FORMAT_MB = 2;
    const SIZE_FORMAT_GB = 3;

// フォルダへのパスを指定してオブジェクトを作成。
    __construct($dir_path);

// フォルダのサイズを取得。$recursiveがtrueで再帰的に全階層のファイルを調べる。
    getSize($recursive = true, $sizeFormat = self::SIZE_FORMAT_B, $round = 2);

// フォルダの削除。中に入っているファイルも削除される。
    delete();

// フォルダに入っているファイル名を取得。$recursiveがtrueで再帰的に全階層のファイル名を取得。
    // その場合、配列の配列形式にする。
    getFileNames($recursive = true);
}

$path = 'C:\myfolder';// ローカル環境
$dir_obj = new My_Directory($path);

echo $dir_obj->getSize(true, My_Directory::SIZE_FORMAT_MB, 1).'MB';// 例えば、「22.3MB」と表示される

print_r($dir_obj->getFileNames());
/*例えば、
Array
(
    [0] => file_1
    [1] => file_2
    [2] => file_3
    [sub_dir] => Array
        (
            [0] => sub_dir_file_1
            [1] => sub_dir_file_2
            [sub_sub_dir] => Array
                (
                    [0] => sub_sub_dir_file_1
                )

)

)
でも結局foreachのループで再帰的に調べることになるから、やっぱりめんどうだなぁ・・・
*/

$dir_obj->delete();// myfolderが削除される
------------------------------------------------------------------------------------------

ただ、deleteした後にgetSizeとか実行した場合に、
例外を投げればいいのかなぁと考えたりしたのですが、
そもそもオブジェクトにして扱うこと自体が適切なのかどうか？
だからフォルダ関連のライブラリがあまり存在しないのかなと思ったりしたのですが、
今回のようにライブラリを作ることに対してのアドバイス（自分ならこうするとか、ここはそんな風にやらないとか）
など些細なこともでいいので教えてもらいたいです。

hogehoge78 · Accepted Answer

path = $dir; $this->resource = opendir($dir); if(!$this->resource) throw new Exception("test2"); } public function getPath(){ return $this->path; } public function getBase(){ return basename($this->path); } public function isDir(){ return true; } public function isFile(){ return false; } public function rewind(){ rewinddir($this->resource); $this->count = -1; $this->current = $this->get(); } public function current(){ return $this->current; } public function next(){ $this->current = $this->get(); return $this->current; } public function valid(){ return $this->current === false ? false : true; } public function key(){ return $this->count; } private function get(){ while(($data = readdir($this->resource)) !== false){ if($data == "." || $data == "..") continue; break; } if($data === false){ return false; } $this->count++; $data = $this->path . DIRECTORY_SEPARATOR . $data; if(is_dir($data)){ $obj = new self($data); }else{ $obj = new Lib_File($data); } return $obj; } } class Lib_File implements Lib_Directory{ private $path = null; public function __construct($path){ if(is_dir($path)) throw new Exception("test3"); $path = realpath($path); $this->path = $path; } public function getPath(){ return $this->path; } public function getBase(){ return basename($this->path); } public function isDir(){ return false; } public function isFile(){ return true; } } echo "

";
toArray('../cpn', $ret);
print_r($ret);
echo "

"; functi

hogehoge78 · Answer

RecursiveIteratorIteratorなど、Iterator群は、情報が薄いので情報を開いてみたことがなかったんですが、（Iteratorは結構使いますが）
実際マニュアル見ても、やっぱり情報が薄くてよくわかりませんね。

interface Zend_Directory_Interface
{
public function getSize();
public function delete();
}
interface Zend_Iterator_Directory_Interface
{
public function getPath();
public function isDir();
public function isFile();
}

は、Zend_Iterator_Directory_Interfaceに分ける必要がないと思います。
上記に配置しているメソッドはとくにIterationに関係ある項目ではないので。
上記は、Zend_Directory_Interfaceに集約してしまって良いのではないですか。

Zend_Directory_Folderには、これに加えて、Iteratorインターフェイスを実装してやれば。
で、もし、RecureserveIteratorIteratorを使うなら、恐らく、
http://www.php.net/manual/ja/class.recursiveiterator.php
こちらの、RecursiveIteratorを実装する必要がありそうですね。

class xxx_Folder implements RecursiveIterator{

public function getChildren(){

return $this->current();
//で恐らくいいのかな。多分。

}

public function hasChildren(){

$obj = $this->current();

return !$obj->isFile();

}

//以下は前回私の書いた実装

}

もし、Folder自体にIteratorインターフェイスを実装しないなら、

class xxx_Folder implements IteratorAggregate{

public function getIterator(){

//後は、RecureserveIteratorIteratorなりをreturnすれば良いと。

}

とりあえず私は無計画に作っては消して作っては消してといつもつくっちゃうので、今ぱっぱとベストだ、といえる実装は思いつきませんが、何度か色々なプロトタイプ作って消して、マージしていけば良いのではないでしょうか。

hogehoge78 · Answer

どうしてもZend_Iterator_Directoryとかがアレだということであれば、
Zend_Directory_Directory(またはFolder）
Zend_Directory_Fileなどとしてもよいわけで。

また、別々のディレクトリに切り分けることに違和感があるとのことですが、
Zend_Formは、Zend_Form_Elementが、Zend_Validate_Interface継承オブジェクトだったりしてます。
Zend_Service_***系統も、内容はといえば、Zend_Http_Clientに各パラメータを振り分けて通信させてレスポンスを返します。
そう考えれば、Fileクラスにファイル名を渡せばファイルを処理することが出来るわけですから、別の切り分け方をしても何ら問題はない気がします。

尚、もし、私がライブラリの開発をするなら、Zendというプリフィックスは使わないと思います。
私はZendのライブラリ制作者ではないので。

もしやるなら
・PEARやOpenPearのなかで近いライブラリのもののプリフィックスをつける
・全然関係ない名称を使う（Moochy、Doctrine、Smartyなどのような固有名詞的なものとか）

といったところでしょうか。

hogehoge78 · Answer

一応作ってみたので、下記に書き込んでみました。

途中で切れているのは、ディレクトリ構造を配列に直して出力してテストするだけなので
無視してかまいません。

とりあえず見てみてください。

hogehoge78 · Answer

ディレクトリと、フォルダは、ほぼ等価の意味を持っていますが、
今回、カレントのディレクトリを指定した時の中の情報として、フォルダを扱うクラスとファイルを扱うクラスがありますので、まぁ、大きな分類としてディレクトリ操作一般を扱うものの中の、フォルダのみを扱うものとファイルのみを扱うものという意味で、ディレクトリ、という分類の中にフォルダとファイルとしただけだったんですが、気持ち悪ければ、また別の場所にすれば良いと思います。

Zend_Iterator_Folder
Zend_Control_File
とか。
フォルダという言葉が気持ち悪ければ
Zend_Iterator_Directory_Directoryとか。
そこら辺のセンスはまた別に必要になりますし、私はあまりセンスのある方ではないので、よくわかりません。

Zend_Iterator_Directoryインターフェイスは、とりあえずそのカテゴリに存在するフォルダクラスとファイルクラスの共通項なので、今パッと思いつくのは、
・getPath
・delete等操作をするクラス
・isFile(またはisDirとか)

じゃないですかね。最終的にforeachでまわして一つづつ取得していったときに、両方に実装されていないと困るメソッドをインターフェイスで縛りを入れてやるというモノになります。

また、質問者さんの記述したクラスの内容で問題なさそうですが
インスタンスでは、opendir関数が吐き出すリソースを受け取るだけにして、
nextやcurrentで、ポインタを一つすすめるようにしたほうが良いのではないですか。

class XXXXX{

protected $res = null;

public function __construct($path){

$this->res = opendir($path);

if(!$this->res) throw new Exception("can not read");

}

protected $tmp = null;

public function next(){

$this->tmp = readdir($this->res);

}

public function current(){

return $this->tmp;

}

public function __destruct(){

closedir($this->res);

}

とか。

hogehoge78 · Answer

Zend/Iterator/Directory/File

とした場合に、私がFileに記述する内容は、
単純にファイルの構造が記述されているようなものですかね。
（getSizeメソッドとかそういうもの。）
Iteratorじゃないので、そこに記述するのが気持ち悪いなら、まぁ
Zend/File
とか、そういう感じになるんじゃないですかね？

ラッパークラスのほうは、たとえば、単純に「再帰的にルート以下のディレクトリ構成を配列にしたい」とかなら、
Zend/Directory/Treeとか
Zend/Tree/Directoryとか

なんかそういう感じのものにすればいいんじゃないのかなぁとか。（これも実際どうだろうなぁ。）

Zend_Iterator_Directory_Folderと
Zend_Iterator_Directory_Fileは

Zend_Iterator_Directoryインターフェイスを継承したクラス、とかにする感じですかね。
Floderのほうは、自身の持っているファイルやフォルダを順繰りに取得が出来て、Fileのほうは、ファイルの詳細情報が表示できるようなものと考えました。

で、既存のDirectoryIteratorは、ディレクトリのイテレータなので、フォルダとファイルが両方混ざって吐き出されてくるし、再帰的に何かやるときには、ディレクトリの名称なのであればそこで再度new DirectoryIteratorしてやらないといけないし（RecursiveDirectoryIteratorというのもあるようですけど）
質問者さんが目指したい方向と違いがあったりしませんか。
（しないのであれば素直にDirectoryIteratorを使うべきですが）

また、deleteメソッドを実装するとしてましたが、これも、Iterator_Directoryは、閲覧のみとして、操作関連に関しては、Zend_Control_Directoryとか別のオブジェクトで操作させるという方法でもいい気がします。

まぁ、お急ぎでないのであれば、ネーミングとかディレクトリ構成とかそういうのは全部おいておいて
仮のネーミング等で実装したい機能とか全部つめたクラスを作り上げてから、リファクタリングとかするほうがいい気がします。

hogehoge78 · Answer

あ、ラッパークラスの置き場については、
まぁまた別のディレクトリきって配置すればよいと思います。

Zend_Formも、Zend_ValidateとかZend_Decoratorとか組み合わせてますし。

hogehoge78 · Answer

ちょっと私も、英語が苦手で、あまりベストな名前がつけられないので、答えようがないというところなんですけど、

Zendの場合

{Prefix(Zend固定)}_{動詞}_{具体的な名前}
という、名前のクラス名になると思います。
で、FolderもFileも、種類が違うだけで同列と考えると
Zend_Search_Folder
Zend_Search_File

とか、なるんですか、ねぇ・・・。自信はないです。

また、デザインパターンとかはあまり私もよく分かっていないので、
$folder->delete();
として、削除して、後は質問者さんがおっしゃってるようにExceptionを返すようにしちゃうのか、私の提案したようにするか、どっちがベストかはちょっと分からないですね。

後は(回答してる最中に思いついた)、
Zend/Iterator
とかディレクトリ切っちゃって、その中に
Zend_Iterator_Directoryクラスを作って
Zend/Iterator/Directory/Folder
Zend/Iterator/Directory/File
見たいな感じでぶつぶつきっちゃって、
必要とあらば、
Zend/Iterator/Directory/File/Image
とか、ファイルの種類でクラスを分けてごにょごにょするのかとか

ふわっと色々思いつきますね。

後は好みとか、Gofなどのデザインパターンとか、そのほかのライブラリ（PEARやZend、PHPの標準ライブラリやフレームワーク）などを見てやってみる、って感じでしょうか。

あまり、具体的な提案が出来なくて申し訳ないです。

hogehoge78 · Answer

CakePHPに、FolderクラスとFileクラスってのがあります。
参考までに一度読んでみてはいかがでしょう。

また、もし自分で作成するとしたら、
Folderクラスと、Fileクラスを分けますかね。（まぁ、上記参考のCakeもそうなってますね）

フォルダがもつ属性値と、ファイルがもつ属性値は差異がありますので。

で、Folderクラスは、Iteratorインターフェイスでもimplementしてforeachで回せるようにして、
順番にグルグル回せるようにする、感じですかね。

<?php

$folder = new Folder("foldername");

foreach($folder as $file){

if($file->isFile()){
echo $file->size();
}

}

//もし全部を配列で持ってきたいなら、
print_r($folder->toArray());

とか適当に内部で再帰的にforeachしてまわしてきて全部配列にしてから返すような。

//削除するとき
$folder->setDelete(true);
unset($folder);

//とか、削除フラグを立てた状態で、classをunsetしたときに、__destructでフォルダを削除する処理を入れてやるとか？

?>
外側のイメージとしてはそんな感じでどうでしょう。
マジックメソッドの、__destructと、Iteratorインターフェイスを使ってやればイケそうな感じです。

基本は、全部一つずつのファイルで読む感じで、フォルダも再帰的に読んでくるんじゃなくて、
フォルダクラスの中に、フォルダクラスがあるような形にしてやるイメージです。

で、それぐらいなシンプルな形になっているものをさらに別のクラス作ってラップしてやるなりしていけばいいんじゃないでしょうか。

tany180sx · Answer

いちお、DirectoryIterator クラスってのはありますよ。

参考URL：http://jp.php.net/manual/ja/class.directoryiterator.php

フォルダ関連のライブラリについてアドバイスしてもらえないでしょうか？

<?php

RecursiveIteratorIteratorなど、Iterator群は、情報が薄いので情報を開いてみたことがなかったんですが、（Iteratorは結構使いますが）

どうしてもZend_Iterator_Directoryとかがアレだということであれば、

一応作ってみたので、下記に書き込んでみました。

ディレクトリと、フォルダは、ほぼ等価の意味を持っていますが、

この回答への補足

Zend/Iterator/Directory/File

この回答への補足

あ、ラッパークラスの置き場については、

ちょっと私も、英語が苦手で、あまりベストな名前がつけられないので、答えようがないというところなんですけど、

この回答への補足

CakePHPに、FolderクラスとFileクラスってのがあります。

いちお、DirectoryIterator クラスってのはありますよ。

似たような質問が見つかりました

関連するカテゴリからQ&Aを探す

デイリーランキングこのカテゴリの人気デイリーQ&Aランキング

マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング