CodingStyle.php

Go to the documentation of this file.

<?      
/* BSD style "{ }" handling. 4 tabs. */

class TranslationWordList implements Iterator
{
        private $DB;                    
        private $Tables;                
        function __construct()
        {
        }
        
        private function SplitToWords($text)
        {
                // Clear previous items
                unset($this->AllWords);
                $this->SetFakeLength(0);
                
                // Split to words
                $wordList = split('[ \.,()!\?:;=|*]', $text);
                
                foreach($wordList as $word)
                {
                        // Remove trash remained with split
                        $word = trim($word, " \t\n\r:[]#'\"$+-_<>/");

                        // Nonempty, nonnumbers
                        if($word != "" && !is_numeric($word))
                        {
                                $this->AddWord(strtolower($word));
                        }
                }


/* FUNCTION DEFINITION */

/* Function and class names names are UpperCamelCase */

        private function SplitToWords($text)


/* VARIABLE NAMES */

/* Function parameters (as being local variables) are  camelCase */

        private function SplitToWords($text)
        public function CreateProject($parentID, $name, $localeID, $document = '', $skeleton = '')

/* Function parameters must have type-hint for objects. */

        function ProcessDir(RecursiveDirectoryIterator $dirIterator, TranslationProject $parentProject)

/* Local variables are camelCase (like the function parameters) */

        $wordList = split('[ \.,()!\?:;=|*]', $text);
        $word = trim($word, " \t\n\r:[]#'\"$+-_<>/");
        $points = 0;

/* Class member variables and functions are UpperCamelCase */

        private $AllWords;
        private $CurrentIndex;
        
/* Reference to class member variables and functions starts with $this-> */
/* (This is a requirement in PHP, but would be optional in C#) */

        $this->SetFakeLength(0);
        $this->ParentID = $parentID;
        $this->Name = $name;

/* No meaningless variable names */

        $CardIsValid = $this->CheckCreditCard($CardNumber);

/* Bad: $valid = IsValid($number) */

/* Event handles based on the event sender control name and the event type */

        public btnNext_Clicked()
        {
        }

        
/* CODE SPACNIG */

/* No space next to parenthesis (unless it gets very messy). */

        foreach($wordList as $word)
        if($word != "" && !is_numeric($word))
        $this->AddWord(strtolower($word));

/* No single line "if" and "if" without curly bracket. Good: */

        if($w->GetID() == $id)
        {
                return $w;
        }
/*
Bad:    if($w->GetID() == $id) { return $w }

Bad:    if($w->GetID() == $id)
                        return $w;
*/

/* Qt WIDGETnotations */

        $vboxNameHere = new QVBoxLayout();
        $hboxNameHere = new QHBoxLayout();
        $gridNameHere = new QGridLayout();
        
        $btnNameHere = new QButton();
        $txtNameHere = new QTextEdit();
        $txtNameHere = new QLineEdit();
        $lblNameHere = new QLabel();
        $tblNameHere = new QTableWidget();
        
        $wNameHere = new QWidget(); // for window-building dummy widgets
?>