[Challenge] Format ListFiles to phpBB3 Coding Guidelines

[Handyman]

Here you are:

Spoiler:

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;
}

well? after a quick glance, I only see one problem? overall? it looks really good? but what do I expect

Code: Select all

$this->push_error('No location has been provided for scaning!');

Language should never be put directly in a php file? it should always be put in a language file.
And, since this is inside a function, you would use

Code: Select all

trigger_error($user->lang['NO_LOCATION_PROVIDED']);

you would also have to add $user as a global.

If it was not inside a function, you would just use

Code: Select all

trigger_error('NO_LOCATION_PROVIDED');

since the language variables would be included in the page.

[eviL3 Igor]

That confuses me. Okay, using language variables is correct (it wasn't clearly stated that it should be used in phpBB, so i just cleaned it up). But why do you use $user->lang in functions? Makes no sense to me. have a look in includes/functions.php at the function msg_handler(). $user is globaled there, and if $errno is E_USER_WARNING or E_USER_NOTICE, we have:

Code: Select all

            if (empty($user->lang))
            {
                $user->setup();
            }

            $msg_text = (!empty($user->lang[$msg_text])) ? $user->lang[$msg_text] : $msg_text;
            $msg_title = (!isset($msg_title)) ? $user->lang['INFORMATION'] : ((!empty($user->lang[$msg_title])) ? $user->lang[$msg_title] : $msg_title);

I think using $user->lang has nothing to do with it being inside a function (as that's not how variable scope works), but with the error level of the triggered error. A critical error, such as E_USER_ERROR would require using $user->lang, because it's not automatically converted.

Feel free to correct me, if i'm wrong

[silencer0]

wow lol coding talk xD i must be in really low level for not to understand a thing of what you told lol at least i'm trying

i'm bad lol

[eviL3 Igor]

Silencer, perhaps this helps you understand it better: http://php.net/variables.scope

[A_Jelly_Doughnut]

TTBOMK, trigger_error('LANG_STRING'); is always good enough. I've never had issues with this...

[Handyman]

That confuses me. Okay, using language variables is correct (it wasn't clearly stated that it should be used in phpBB, so i just cleaned it up). But why do you use $user->lang in functions? Makes no sense to me. have a look in includes/functions.php at the function msg_handler(). $user is globaled there, and if $errno is E_USER_WARNING or E_USER_NOTICE, we have:

Code: Select all

            if (empty($user->lang))
            {
                $user->setup();
            }

            $msg_text = (!empty($user->lang[$msg_text])) ? $user->lang[$msg_text] : $msg_text;
            $msg_title = (!isset($msg_title)) ? $user->lang['INFORMATION'] : ((!empty($user->lang[$msg_title])) ? $user->lang[$msg_title] : $msg_title);

I think using $user->lang has nothing to do with it being inside a function (as that's not how variable scope works), but with the error level of the triggered error. A critical error, such as E_USER_ERROR would require using $user->lang, because it's not automatically converted.

Feel free to correct me, if i'm wrong

you would also have to add $user as a global.

Code: Select all

global $user;

then you can use $user->lang anytime in that ufnction.
using the

Code: Select all

$user->lang['INFORMATION']

is the same as using

Code: Select all

{L_INFORMATION}

in templates.

[silencer0]

Silencer, perhaps this helps you understand it better: http://php.net/variables.scope

thx now i understand it better lol

[Mighty Gorgon Luca]

Nice challenge this one.

I sometimes use an automated script to automatically adjust code syntax.

Here is the link:
http://www.icyphoenix.com/_beautify/beautify.php

I slightly modified it to suit my needs... the code isn't perfect yet, but let you reformat bad written code easily.

If someone would like to help me in making it compliant with phpBB 3 requirements, I think it could be a great help for coder.

Of course I will share the code if you are interested in.

[john010117 John]

I believe this is right.

Code: Select all

<?php
/**
* List files
*
* @param string $dir
* @param bool $recursive
* @param bool $object
* @return mixed File list
*/
function list_files ($dir = '', $recursive = true, $object = true)
{
   global $user;
   
    // Ckeck if the $dir is empty
    if (empty($dir))
    {
        $this->push_error($user->lang['NO_LOCATION_PROVIDED']);
        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;
}
?>