vb.org Archive - Don't take vB's code as a model for perfect coding!

vb.org Archive (https://vborg.vbsupport.ru/index.php)

- vBulletin 3 Articles (https://vborg.vbsupport.ru/forumdisplay.php?f=187)

- - Don't take vB's code as a model for perfect coding! (https://vborg.vbsupport.ru/showthread.php?t=50148)

Don't take vB's code as a model for perfect coding!

Unlike rumors of vB3, vB2 has astetically horribly written code. Here are some things that you should do (and that vB doesn't always do):

1. When referencing a key in an array, always put the key in quotes. See http://www.php.net/manual/en/language.types.array.php for an explanation. For example, do this:

PHP Code:


		
			
$myarray['mykey'] = "whatever";

Not this:

PHP Code:


		
			
$myarray[mykey] = "whatever";

2. Whitespace is your friend. Use it. For example, this is painful to read:

PHP Code:


		
			
if($a==b&&$c xor ($d+1)){foo();bar()};

For the love of God, do this instead:

PHP Code:


		
			
if ($a == $b and $c xor ($d + 1)

{

    foo();

    bar();

}

For readability the two braces really should be on their own lines although many prefer to put the opening brace with the previous line. But do not do the same with the last brace as this can cause more trouble.

3. Indent or be smacked.
Bad:

PHP Code:


		
			
while (true)

{

if ($something)

{

for ($i = 0; $i < $x; $i++

{

dosomething();

}

}

}

Good:

PHP Code:


		
			
while (true)

{

    if ($something)

    {

        for ($i = 0; $i < $x; $i++)

        {

            dosomething();

        }

    }

}

If you write like the first example you'd be fired at your job. A side note: the typical editor uses four spaces or a tab character to indent. Try to keep this consistant! vB does not and can wreak havoc when trying to indent the standard four spaces because nothing will line up.

I'm sure many more examples are out there. Reply if you have any.

Good advice from the turtle. :) Makes a difference especially when trying to debug errors.

Yup...

Thanks for that:)

*Sues vB;)*

On a side note: I really wish I could change Erwin's spoiler message...:p

Satan

Indeed. Good tips there burt :)!

- miSt

I'm really hoping vB3 has followed the true professional PHP guidelines [like filbert has shown us]. If not, I don't know what I'd do. Lol.

having a look at the vb_test.php script on vB.com shows how the code is layed out in vB3.

http://www.vbulletin.com/forum/attac...achmentid=4326

I also posted a thread on vB3 syntax last year https://vborg.vbsupport.ru/showthrea...threadid=42946

Quote:

Today at 11:06 AM PPN said this in Post #6
having a look at the vb_test.php script on vB.com shows how the code is layed out in vB3.

http://www.vbulletin.com/forum/attac...achmentid=4326

I also posted a thread on vB3 syntax last year https://vborg.vbsupport.ru/showthrea...threadid=42946

Quote:

Bad Request
Your browser sent a request that this server could not understand.

--------------------------------------------------------------------------------

Apache/1.3.27 Server at www.vbulletin.com Port 80

Although IIRC from reading the code I think you're right :)

Quote:

Thanks PPN.

Just looked at it again and it does look way better than vB2. Only problem is it's still using deprecated variables like $HTTP_POST_VARS (instead of $_POST or $_GET). Also I don't know why vB doesn't use the true and false keywords but instead uses 1 and 0 everywhere...

I don't see how you could have looked since you don't have the vB3 code but we only refer to $HTTP_POST_VARS when the server is running php < 4.1. You shouldn't base your assumptions on a test script that has to work on php 4.0.6 and greater.

PHP Code:


		
			
if (PHPVERSION < '4.1')

{

    $_GET = &$HTTP_GET_VARS;

    $_POST = &$HTTP_POST_VARS;

    $_COOKIE = &$HTTP_COOKIE_VARS;

    $_SERVER = &$HTTP_SERVER_VARS;

    $_ENV = &$HTTP_ENV_VARS;

    $_FILES = &$HTTP_POST_FILES;

}

As for using TRUE/FALSE or 0/1 - we are using true/false more but just switched over so you will see both instances for now.

X vBulletin 3.8.12 by vBS Debug Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (7)bbcode_php_printable (3)bbcode_quote_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)pagenav (1)pagenav_curpage (2)pagenav_pagelink (1)post_thanks_navbar_search (1)printthread (10)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start pagenav_page pagenav_complete bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages:

Phrase Groups Available:

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.01141 seconds Memory Usage 1,754KB Queries Executed 10 (?)
More Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (7)bbcode_php_printable (3)bbcode_quote_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)pagenav (1)pagenav_curpage (2)pagenav_pagelink (1)post_thanks_navbar_search (1)printthread (10)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start pagenav_page pagenav_complete bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages: