Tuesday, October 25, 2011

HTML5 - code example of drag and drop on a web page



The key methods to implement d&d are basic and easily implemented as follows:


  1. function dragIt(target, e) {
  2.     e.dataTransfer.setData('SpanImg', target.id);
  3. }
  4. function dropIt(target, e) {
  5.     var id = e.dataTransfer.getData('SpanImg');
  6.     target.appendChild(document.getElementById(id));
  7.     e.preventDefault();
  8. }

I used table elements to provide both layout structure and as a target for
ondrop events:

  1. <td align="center" width="100" id="blue" ondrop="dropIt(this, event)" ondragenter="return false" ondragover="return false">   ....  </td>

I chose the span element (wrapping an image) as my
draggable object:

  1. <span draggable="true" id="t_1" ondragstart="dragIt(this, event)"><img src="https://www.ibm.com/developerworks/mydeveloperworks/blogs/bobleah/resource/tower.jpg"></span>


Original post: https://www.ibm.com/developerworks/mydeveloperworks/blogs/bobleah/entry/html5_an_example_of_drag_and_drop26?lang=en
Download exapme: https://www.ibm.com/developerworks/mydeveloperworks/files/app?lang=en#/person/270000CN12/file/ca25c6eb-f34a-437c-85da-5b3b24b3b9bb

HTML5 - code example of ContentEditable and LocalStorage - create a web sticky note!



Script:

  1. <script>
  2.   function storeUserScribble(id) {
  3.     var scribble = document.getElementById('scribble').innerHTML;
  4.     localStorage.setItem('userScribble',scribble);
  5.   }
  6.   function getUserScribble() {
  7.     if ( localStorage.getItem('userScribble')) {
  8.       var scribble = localStorage.getItem('userScribble');
  9.     }
  10.     else {
  11.       var scribble = 'You can scribble directly on this sticky... and I will also remember your message the next time you visit my blog!';
  12.     }
  13.     document.getElementById('scribble').innerHTML = scribble;
  14.   }
  15.   function clearLocal() {
  16.     clear: localStorage.clear();
  17.     return false;
  18.   }
  19. </script>

Html:

<pre id="scribble" contenteditable="true" onkeyup="storeUserScribble(this.id);"></pre>

Original post: https://www.ibm.com/developerworks/mydeveloperworks/blogs/bobleah/entry/html5_code_example_of_contenteditable_and_localstorage_create_a_web_sticky_note?lang=en

Download example: https://www.ibm.com/developerworks/mydeveloperworks/files/app?lang=en#/person/270000CN12/file/e27c84f2-8a08-4e33-b447-8ffa620c4ada

Monday, October 24, 2011

Get domain name from email address

    public function getDomainNameFromEmailAddress($email){
       
        $ar = split("@",$email);
        if(!empty($ar[1])){
            return $ar[1];
        }else{
            return "";
        }
    }

Wednesday, October 19, 2011

Create a Typing Text Effect using jQuery

For long now flash has been dominating the interactive web animation, using JavaScript was a daunting task. But introduction of frameworks like jQuery, MooTools, Scriptaculous, etc have made animating web component much easier. Another advantage of using these frameworks over flash is that they are search engine friendly. Though search engine do not index JavaScript, actual content is present in html or other SEO friendly code.

You must have seen this text effect on many flash websites. jTicker is a jQuery plugin that can be used for creating such effect without the use of flash. This effect comes in handy when you want to force the visitor to read the text. But should be used wherever necessary, as the usability suffers. jTicker can be declared on any element and can be stylized using CSS. You can also use event buttons to play, stop and control the speed of the effect.

HTML

