[Challenge] Format ListFiles to phpBB3 Coding Guidelines

[Highway of Life]

This is a very simple challenge, basically, your goal is to reformat this piece of code to adhere to phpBB3 coding guidelines.
There will be a total of four or five snippets of code, but I'm only going to release them one at a time until each snippet is properly formatted. -- i.e. because one could "cheat" by duplicating the code of someone who posted it successfully, and I have not install the LOCK / HIDE MOD yet, so we have to do it like this for the moment.

Once all five codes are formatted, I will show this script/MOD in it's entirety, but no sooner.

Here is the first one, once someone completes and posts the formatted version, the second code will be added.

Spoiler:

Code: Select all

    function ListFiles($dir=NULL, $recursive=true, $object=true){
        if($dir==NULL){
            $this->PushError("No location has been provided for scaning!");
            exit;
        }
        $dir    =    realpath($dir);
        #
        $list    =    array();
        #
        $d  = opendir($dir);
        while (false !== ($filename = readdir($d))) {
            if($filename!="." && $filename!=".."){
                switch($object){
                    case true:
                        $list[$filename]=new FileInfo(realpath($dir."/".$filename), $recursive, $object);
                        break;
                    default:
                        $list[$filename]=$this->Info(realpath($dir."/".$filename), $recursive, $object);
                        break;
                }
            }
        }
        closedir($d);
        #
        ksort($list);
        #
        return $list;
    }

Good luck.

[Pace]

I think this is somewhat right?

Spoiler:

Code: Select all

function ListFiles($dir = NULL, $recursive = true, $object = true)
{
    if ($dir == NULL)
    {
        trigger_error('NO_SCANNING_LOCATION');
        // this error ("No location has been provided for scaning!") must be defined in the common.php language file 
    }

    $dir = realpath($dir);
    $list = array();
    $d = @opendir($dir);

    while (false !== ($filename = readdir($d)))
    {
        if ($filename != "." && $filename != "..")
        {
            switch ($object)
            {
                case true:
                    $list[$filename] = new FileInfo(realpath($dir."/".$filename), $recursive, $object);
                break;

                default:
                    $list[$filename] = $this->Info(realpath($dir."/".$filename), $recursive, $object);
                break;
            }
        }
    }

    closedir($d);
    @ksort($list);
    return $list;
}

[Highway of Life]

Not bad...
But there are still missing a few things.
I won?t go into detail, because I don?t want to give too many hints.

• Correct capitalization
• Correct variable and function names (concise but explanatory).
• Correct use of quotations
• Trigger error will just display NO_SCANNING_LOCATION instead of a language variable, but you are on the right track.
• Correct spaces on combining variables (use of ?.? and spaces between the period and the variables)
• Use an alternate NULL value than just "NULL"
• See if you can use a better while loop
• Take every opportunity to optimize that code. -- (there are a few locations where it can be optimized)

[Richard]

Okay heres mine;

Spoiler:

Code: Select all

<?php
echo "can you make beginners challenges even easier? :P"
die;
?>

[silencer0]

hmm i don't know if mine's correct already but anywayz i'll post it lol
Hope it's a bit correct lol

Spoiler:

Code: Select all

    function ListFiles($dir = NULL, $recursive = true, $object = true){
        if(isset($dir == NULL))                                                
                                                                      {
        { 
            $this->PushError("No location has been provided for scaning!");
            exit;
        }
        $dir = realpath($dir);
        #
        $list = array();
        #
        $d  = opendir($dir);
        while (false !== ($filename = readdir($d))) {
            if(isset($filename != "." && $filename != .. ))
                                                    }
                switch($object){
                    case true:
                        $list[$filename] = new FileInfo(realpath($dir."/".$filename), 

$recursive, $object);
                        break;
                    default:
                        $list[$filename] = $this->Info(realpath($dir."/".$filename), 

$recursive, $object);
                        break;
                }
            }
        }
        closedir($d);
        #
        ksort($list);
        #
        return $list;
    }

[Highway of Life]

emm... no... that code would ?break?.

Review Pace?s rendition for tips.
His code would actually work, and is really good, but I?m hard on him to get it perfect.

[silencer0]

actually now, i've worked on it lil more time.. so now i suppose it's right..just one thing i didn't know was the trigger error, got that one from pace...

Spoiler:

Code: Select all

    function ListFiles($dir = NULL, $recursive = true, $object = true)
{
        if(isset($dir == NULL))                                               
                                                                     
        {
        trigger_error('NO_SCANNING_LOCATION');
        // The error ("No location has been provided for scaning!") must be defined in the common.php language file

        }
        $dir = realpath($dir);
        $list = array();
        $d  = opendir($dir);

        while (false !== ($filename = readdir($d))) {
            if(isset($filename != "." && $filename != .. ))
                                                    }
                switch($object)
{
                    case 'true':
                        $list[$filename] = new fileinfo(realpath($dir."/".$filename), $recursive, $object);
                                     //I am doing something here.
                    break;

                    default:
                        $list[$filename] = $this->Info(realpath($dir."/".$filename), $recursive, $object);
                                    //I am doing something totally different here.
                    break;
}
            }
        }
        closedir($d);
        ksort($list);
        return $list;
}

[eviL3 Igor]

Highway, mind if i post mine?

[Highway of Life]

Highway, mind if i post mine?

Please do!

Silencer... much better!!

That could would still break, however... there is an error in there.
Also, be sure to pay attention to proper function AND variable naming.
All names should be lowercase, and functions should be descriptive, but concise.
Variables should be long enough to tell the programmer what they are used for, but short. (unless they are counters, such as $i++; etc)

[eviL3 Igor]

Here you are:

Code: Select all

/**
 * List files
 *
 * @param string $dir
 * @param bool $recursive
 * @param bool $object
 * @return mixed File list
 */
function list_files ($dir = '', $recursive = true, $object = true)
{
    // Ckeck if the $dir is empty
    if (empty($dir))
    {
        $this->push_error('No location has been provided for scaning!');
        exit;
    }
    
    // Make sure $dir is a "real path"
    $dir = realpath($dir);
    
    // Make sure $list is set
    $list = array();
    
    // Loop through the files
    $handle = opendir($dir);
    while (false !== ($file = readdir($handle)))
    {
        if (!in_array($file, array('.', '..')))
        {
            $list[$file] = ($object) ? new file_info(realpath($dir . '/' . $filename), $recursive, $object) : $this->info(realpath($dir . '/' . $filename), $recursive, $object);
        }
    }
    closedir($handle);
    
    ksort($list);
    
    return $list;
}