Changeset 214 for trunk/docs/coding_standards.txt

Timestamp:

Dec 12, 2006 12:28:01 AM (17 years ago)

Author:

quinn

Message:

Q - Final check-in before releasing trunk as version 2.1

File:

• trunk/docs/coding_standards.txt (modified) (5 diffs)

trunk/docs/coding_standards.txt

@@ -7 +7 @@
 ======================================================================
 
-We're following the PEAR coding standards, with minor modifications.
-
-This is essential reading:
+Our standards follow closely the PEAR coding standards.
+
+Essential reading:
 http://pear.php.net/manual/en/standards.php
 
@@ -24 +24 @@
                         remains "Auth_SQL"
 
-some_file.ihtml         HTML file, which may or may not have some PHP,
+some_file.inc.html      HTML file, which may or may not have some PHP,
                         but will be included by some other PHP file. Never
                         includes sensitive code as these files may be accessed
@@ -30 +30 @@
 
 script.cli.php          A command-line executable script, possibly executed
-                        with CRON, usually outputs TEXT, not HTML.
-
-dbname.mysql            Database schema file that goes with the application.
+                        with CRON. Outputs TEXT if any instead of HTML.
+
+schema.mysql            Database schema file that goes with the application.
 
 main.screen.css         CSS file with media: screen/print/all
@@ -182 +182 @@
         // Here comes the HTML...
         ?>
-        <div align="right" class="sc-tiny">
-        [&nbsp;<a href="<?php echo $app->oHREF('contact.php') ?>">Contact us</a>&nbsp;]
+        <div class="sc-tiny">
+            <a href="<?php echo $app->ohref('/contact.php') ?>">Contact us</a>
         </div>
         <?php
@@ -200 +200 @@
 http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html
 
+Here is an example of the codebase method Email::validEmail():
+
     <?php
     /**
-     * Description of function.
+     * Validates an email address based on the recommendations in RFC 3696.
+     * Is more loose than restrictive, to allow the many valid variants of
+     * email addresses while catching the most common mistakes. Checks an array too.
+     * http://www.faqs.org/rfcs/rfc822.html
+     * http://www.faqs.org/rfcs/rfc2822.html
+     * http://www.faqs.org/rfcs/rfc3696.html
+     * http://www.faqs.org/rfcs/rfc1035.html
      *
      * @access  public
-     * @param   string  $db_table   Database table.
-     * @param   string  $db_column  Database column containing set or enum datatype.
-     * @return  array               The set/enum values or false on failure.
+     * @param   mixed  $email  Address to check, string or array.
+     * @return  bool    Validity of address.
      * @author  Quinn Comendant <quinn@strangecode.com>
-     * @version 1.0
-     * @since   24 Feb 2004 19:34:04
+     * @since   30 Nov 2005 22:00:50
      */
-    function getSetEnumFieldValues()
+    function validEmail($email)
     {
-        $db =& DB::getInstance();
-        
-        $qid = $db->query("SHOW COLUMNS FROM $db_table LIKE '$db_col'",false);
-
-        $row = mysql_fetch_row($qid);
-        if (preg_match('/^enum|^set/i', $row[1]) && preg_match_all("/'([^']*)'/", $row[1], $match)) {
-            return $match[1];
+        $app =& App::getInstance();
+    
+        // If an array, check values recursively.
+        if (is_array($email)) {
+            foreach ($email as $e) {
+                if (!$this->validEmail($e)) {
+                    return false;
+                }
+            }
+            return true;
         } else {
-            return false;
+            // To be valid email address must match regex and fit within the lenth constraints.
+            if (preg_match($this->getParam('regex'), $email, $e_parts) && strlen($e_parts[2]) < 64 && strlen($e_parts[3]) < 255) {
+                return true;
+            } else {
+                $app->logMsg(sprintf('Invalid email: %s', $email), LOG_INFO, __FILE__, __LINE__);
+                return false;
+            }
         }
     }