Let us start with html markup. Make sure that you have linked the .js files correctly.
01<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
02<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
03<head>
04<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
05<title>jticker | Demo</title>
06<script type="text/javascript" SRC="js/jquery-1.3.2.min.js"></script>
07<script type="text/javascript" SRC="js/jquery.jticker.js"></script>
08</head>
09<body>
10<div id="content">
11  <h2>jTicker Demo  </h2>
12  <div id="ticker">
13    <div>
14      <h3>What does jTicker do?</h3>
15        <p>jTicker takes an elements' children and displays them one by one, in sequence, writing their text 'ticker tape' style. It is smart enough to ticker text from an element heirarchy, inserting elements back into the DOM tree as it needs them. That means almost any content can be 'tickered'.</p>
16        <p>It can be controlled with jQuery events.</p>
17        <a class="next" href="#">next</a>
18    </div>
19    <div>
20      <h3>Not my cup of tea, really, ...</h3>
21        <p>annoying little blinky things trying to distract attention when you want to get on with the serious business of reading a website, but if it's your thing, here it is.</p>
22
23        <a class="next" href="#">next</a>
24    </div>
25    <div>
26        <h3>jTicker has some neat features:</h3>
27        <ul>
28            <li>jTicker can be declared on any element, and it respects that element's DOM tree, printing it back out with the same hierarchy.</li>
29            <li>jTicker handles any number of alternating cursors (or just one).</li>
30
31            <li>jTicker's cursor container is styleable using the class .cursor, or can be defined as your own jQuery object</li>
32            <li>jTicker reacts to jQuery events "play", "stop" and "control". You can try them out below.</li>
33        </ul>
34        <a class="next" href="#">next</a>
35    </div>
36
37    <div>
38        <h3>There is one caveat:</h3>
39
40        <ul>
41            <li><span>jTicker can't understand text and children at the same level (I don't know how to do that yet), so if you want some text and then a link, you have to wrap the text in, say, a span, like this:</span>
42                <code>|span| some text |/span| |a|and then a link|/a|</code>
43            </li>
44            <li>But obviously not with those brackets. That's another thing, jTicker is not good at handling html character entities. So make that two caveats.</li>
45        </ul>
46        <a class="next" href="#">next</a>
47    </div>
48  </div>
49</div>
50</body>
51</html>

CSS

