-<?php // $Id$
-
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/** TABLE_VAR_SORT = 1 */
define('TABLE_VAR_SORT', 1);
+/** TABLE_VAR_HIDE = 2 */
define('TABLE_VAR_HIDE', 2);
+/** TABLE_VAR_SHOW = 3 */
define('TABLE_VAR_SHOW', 3);
+/** TABLE_VAR_IFIRST = 4 */
define('TABLE_VAR_IFIRST', 4);
+/** TABLE_VAR_ILAST = 5 */
define('TABLE_VAR_ILAST', 5);
+/** TABLE_VAR_PAGE = 6 */
define('TABLE_VAR_PAGE', 6);
+/** TABLE_P_TOP = 1 */
define('TABLE_P_TOP', 1);
+/** TABLE_P_BOTTOM = 2 */
define('TABLE_P_BOTTOM', 2);
-
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class flexible_table {
var $uniqueid = NULL;
}
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_sql extends flexible_table{
public $countsql = NULL;
}
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_default_export_format_parent{
/**
* @var flexible_table or child class reference pointing to table class
}
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_spreadsheet_export_format_parent extends table_default_export_format_parent{
var $rownum;
var $workbook;
}
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_excel_export_format extends table_spreadsheet_export_format_parent{
var $fileextension = 'xls';
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_ods_export_format extends table_spreadsheet_export_format_parent{
var $fileextension = 'ods';
function define_workbook(){
}
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_text_export_format_parent extends table_default_export_format_parent{
var $seperator = "\t";
function start_document($filename){
}
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_tsv_export_format extends table_text_export_format_parent{
var $seperator = "\t";
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_csv_export_format extends table_text_export_format_parent{
var $seperator = ",";
}
+/**
+ * @package moodlecore
+ * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class table_xhtml_export_format extends table_default_export_format_parent{
function start_document($filename){
header("Content-Type: application/download\n");
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
+/** UPGRADE_LOG_NORMAL = 0 */
define('UPGRADE_LOG_NORMAL', 0);
+/** UPGRADE_LOG_NOTICE = 1 */
define('UPGRADE_LOG_NOTICE', 1);
+/** UPGRADE_LOG_ERROR = 2 */
define('UPGRADE_LOG_ERROR', 2);
/**
* Exception indicating unknown error during upgrade.
+ *
+ * @package moodlecore
+ * @subpackage upgrade
+ * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class upgrade_exception extends moodle_exception {
function __construct($plugin, $version) {
/**
* Exception indicating downgrade error during upgrade.
+ *
+ * @package moodlecore
+ * @subpackage upgrade
+ * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class downgrade_exception extends moodle_exception {
function __construct($plugin, $oldversion, $newversion) {
}
}
+/**
+ * @package moodlecore
+ * @subpackage upgrade
+ * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class upgrade_requires_exception extends moodle_exception {
function __construct($plugin, $pluginversion, $currentmoodle, $requiremoodle) {
global $CFG;
}
}
+/**
+ * @package moodlecore
+ * @subpackage upgrade
+ * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
class plugin_defective_exception extends moodle_exception {
function __construct($plugin, $details) {
global $CFG;
* Insert or update log display entry. Entry may already exist.
* $module, $action must be unique
*
+ * @global object
* @param string $module
* @param string $action
* @param string $mtable
* Please do not make large upgrade blocks with lots of operations,
* for example when adding tables keep only one table operation per block.
*
+ * @global object
* @param bool $result false if upgrade step failed, true if completed
* @param string or float $version main version
* @param bool $allowabort allow user to abort script execution here
* It stores module version, resets upgrade timeout
* and abort upgrade if user cancels page loading.
*
+ * @global object
* @param bool $result false if upgrade step failed, true if completed
* @param string or float $version main version
* @param string $modname name of module
* It stores block version, resets upgrade timeout
* and abort upgrade if user cancels page loading.
*
+ * @global object
* @param bool $result false if upgrade step failed, true if completed
* @param string or float $version main version
* @param string $blockname name of block
/**
* Upgrade plugins
*
- * @uses $CFG
+ * @global object
+ * @global object
* @param string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype')
* @param string $dir The directory where the plugins are located (e.g. 'question/questiontypes')
* @param string $return The url to prompt the user to continue to
/**
* Find and check all modules and load them up or upgrade them if necessary
+ *
+ * @global object
+ * @global object
*/
function upgrade_plugins_modules($startcallback, $endcallback) {
global $CFG, $DB;
/**
* This function finds all available blocks and install them
* into blocks table or do all the upgrade process if newer.
+ *
+ * @global object
+ * @global object
*/
function upgrade_plugins_blocks($startcallback, $endcallback) {
global $CFG, $DB;
* in a file called 'local/db/upgrade.php', and if it's there calls it with the
* appropiate $oldversion parameter. Then it updates $CFG->local_version.
*
- * @uses $CFG
+ * @global object
+ * @global object
*/
function upgrade_local_db($startcallback, $endcallback) {
global $CFG, $DB;
}
-////////////////////////////////////////////////
-/// upgrade logging functions
-////////////////////////////////////////////////
+/**
+ * upgrade logging functions
+ *
+ * @global object
+ */
function upgrade_handle_exception($ex, $plugin=null) {
global $CFG;
/**
* Adds log entry into upgrade_log table
*
+ * @global object
+ * @global object
+ * @global object
* @param int $type UPGRADE_LOG_NORMAL, UPGRADE_LOG_NOTICE or UPGRADE_LOG_ERROR
* @param string $plugin plugin or null if main
* @param string $info short description text of log entry
/**
* Marks start of upgrade, blocks any other access to site.
* The upgrade is finished at the end of script or after timeout.
+ *
+ * @global object
+ * @global object
+ * @global object
*/
function upgrade_started($preinstall=false) {
global $CFG, $DB, $PAGE;
* Indicates upgrade is finished.
*
* This function may be called repeatedly.
+ *
+ * @global object
+ * @global object
*/
function upgrade_finished($continueurl=null) {
global $CFG, $DB;
}
}
+/**
+ * @global object
+ * @global object
+ */
function upgrade_setup_debug($starting) {
global $CFG, $DB;
}
}
+/**
+ * @global object
+ */
function print_upgrade_reload($url) {
global $CFG;
}
}
+/**
+ * @global object
+ */
function upgrade_get_javascript() {
global $CFG;
return '<script type="text/javascript" src="'.$CFG->wwwroot.'/lib/scroll_to_page_end.js"></script>';
/**
* Try to upgrade the given language pack (or current language)
+ * @global object
*/
function upgrade_language_pack($lang='') {
global $CFG;
<?php
-/*
-About validateUrlSyntax():
- This function will verify if a http URL is formatted properly, returning
- either with true or false.
-
- I used rfc #2396 URI: Generic Syntax as my guide when creating the
- regular expression. For all the details see the comments below.
-
-
-Usage:
- validateUrlSyntax( url_to_check[, options])
-
- url_to_check - string - The url to check
-
- options - string - A optional string of options to set which parts of
- the url are required, optional, or not allowed. Each option
- must be followed by a "+" for required, "?" for optional, or
- "-" for not allowed.
-
- s - Scheme. Allows "+?-", defaults to "s?"
- H - http:// Allows "+?-", defaults to "H?"
- S - https:// (SSL). Allows "+?-", defaults to "S?"
- E - mailto: (email). Allows "+?-", defaults to "E-"
- F - ftp:// Allows "+?-", defaults to "F-"
- Dependant on scheme being enabled
- u - User section. Allows "+?-", defaults to "u?"
- P - Password in user section. Allows "+?-", defaults to "P?"
- Dependant on user section being enabled
- a - Address (ip or domain). Allows "+?-", defaults to "a+"
- I - Ip address. Allows "+?-", defaults to "I?"
- If I+, then domains are disabled
- If I-, then domains are required
- Dependant on address being enabled
- p - Port number. Allows "+?-", defaults to "p?"
- f - File path. Allows "+?-", defaults to "f?"
- q - Query section. Allows "+?-", defaults to "q?"
- r - Fragment (anchor). Allows "+?-", defaults to "r?"
-
- Paste the funtion code, or include_once() this template at the top of the page
- you wish to use this function.
-
-
-Examples:
- validateUrlSyntax('http://george@www.cnn.com/#top')
-
- validateUrlSyntax('https://games.yahoo.com:8080/board/chess.htm?move=true')
-
- validateUrlSyntax('http://www.hotmail.com/', 's+u-I-p-q-r-')
-
- validateUrlSyntax('/directory/file.php#top', 's-u-a-p-f+')
-
-
- if (validateUrlSyntax('http://www.canowhoopass.com/', 'u-'))
- {
- echo 'URL SYNTAX IS VERIFIED';
- } else {
- echo 'URL SYNTAX IS ILLEGAL';
- }
-
-
-Last Edited:
- December 15th 2004
-
-
-Changelog:
- December 15th 2004
- -Added new TLD's - .jobs, .mobi, .post and .travel. They are official, but not yet active.
-
- August 31th 2004
- -Fixed bug allowing empty username even when it was required
- -Changed and added a few options to add extra schemes
- -Added mailto: ftp:// and http:// options
- -https option was 'l' now it is 'S' (capital)
- -Added password option. Now passwords can be disabled while usernames are ok (for email)
- -IP Address option was 'i' now it is 'I' (capital)
- -Options are now case sensitive
- -Added validateEmailSyntax() and validateFtpSyntax() functions below<br>
-
- August 27th, 2004
- -IP group range is more specific. Used to allow 0-299. Now it is 0-255
- -Port range more specific. Used to allow 0-69999. Now it is 0-65535<br>
- -Fixed bug disallowing 'i-' option.<br>
- -Changed license to GPL
-
- July 8th, 2004
- -Fixed bug disallowing 'l-' option. Thanks Dr. Cheap
-
- June 15, 2004
- -Added options parameter to make it easier for people to plug the function in
- without needed to rework the code.
- -Split the example application away from the function
-
- June 1, 2004
- -Complete rewrite
- -Now more modular
- -Easier to disable sections
- -Easier to port to other languages
- -Easier to port to verify email addresses
- -Uses only simple regular expressions so it is more portable
- -Follows RFC closer for domain names. Some "play" domains may break
- -Renamed from 'verifyUrl()' to 'validateUrlSyntax()'
- -Removed extra code which added 'http://' and trailing '/' if it was missing
- -That code was better suited for a massaging function, not verifying
- -Bug fixes:
- -Now splits up and forces '/path?query#fragment' order
- -No longer requires a path when using a query or fragment
-
- August 29, 2003
- -Allowed port numbers above 9999. Now allows up to 69999
-
- Sometime, 2002
- -Added new top level domains
- -aero, coop, museum, name, info, biz, pro
-
- October 5, 2000
- -First Version
-
-
-Intentional Limitations:
- -Does not verify url actually exists. Only validates the syntax
- -Strictly follows the RFC standards. Some urls exist in the wild which will
- not validate. Including ones with square brackets in the query section '[]'
-
-
-Known Problems:
- -None at this time
-
-
-Author(s):
- Rod Apeldoorn - rod(at)canowhoopass(dot)com
-
-
-Homepage:
- http://www.canowhoopass.com/
-
-
-Thanks!:
- -WEAV -Several members of Weav helped to test - http://weav.bc.ca/
- -There were also a number of emails from other developers expressing
- thanks and suggestions. It is nice to be appreciated. Thanks!
-
-
-License:
- Copyright 2004, Rod Apeldoorn
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or (at
- your option) any later version.
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-
- To view the license online, go to: http://www.gnu.org/copyleft/gpl.html
-
-
-Alternate Commercial Licenses:
- For information in regards to alternate licensing, contact me.
-*/
-
-
-// BEGINNING OF validateUrlSyntax() function
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * About validateUrlSyntax():
+ * This function will verify if a http URL is formatted properly, returning
+ * either with true or false.
+ *
+ * I used rfc #2396 URI: Generic Syntax as my guide when creating the
+ * regular expression. For all the details see the comments below.
+ *
+ * Usage:
+ * validateUrlSyntax( url_to_check[, options])
+ *
+ * url_to_check - string - The url to check
+ *
+ * options - string - A optional string of options to set which parts of
+ * the url are required, optional, or not allowed. Each option
+ * must be followed by a "+" for required, "?" for optional, or
+ * "-" for not allowed.
+ *
+ * s - Scheme. Allows "+?-", defaults to "s?"
+ * H - http:// Allows "+?-", defaults to "H?"
+ * S - https:// (SSL). Allows "+?-", defaults to "S?"
+ * E - mailto: (email). Allows "+?-", defaults to "E-"
+ * F - ftp:// Allows "+?-", defaults to "F-"
+ * Dependant on scheme being enabled
+ * u - User section. Allows "+?-", defaults to "u?"
+ * P - Password in user section. Allows "+?-", defaults to "P?"
+ * Dependant on user section being enabled
+ * a - Address (ip or domain). Allows "+?-", defaults to "a+"
+ * I - Ip address. Allows "+?-", defaults to "I?"
+ * If I+, then domains are disabled
+ * If I-, then domains are required
+ * Dependant on address being enabled
+ * p - Port number. Allows "+?-", defaults to "p?"
+ * f - File path. Allows "+?-", defaults to "f?"
+ * q - Query section. Allows "+?-", defaults to "q?"
+ * r - Fragment (anchor). Allows "+?-", defaults to "r?"
+ *
+ * Paste the funtion code, or include_once() this template at the top of the page
+ * you wish to use this function.
+ *
+ *
+ * Examples:
+ * <code>
+ * validateUrlSyntax('http://george@www.cnn.com/#top')
+ *
+ * validateUrlSyntax('https://games.yahoo.com:8080/board/chess.htm?move=true')
+ *
+ * validateUrlSyntax('http://www.hotmail.com/', 's+u-I-p-q-r-')
+ *
+ * validateUrlSyntax('/directory/file.php#top', 's-u-a-p-f+')
+ *
+ *
+ * if (validateUrlSyntax('http://www.canowhoopass.com/', 'u-'))
+ * {
+ * echo 'URL SYNTAX IS VERIFIED';
+ * } else {
+ * echo 'URL SYNTAX IS ILLEGAL';
+ * }
+ * </code>
+ *
+ * Last Edited:
+ * December 15th 2004
+ *
+ *
+ * Changelog:
+ * December 15th 2004
+ * -Added new TLD's - .jobs, .mobi, .post and .travel. They are official, but not yet active.
+ *
+ * August 31th 2004
+ * -Fixed bug allowing empty username even when it was required
+ * -Changed and added a few options to add extra schemes
+ * -Added mailto: ftp:// and http:// options
+ * -https option was 'l' now it is 'S' (capital)
+ * -Added password option. Now passwords can be disabled while usernames are ok (for email)
+ * -IP Address option was 'i' now it is 'I' (capital)
+ * -Options are now case sensitive
+ * -Added validateEmailSyntax() and validateFtpSyntax() functions below<br>
+ *
+ * August 27th, 2004
+ * -IP group range is more specific. Used to allow 0-299. Now it is 0-255
+ * -Port range more specific. Used to allow 0-69999. Now it is 0-65535<br>
+ * -Fixed bug disallowing 'i-' option.<br>
+ * -Changed license to GPL
+ *
+ * July 8th, 2004
+ * -Fixed bug disallowing 'l-' option. Thanks Dr. Cheap
+ *
+ * June 15, 2004
+ * -Added options parameter to make it easier for people to plug the function in
+ * without needed to rework the code.
+ * -Split the example application away from the function
+ *
+ * June 1, 2004
+ * -Complete rewrite
+ * -Now more modular
+ * -Easier to disable sections
+ * -Easier to port to other languages
+ * -Easier to port to verify email addresses
+ * -Uses only simple regular expressions so it is more portable
+ * -Follows RFC closer for domain names. Some "play" domains may break
+ * -Renamed from 'verifyUrl()' to 'validateUrlSyntax()'
+ * -Removed extra code which added 'http://' and trailing '/' if it was missing
+ * -That code was better suited for a massaging function, not verifying
+ * -Bug fixes:
+ * -Now splits up and forces '/path?query#fragment' order
+ * -No longer requires a path when using a query or fragment
+ *
+ * August 29, 2003
+ * -Allowed port numbers above 9999. Now allows up to 69999
+ *
+ * Sometime, 2002
+ * -Added new top level domains
+ * -aero, coop, museum, name, info, biz, pro
+ *
+ * October 5, 2000
+ * -First Version
+ *
+ *
+ * Intentional Limitations:
+ * -Does not verify url actually exists. Only validates the syntax
+ * -Strictly follows the RFC standards. Some urls exist in the wild which will
+ * not validate. Including ones with square brackets in the query section '[]'
+ *
+ *
+ * Known Problems:
+ * -None at this time
+ *
+ *
+ * Author(s):
+ * Rod Apeldoorn - rod(at)canowhoopass(dot)com
+ *
+ *
+ * Homepage:
+ * http://www.canowhoopass.com/
+ *
+ *
+ * Thanks!:
+ * -WEAV -Several members of Weav helped to test - http://weav.bc.ca/
+ * -There were also a number of emails from other developers expressing
+ * thanks and suggestions. It is nice to be appreciated. Thanks!
+ *
+ * Alternate Commercial Licenses:
+ * For information in regards to alternate licensing, contact me.
+ *
+ * @package moodlecore
+ * @copyright Copyright 2004, Rod Apeldoorn {@link http://www.canowhoopass.com/}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * BEGINNING OF validateUrlSyntax() function
+ */
function validateUrlSyntax( $urladdr, $options="" ){
// Force Options parameter to be lower case
-/*
-About ValidateEmailSyntax():
- This function uses the ValidateUrlSyntax() function to easily check the
- syntax of an email address. It accepts the same options as ValidateURLSyntax
- but defaults them for email addresses.
-
-
-Usage:
- validateEmailSyntax( url_to_check[, options])
-
- url_to_check - string - The url to check
-
- options - string - A optional string of options to set which parts of
- the url are required, optional, or not allowed. Each option
- must be followed by a "+" for required, "?" for optional, or
- "-" for not allowed. See ValidateUrlSyntax() docs for option list.
-
- The default options are changed to:
- s-H-S-E+F-u+P-a+I-p-f-q-r-
-
- This only allows an address of "name@domain".
-
-Examples:
- validateEmailSyntax('george@fakemail.com')
- validateEmailSyntax('mailto:george@fakemail.com', 's+')
- validateEmailSyntax('george@fakemail.com?subject=Hi%20George', 'q?')
- validateEmailSyntax('george@212.198.33.12', 'I?')
-
-
-
-Author(s):
- Rod Apeldoorn - rod(at)canowhoopass(dot)com
-
-
-Homepage:
- http://www.canowhoopass.com/
-
-
-License:
- Copyright 2004 - Rod Apeldoorn
-
- Released under same license as validateUrlSyntax(). For details, contact me.
-
-
-*/
+/**
+ * About ValidateEmailSyntax():
+ * This function uses the ValidateUrlSyntax() function to easily check the
+ * syntax of an email address. It accepts the same options as ValidateURLSyntax
+ * but defaults them for email addresses.
+ *
+ *
+ * Usage:
+ * <code>
+ * validateEmailSyntax( url_to_check[, options])
+ * </code>
+ * url_to_check - string - The url to check
+ *
+ * options - string - A optional string of options to set which parts of
+ * the url are required, optional, or not allowed. Each option
+ * must be followed by a "+" for required, "?" for optional, or
+ * "-" for not allowed. See ValidateUrlSyntax() docs for option list.
+ *
+ * The default options are changed to:
+ * s-H-S-E+F-u+P-a+I-p-f-q-r-
+ *
+ * This only allows an address of "name@domain".
+ *
+ * Examples:
+ * <code>
+ * validateEmailSyntax('george@fakemail.com')
+ * validateEmailSyntax('mailto:george@fakemail.com', 's+')
+ * validateEmailSyntax('george@fakemail.com?subject=Hi%20George', 'q?')
+ * validateEmailSyntax('george@212.198.33.12', 'I?')
+ * </code>
+ *
+ *
+ * Author(s):
+ * Rod Apeldoorn - rod(at)canowhoopass(dot)com
+ *
+ *
+ * Homepage:
+ * http://www.canowhoopass.com/
+ *
+ *
+ * License:
+ * Copyright 2004 - Rod Apeldoorn
+ *
+ * Released under same license as validateUrlSyntax(). For details, contact me.
+ */
function validateEmailSyntax( $emailaddr, $options="" ){
-/*
-About ValidateFtpSyntax():
- This function uses the ValidateUrlSyntax() function to easily check the
- syntax of an FTP address. It accepts the same options as ValidateURLSyntax
- but defaults them for FTP addresses.
-
-
-Usage:
- validateFtpSyntax( url_to_check[, options])
-
- url_to_check - string - The url to check
-
- options - string - A optional string of options to set which parts of
- the url are required, optional, or not allowed. Each option
- must be followed by a "+" for required, "?" for optional, or
- "-" for not allowed. See ValidateUrlSyntax() docs for option list.
-
- The default options are changed to:
- s?H-S-E-F+u?P?a+I?p?f?q-r-
-
-Examples:
- validateFtpSyntax('ftp://netscape.com')
- validateFtpSyntax('moz:iesucks@netscape.com')
- validateFtpSyntax('ftp://netscape.com:2121/browsers/ns7/', 'u-')
-
-
-Author(s):
- Rod Apeldoorn - rod(at)canowhoopass(dot)com
-
-
-Homepage:
- http://www.canowhoopass.com/
-
-
-License:
- Copyright 2004 - Rod Apeldoorn
-
- Released under same license as validateUrlSyntax(). For details, contact me.
-*/
+/**
+ * About ValidateFtpSyntax():
+ * This function uses the ValidateUrlSyntax() function to easily check the
+ * syntax of an FTP address. It accepts the same options as ValidateURLSyntax
+ * but defaults them for FTP addresses.
+ *
+ *
+ * Usage:
+ * <code>
+ * validateFtpSyntax( url_to_check[, options])
+ * </code>
+ * url_to_check - string - The url to check
+ *
+ * options - string - A optional string of options to set which parts of
+ * the url are required, optional, or not allowed. Each option
+ * must be followed by a "+" for required, "?" for optional, or
+ * "-" for not allowed. See ValidateUrlSyntax() docs for option list.
+ *
+ * The default options are changed to:
+ * s?H-S-E-F+u?P?a+I?p?f?q-r-
+ *
+ * Examples:
+ * <code>
+ * validateFtpSyntax('ftp://netscape.com')
+ * validateFtpSyntax('moz:iesucks@netscape.com')
+ * validateFtpSyntax('ftp://netscape.com:2121/browsers/ns7/', 'u-')
+ * </code>
+ *
+ * Author(s):
+ * Rod Apeldoorn - rod(at)canowhoopass(dot)com
+ *
+ *
+ * Homepage:
+ * http://www.canowhoopass.com/
+ *
+ *
+ * License:
+ * Copyright 2004 - Rod Apeldoorn
+ *
+ * Released under same license as validateUrlSyntax(). For details, contact me.
+ */
function validateFtpSyntax( $ftpaddr, $options="" ){
projects / moodle.git / commitdiff