Source

YiiFileManager / README.md

Full commit

Yii File Manager

Fileman is a framework for handling files attached to an given Identity, it can be commonly your current logged in user.

Fileman is designed as an abstract class, so many child classes can be built to satisfy business dependencies, like: Storing files in a disk file, in a user session, in a database, and so on.

In this case only one child class is provided: YiiDiskFileManager, created to store files in a disk.

Install the fileman component:

Register the fileman component into your config file.

[php]

    'import'=>array(
        ...bla...
        'application.extensions.yiifileman.*',  // <<--HERE
    ),

    'components'=>array(
        'fileman' => array(
            'class'=>'application.extensions.yiifileman.YiiDiskFileManager',
            'storage_path' => "/var/tmp/fileman",
    ),

Basic yii File Manager operations

[php]


    $identity = Yii::app()->user->id; // or any IDentificator.

    // ADD FILES
    //  add_files return an array of file_id.
    Yii::app()->fileman->add_files($identity,"/some/place/filename.mp3");
    Yii::app()->fileman->add_files($identity,array("file1", "file2"));

    // LIST FILES
    //   it returns an array of file-data: 
    //      "id" (identity), "file_id", "filename", "longfilename"
    foreach(Yii::app()->fileman->list_files($identity) as $fd)
        printf("file -> [%s] [%s] [%s]\n",
                $fd['id'],$fd['file_id'],$fd['filename']);

    // QUERY THE REAL PATH FOR A GIVEN FILE ID
    //  
    $real_path = Yii::app()->fileman->get_file_path($id, "18aac1a12");
    // ..do what ever you want with this file...
    printf("the real local path is: %s\n",$real_path);

    // QUERY IF THE GIVEN USER ID CAN READ A FILE USING ITS FILE_ID
    //
    $bool = Yii::app()->fileman->can_read(Yii::app()->user->id, "188abc123");

    // RENAME FILES
    //
    $bool = Yii::app()->fileman->rename_file(Yii::app()->user->id, "188abc123", "new file name");

    // REMOVE FILES
    //   using the file_id provided when calling list_files()
    Yii::app()->fileman->remove_file($identity, "18ac11981");
    Yii::app()->fileman->remove_file($identity, array("288abc12","2029acb12"));

Yii File Manager Class Diagram

Class Diagram

Test Fileman in a Command Line utility.

  1. Create a file "protected/commands/Filemancommand.php" having this content (see below).

  2. Be sure you have the rigth config file in "protected/yiic.php"

  3. Due to this is a test, edit the source code (look at "PUT SOME FILE HERE") and edit the array to provide real files.

  4. test it running commands:

    # cd myapp
    # cd protected
    # ./yiic fileman
[php]

    <?php
    // save in your commands directory:
    //      protected/commands/FilemanCommand.php
    //
    // run as:
    //      (dont forget to edit your protected/yiic.php yii path)
    //      #cd yourapp/protected
    //      #./yiic fileman --cmd=list --id=123456
    //
    class FilemanCommand extends CConsoleCommand {
        public function actionIndex($cmd='list',$fileids='',$id='',$files='', $name='', $file_id=''){
            printf("\nFileman tester. ID=%s\n",$id);
            printf("usage:\n");
            printf("    --cmd=list (default)\n");
            printf("    --cmd=add --id=123456 --files=/var/tmp/file1,/var/tmp/file2\n");
            printf("    --cmd=rem --id=123456 --fileids=129819,129982\n");
            printf("    --cmd=path --id=123456 --fileids=129819\n");
            printf("    --cmd=canread --id=123456 --fileids=129819,119891\n");
            printf("    --cmd=rename --id=123456 --file_id=129819 --name=newname\n");
            printf("\n");
            if($id=='')
                die("must provide an id. use --id=123456 or something else to test\n");
            if($cmd=='add'){
                // ADD
                //
                if(($id=='') || ($files=='')){
                    printf("add command must be:\n");
                    printf("    --cmd=add --id=123456 --files=/var/tmp/file1,/var/tmp/file2\n");
                }else{
                    $ar = explode(",",$files);
                    $result = Yii::app()->fileman->add_files($id, $ar);
                    if(empty($result))
                        printf("no files added.\n");
                    foreach($result as $r)
                        printf("added files [%s]\n",$r);
                }
            }elseif($cmd=='list'){
                // LIST
                //
                foreach(Yii::app()->fileman->list_files($id) as $fd)
                    printf("file -> [%s] [%s] [%s]\n",
                        $fd['id'],$fd['file_id'],$fd['filename']);
            }elseif($cmd=='rem'){
                // DELETE
                //
                if($fileids == ''){
                    printf("usage: fileman --cmd=rem --fileids=129812,198928\n");
                }else{
                    $ar = explode(",",$fileids);
                    $removed = Yii::app()->fileman->remove_files($id,$ar);
                    printf("file removed: %s\n",$removed);
                }
            }elseif($cmd=='path'){
                $path = Yii::app()->fileman->get_file_path($id, $fileids);
                if($path != null){
                    printf("REAL FILE PATH IS: %s\n",$path);
                }
                else
                    printf("file not found\d");
            }elseif($cmd=='canread'){
                if(($fileids == '') || ($id == '')){
                    printf("usage: fileman --cmd=canread --id=123456 --fileids=129812,198928\n");
                }else{
                    $ar = explode(",",$fileids);
                    foreach($ar as $file_id)
                        printf("can_read %s: %s\n",
                            $file_id,
                            Yii::app()->fileman->can_read($id,$file_id) ? "YES" : "NO");
                }
            }elseif($cmd=='rename'){
                if($name == ''){
                    printf("usage:\n");
                    printf("    --cmd=rename --id=123456 --file_id=129819 --name=newname\n");
                }else{
                    printf("result: %s\n",Yii::app()->fileman->rename_file($id, $file_id, $name));
                }
            }
        }

    }