Add this code to your CSS file or to the <style>
01#ticker
02  {height: 12em; padding: 0.6em 0; margin: 0 0 1.8em 0; border-top:3px solid #efefef; border-bottom:3px solid #efefef; position: relative;}
03#ticker .cursor
04  {display: inline-block; background: #565c61; width: 0.6em; height: 1em; text-align: center;}
05#ticker p
06  {margin-bottom: 0.8em;}
07#ticker code
08  {margin: 0.4em 0.4em; display: block;}
09#ticker .next
10  {position: absolute; bottom: 1em;}

JavaScript 

Now initialize jTicker by adding this JavaScript to <head> between <script type=”text/javascript”></script>
01<!--
02  jQuery(document).ready(function(){
03    // Instantiate jTicker
04    jQuery("#ticker").ticker({
05        cursorList:  " ",
06        rate:        10,
07        delay:       4000
08    }).trigger("play").trigger("stop");
09
10    // Trigger events
11    jQuery(".stop").click(function(){
12        jQuery("#ticker").trigger("stop");
13        return false;
14    });
15
16    jQuery(".play").click(function(){
17        jQuery("#ticker").trigger("play");
18        return false;
19    });
20
21    jQuery(".speedup").click(function(){
22        jQuery("#ticker")
23        .trigger({
24            type: "control",
25            item: 0,
26            rate: 10,
27            delay: 4000
28        })
29        return false;
30    });
31
32    jQuery(".slowdown").click(function(){
33        jQuery("#ticker")
34        .trigger({
35            type: "control",
36            item: 0,
37            rate: 90,
38            delay: 8000
39        })
40        return false;
41    });
42
43    jQuery(".next").live("click", function(){
44        jQuery("#ticker")
45        .trigger({type: "play"})
46        .trigger({type: "stop"});
47        return false;
48    });
49
50    jQuery(".style").click(function(){
51        jQuery("#ticker")
52        .trigger({
53            type: "control",
54            cursor: jQuery("#ticker").data("ticker").cursor.css({width: "4em", background: "#efefef", position: "relative", top: "1em", left: "-1em"})
55        })
56        return false;
57    });
58
59  });
60
61//-->

View Demo
Download Files
Visit Authors Website

Zend Framework 2.0.0beta1 Released!

The Zend Framework community is pleased to announce the immediate availability of Zend Framework 2.0.0beta1. Packages and installation instructions are available at:
http://packages.zendframework.com/
This is the first in a series of planned beta releases. The beta release cycle will follow the "gmail" style of betas, whereby new features will be added in each new release, and BC will not be guaranteed; beta releases will happen no less than every six weeks. The desire is for developers to adopt and work with new components as they are shipped, and provide feedback so we can polish the distribution.
Once all code in the proposed standard distribution has reached maturity and reasonable stability, we will freeze the API and prepare for Release Candidate status.
Featured components and functionality of 2.0.0beta1 include:
  • New and refactored autoloaders:
    • Zend\Loader\StandardAutoloader
    • Zend\Loader\ClassMapAutoloader
    • Zend\Loader\AutoloaderFactory
  • New plugin broker strategy
    • Zend\Loader\Broker and Zend\Loader\PluginBroker
  • Reworked Exception system
    • Allow catching by specific Exception type
    • Allow catching by component Exception type
    • Allow catching by SPL Exception type
    • Allow catching by base Exception type
  • Rewritten Session component
  • Refactored View component
    • Split helpers into a PluginBroker
    • Split variables into a Variables container
    • Split script paths into a TemplateResolver
    • Renamed base View class "PhpRenderer"
    • Refactored helpers to utilize __invoke() when possible
  • Refactored HTTP component
  • New Zend\Cloud\Infrastructure component
  • New EventManager component
  • New Dependency Injection (Zend\Di) component
  • New Code component
    • Incorporates refactored versions of former Reflection and CodeGenerator components.
    • Introduces Scanner component.
    • Introduces annotation system.
The above components provide a solid foundation for Zend Framework 2, and largely make up the framework "core". However, the cornerstone feature of beta1 is what they enable: the new MVC layer:
  • Zend\Module, for developing modular application architectures.
  • Zend\Mvc, a completely reworked MVC layer built on top of HTTP, EventManager, and Di.
We've built a skeleton application and a skeleton module to help get you started, as well as a quick start guide to the MVC; the new MVC is truly flexible, and moreover, simple and powerful.
Additionally, for those who haven't clicked on the packages link above, we are debuting our new distribution mechanisms for ZF2: the ability to use Pyrus to install individual components and/or groups of components.
Since mid-August, we've gone from a few dozen pull requests on the ZF2 git repository to over 500, originating from both long-time Zend Framework contributors as well as those brand-new to the project. I'd like to thank each and every one of them, but also call out several individuals who have made some outstanding and important contributions during that time frame:
  • Evan Coury, who prototyped and then implemented the new module system.
  • Rob Allen, who, because he was doing a tutorial at PHPNW on ZF2, provided a lot of early feedback, ideas, and advice on the direction of the MVC.
  • Ben Scholzen, who wrote a new router system, in spite of a massive injury from a cycling accident.
  • Ralph Schindler, who has had to put up with my daily "devil's advocate" and "think of the user!" rants for the past several months, and still managed to provide comprehensive code manipulation tools, a Dependency Injection framework, and major contributions to the HTTP component.
  • Enrico Zimuel, who got tossed requirements for the cloud infrastructure component, and then had to rework most of it after rewriting the HTTP client from the ground up... and who still managed three back-to-back-to-back conferences as we prepared the release.
  • Artur Bodera, who often has played devil's advocate, and persisted pressing his opinions on the direction of the framework, often despite heavy opposition. We may not implement all (or many) of the features you want, but you've definitely influenced the direction of the MVC incredibly.
  • Pádraic Brady, who started the runaway train rolling with a rant, and helped make the project much more transparent, enabling the MVC development to occur in the first place.

Wtf is html5 and why we sould all care


HTML5 & CSS3 Readiness


Php empty() function in Javascript

function empty (mixed_var) {
    // http://kevin.vanzonneveld.net
    // +   original by: Philippe Baumann
    // +      input by: Onno Marsman
    // +   bugfixed by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +      input by: LH
    // +   improved by: Onno Marsman
    // +   improved by: Francesco
    // +   improved by: Marc Jansen
    // +   input by: Stoyan Kyosev (http://www.svest.org/)
    // *     example 1: empty(null);
    // *     returns 1: true
    // *     example 2: empty(undefined);
    // *     returns 2: true
    // *     example 3: empty([]);
    // *     returns 3: true
    // *     example 4: empty({});
    // *     returns 4: true
    // *     example 5: empty({'aFunc' : function () { alert('humpty'); } });
    // *     returns 5: false
    var key;

    if (mixed_var === "" || mixed_var === 0 || mixed_var === "0" || mixed_var === null || mixed_var === false || typeof mixed_var === 'undefined') {
        return true;
    }

    if (typeof mixed_var == 'object') {
        for (key in mixed_var) {
            return false;
        }
        return true;
    }

    return false;
}

Php uniqid() function in Javascript

function uniqid (prefix, more_entropy) {
    // +   original by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
    // +    revised by: Kankrelune (http://www.webfaktory.info/)
    // %        note 1: Uses an internal counter (in php_js global) to avoid collision
    // *     example 1: uniqid();
    // *     returns 1: 'a30285b160c14'
    // *     example 2: uniqid('foo');
    // *     returns 2: 'fooa30285b1cd361'
    // *     example 3: uniqid('bar', true);
    // *     returns 3: 'bara20285b23dfd1.31879087'
    if (typeof prefix == 'undefined') {
        prefix = "";
    }

    var retId;
    var formatSeed = function (seed, reqWidth) {
        seed = parseInt(seed, 10).toString(16); // to hex str
        if (reqWidth < seed.length) { // so long we split
            return seed.slice(seed.length - reqWidth);
        }
        if (reqWidth > seed.length) { // so short we pad
            return Array(1 + (reqWidth - seed.length)).join('0') + seed;
        }
        return seed;
    };

    // BEGIN REDUNDANT
    if (!this.php_js) {
        this.php_js = {};
    }
    // END REDUNDANT
    if (!this.php_js.uniqidSeed) { // init seed with big random int
        this.php_js.uniqidSeed = Math.floor(Math.random() * 0x75bcd15);
    }
    this.php_js.uniqidSeed++;

    retId = prefix; // start with prefix, add current milliseconds hex string
    retId += formatSeed(parseInt(new Date().getTime() / 1000, 10), 8);
    retId += formatSeed(this.php_js.uniqidSeed, 5); // add seed hex string
    if (more_entropy) {
        // for more entropy we add a float lower to 10
        retId += (Math.random() * 10).toFixed(8).toString();
    }

    return retId;
}

Monday, October 17, 2011

Php random string generator

   public function generateRandomString() {
        $length = 20;
        $characters = "0123456789abcdefghijklmnopqrstuvwxyz";
        $string = "";   

        for ($p = 0; $p < $length; $p++) {
            $string .= $characters[mt_rand(0, strlen($characters)-1)];
        }

        return $string;
    }

Friday, October 14, 2011

Top 15+ Best Practices for Writing Super Readable Code

1 - Commenting & Documentation

IDE’s (Integrated Development Environment) have come a long way in the past few years. This made commenting your code more useful than ever. Following certain standards in your comments allows IDE’s and other tools to utilize them in different ways.
Consider this example:
The comments I added at the function definition can be previewed whenever I use that function, even from other files.
Here is another example where I call a function from a third party library:
In these particular examples, the type of commenting (or documentation) used is based on PHPDoc, and the IDE is Aptana.

2 - Consistent Indentation

I assume you already know that you should indent your code. However, it’s also worth noting that it is a good idea to keep your indentation style consistent.
There are more than one way of indenting code.
Style 1:
  1. function foo() {  
  2.     if ($maybe) {  
  3.         do_it_now();  
  4.         again();  
  5.     } else {  
  6.         abort_mission();  
  7.     }  
  8.     finalize();  
  9. }  
Style 2:
  1. function foo()  
  2. {  
  3.     if ($maybe)  
  4.     {  
  5.         do_it_now();  
  6.         again();  
  7.     }  
  8.     else  
  9.     {  
  10.         abort_mission();  
  11.     }  
  12.     finalize();  
  13. }  
Style 3:
  1. function foo()  
  2. {   if ($maybe)  
  3.     {   do_it_now();  
  4.         again();  
  5.     }  
  6.     else  
  7.     {   abort_mission();  
  8.     }  
  9.     finalize();  
  10. }  
I used to code in style #2 but recently switched to #1. But that is only a matter of preference. There is no “best” style that everyone should be following. Actually, the best style, is a consistent style. If you are part of a team or if you are contributing code to a project, you should follow the existing style that is being used in that project.
The indentation styles are not always completely distinct from one another. Sometimes, they mix different rules. For example, in PEAR Coding Standards, the opening bracket "{" goes on the same line as control structures, but they go to the next line after function definitions.
PEAR Style:
  1. function foo()  
  2. {                     // placed on the next line  
  3.     if ($maybe) {     // placed on the same line  
  4.         do_it_now();  
  5.         again();  
  6.     } else {  
  7.         abort_mission();  
  8.     }  
  9.     finalize();  
  10. }  
Also note that they are using four spaces instead of tabs for indentations.
Here is a Wikipedia article with samples of different indent styles.

3 - Avoid Obvious Comments

Commenting your code is fantastic; however, it can be overdone or just be plain redundant. Take this example:
  1. // get the country code  
  2. $country_code = get_country_code($_SERVER['REMOTE_ADDR']);  
  3.   
  4. // if country code is US  
  5. if ($country_code == 'US') {  
  6.   
  7.     // display the form input for state  
  8.     echo form_input_state();  
  9. }  
When the text is that obvious, it’s really not productive to repeat it within comments.
If you must comment on that code, you can simply combine it to a single line instead:
  1. // display state selection for US users  
  2. $country_code = get_country_code($_SERVER['REMOTE_ADDR']);  
  3. if ($country_code == 'US') {  
  4.     echo form_input_state();  
  5. }  

4 - Code Grouping

More often than not, certain tasks require a few lines of code. It is a good idea to keep these tasks within separate blocks of code, with some spaces between them.
Here is a simplified example:
  1. // get list of forums  
  2. $forums = array();  
  3. $r = mysql_query("SELECT id, name, description FROM forums");  
  4. while ($d = mysql_fetch_assoc($r)) {  
  5.     $forums []= $d;  
  6. }  
  7.   
  8. // load the templates  
  9. load_template('header');  
  10. load_template('forum_list',$forums);  
  11. load_template('footer');  
Adding a comment at the beginning of each block of code also emphasizes the visual separation.

5 - Consistent Naming Scheme

PHP itself is sometimes guilty of not following consistent naming schemes:
  • strpos() vs. str_split()
  • imagetypes() vs. image_type_to_extension()
First of all, the names should have word boundaries. There are two popular options:
  • camelCase: First letter of each word is capitalized, except the first word.
  • underscores: Underscores between words, like: mysql_real_escape_string().
Having different options creates a situation similar to the indent styles, as I mentioned earlier. If an existing project follows a certain convention, you should go with that. Also, some language platforms tend to use a certain naming scheme. For instance, in Java, most code uses camelCase names, while in PHP, the majority of uses underscores.
These can also be mixed. Some developers prefer to use underscores for procedural functions, and class names, but use camelCase for class method names:
  1. class Foo_Bar {  
  2.   
  3.     public function someDummyMethod() {  
  4.   
  5.     }  
  6.   
  7. }  
  8.   
  9. function procedural_function_name() {  
  10.   
  11. }  
So again, there is no obvious “best” style. Just being consistent.

6 - DRY Principle

DRY stands for Don’t Repeat Yourself. Also known as DIE: Duplication is Evil.
The principle states:
“Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.”
The purpose for most applications (or computers in general) is to automate repetitive tasks. This principle should be maintained in all code, even web applications. The same piece of code should not be repeated over and over again.
For example, most web applications consist of many pages. It’s highly likely that these pages will contain common elements. Headers and footers are usually best candidates for this. It’s not a good idea to keep copy pasting these headers and footers into every page. Here is Jeffrey Way explaining how to create templates in CodeIgniter.
  1. $this->load->view('includes/header');  
  2.   
  3. $this->load->view($main_content);  
  4.   
  5. $this->load->view('includes/footer');  

7 - Avoid Deep Nesting

Too many levels of nesting can make code harder to read and follow.
  1. function do_stuff() {  
  2.   
  3. // ...  
  4.   
  5.     if (is_writable($folder)) {  
  6.   
  7.         if ($fp = fopen($file_path,'w')) {  
  8.   
  9.             if ($stuff = get_some_stuff()) {  
  10.   
  11.                 if (fwrite($fp,$stuff)) {  
  12.   
  13.                     // ...  
  14.   
  15.                 } else {  
  16.                     return false;  
  17.                 }  
  18.             } else {  
  19.                 return false;  
  20.             }  
  21.         } else {  
  22.             return false;  
  23.         }  
  24.     } else {  
  25.         return false;  
  26.     }  
  27. }  
For the sake of readability, it is usually possible to make changes to your code to reduce the level of nesting:
  1. function do_stuff() {  
  2.   
  3. // ...  
  4.   
  5.     if (!is_writable($folder)) {  
  6.         return false;  
  7.     }  
  8.   
  9.     if (!$fp = fopen($file_path,'w')) {  
  10.         return false;  
  11.     }  
  12.   
  13.     if (!$stuff = get_some_stuff()) {  
  14.         return false;  
  15.     }  
  16.   
  17.     if (fwrite($fp,$stuff)) {  
  18.         // ...  
  19.     } else {  
  20.         return false;  
  21.     }  
  22. }  

8 - Limit Line Length

Our eyes are more comfortable when reading tall and narrow columns of text. This is precisely the reason why newspaper articles look like this:
It is a good practice to avoid writing horizontally long lines of code.
  1. // bad  
  2. $my_email->set_from('test@email.com')->add_to('programming@gmail.com')->set_subject('Methods Chained')->set_body('Some long message')->send();  
  3.   
  4. // good  
  5. $my_email  
  6.     ->set_from('test@email.com')  
  7.     ->add_to('programming@gmail.com')  
  8.     ->set_subject('Methods Chained')  
  9.     ->set_body('Some long message')  
  10.     ->send();  
  11.   
  12. // bad  
  13. $query = "SELECT id, username, first_name, last_name, status FROM users LEFT JOIN user_posts USING(users.id, user_posts.user_id) WHERE post_id = '123'";  
  14.   
  15. // good  
  16. $query = "SELECT id, username, first_name, last_name, status 
  17.     FROM users 
  18.     LEFT JOIN user_posts USING(users.id, user_posts.user_id) 
  19.     WHERE post_id = '123'";  
Also, if anyone intends to read the code from a terminal window, such as Vim users, it is a good idea to to limit the line length to around 80 characters.

9 - File and Folder Organization

Technically, you could write an entire application code within a single file. But that would prove to be a nightmare to read and maintain.
During my first programming projects, I knew about the idea of creating “include files.” However, I was not yet even remotely organized. I created an “inc” folder, with two files in it: db.php and functions.php. As the applications grew, the functions file also became huge and unmaintainable.
One of the best approaches is to either use a framework, or imitate their folder structure. Here is what CodeIgniter looks like:

10 - Consistent Temporary Names

Normally, the variables should be descriptive and contain one or more words. But, this doesn’t necessarily apply to temporary variables. They can be as short as a single character.
It is a good practice to use consistent names for your temporary variables that have the same kind of role. Here are a few examples that I tend use in my code:
  1. // $i for loop counters  
  2. for ($i = 0; $i < 100; $i++) {  
  3.   
  4.     // $j for the nested loop counters  
  5.     for ($j = 0; $j < 100; $j++) {  
  6.   
  7.     }  
  8. }  
  9.   
  10. // $ret for return variables  
  11. function foo() {  
  12.     $ret['bar'] = get_bar();  
  13.     $ret['stuff'] = get_stuff();  
  14.   
  15.     return $ret;  
  16. }  
  17.   
  18. // $k and $v in foreach  
  19. foreach ($some_array as $k => $v) {  
  20.   
  21. }  
  22.   
  23. // $q, $r and $d for mysql  
  24. $q = "SELECT * FROM table";  
  25. $r = mysql_query($q);  
  26. while ($d = mysql_fetch_assocr($r)) {  
  27.   
  28. }  
  29.   
  30. // $fp for file pointers  
  31. $fp = fopen('file.txt','w');  

11 - Capitalize SQL Special Words

Database interaction is a big part of most web applications. If you are writing raw SQL queries, it is a good idea to keep them readable as well.
Even though SQL special words and function names are case insensitive, it is common practice to capitalize them to distinguish them from your table and column names.
  1. SELECT id, username FROM user;  
  2.   
  3. UPDATE user SET last_login = NOW()  
  4. WHERE id = '123'  
  5.   
  6. SELECT id, username FROM user u  
  7. LEFT JOIN user_address ua ON(u.id = ua.user_id)  
  8. WHERE ua.state = 'NY'  
  9. GROUP BY u.id  
  10. ORDER BY u.username  
  11. LIMIT 0,20  

12 - Separation of Code and Data

This is another principle that applies to almost all programming languages in all environments. In the case of web development, the “data” usually implies HTML output.
When PHP was first released many years ago, it was primarily seen as a template engine. It was common to have big HTML files with a few lines of PHP code in between. However, things have changed over the years and websites became more and more dynamic and functional. The code is now a huge part of web applications, and it is no longer a good practice to combine it with the HTML.
You can either apply the principle to your application by yourself, or you can use a third party tool (template engines, frameworks or CMS’s) and follow their conventions.
Popular PHP Frameworks:
Popular Template Engines:
Popular Content Management Systems

13 - Alternate Syntax Inside Templates

You may choose not to use a fancy template engine, and instead go with plain inline PHP in your template files. This does not necessarily violate the “Separation of Code and Data,” as long as the inline code is directly related to the output, and is readable. In this case you should consider using the alternate syntax for control structures.
Here is an example:
  1. <div class="user_controls">  
  2.     <?php if ($user = Current_User::user()): ?>  
  3.         Hello, <em><?php echo $user->username; ?></em> <br/>  
  4.         <?php echo anchor('logout''Logout'); ?>  
  5.     <?php else: ?>  
  6.         <?php echo anchor('login','Login'); ?> |  
  7.         <?php echo anchor('signup''Register'); ?>  
  8.     <?php endif; ?>  
  9. </div>  
  10.   
  11. <h1>My Message Board</h1>  
  12.   
  13. <?php foreach($categories as $category): ?>  
  14.   
  15.     <div class="category">  
  16.   
  17.         <h2><?php echo $category->title; ?></h2>  
  18.   
  19.         <?php foreach($category->Forums as $forum): ?>  
  20.   
  21.             <div class="forum">  
  22.   
  23.                 <h3>  
  24.                     <?php echo anchor('forums/'.$forum->id, $forum->title) ?>  
  25.                     (<?php echo $forum->Threads->count(); ?> threads)  
  26.                 </h3>  
  27.   
  28.                 <div class="description">  
  29.                     <?php echo $forum->description; ?>  
  30.                 </div>  
  31.   
  32.             </div>  
  33.   
  34.         <?php endforeach; ?>  
  35.   
  36.     </div>  
  37.   
  38. <?php endforeach; ?>  
This lets you avoid lots of curly braces. Also, the code looks and feels similar to the way HTML is structured and indented.

14 - Object Oriented vs. Procedural

Object oriented programming can help you create well structured code. But that does not mean you need to abandon procedural programming completely. Actually creating a mix of both styles can be good.
Objects should be used for representing data, usually residing in a database.
  1. class User {  
  2.   
  3.     public $username;  
  4.     public $first_name;  
  5.     public $last_name;  
  6.     public $email;  
  7.   
  8.     public function __construct() {  
  9.         // ...  
  10.     }  
  11.   
  12.     public function create() {  
  13.         // ...  
  14.     }  
  15.   
  16.     public function save() {  
  17.         // ...  
  18.     }  
  19.   
  20.     public function delete() {  
  21.         // ...  
  22.     }  
  23.   
  24. }  
Procedural functions may be used for specific tasks that can be performed independently.
  1. function capitalize($string) {  
  2.   
  3.     $ret = strtoupper($string[0]);  
  4.     $ret .= strtolower(substr($string,1));  
  5.     return $ret;  
  6.   
  7. }  

Object-Oriented Programming in PHP

Take your skills to the next level with this Premium video course.

15 - Read Open Source Code

Open Source projects are built with the input of many developers. These projects need to maintain a high level of code readability so that the team can work together as efficiently as possible. Therefore, it is a good idea to browse through the source code of these projects to observe what these developers are doing.

16 - Code Refactoring

When you “refactor,” you make changes to the code without changing any of its functionality. You can think of it like a “clean up,” for the sake of improving readability and quality.
This doesn’t include bug fixes or the addition of any new functionality. You might refactor code that you have written the day before, while it’s still fresh in your head, so that it is more readable and reusable when you may potentially look at it two months from now. As the motto says: “refactor early, refactor often.”
You may apply any of the “best practices” of code readability during the refactoring process.