From 2c24c46cd1b4ec6a461acff91ea64ba0e9335484 Mon Sep 17 00:00:00 2001 From: Eike Foken Date: Tue, 20 Sep 2011 01:30:22 +0200 Subject: [PATCH] Fix helper comments and PHPDoc for better tooltips in eclipse --- application/helpers/MY_date_helper.php | 133 ++++++++++---------- application/helpers/MY_directory_helper.php | 37 +++++- application/helpers/MY_form_helper.php | 2 +- application/helpers/MY_language_helper.php | 41 ++++-- application/helpers/asset_helper.php | 24 ++++ application/helpers/hash_helper.php | 46 +++++-- 6 files changed, 187 insertions(+), 96 deletions(-) diff --git a/application/helpers/MY_date_helper.php b/application/helpers/MY_date_helper.php index df91804..6f0287f 100644 --- a/application/helpers/MY_date_helper.php +++ b/application/helpers/MY_date_helper.php @@ -1,83 +1,82 @@ - */ -// ------------------------------------------------------------------------ - -/** - * CodeIgniter Date Helpers - * - * @package CodeIgniter - * @subpackage Helpers - * @category Helpers - * @author ExpressionEngine Dev Team - * @link http://codeigniter.com/user_guide/helpers/date_helper.html - */ - -// ------------------------------------------------------------------------ - -/** - * Get "now" time formatted for MySQL - * - * Returns time() formatted for direct insertion into a DATETIME field. - * - * @access public - * @return integer - */ -if ( ! function_exists('mysql_now')) -{ - function mysql_now() - { +if (!function_exists('mysql_now')) { + /** + * Get "now" time formatted for MySQL. + * + * Returns time() formatted for direct insertion into a DATETIME field. + * + * @return integer + */ + function mysql_now() { return mdate('%Y-%m-%d %H:%i:%s', now()); } } -/** - * Function to calculate date or time difference. - * - * Function to calculate date or time difference. Returns an array or - * false on error. - * - * @author J de Silva - * @copyright Copyright © 2005, J de Silva - * @link http://www.gidnetwork.com/b-16.html Get the date / time difference with PHP - * @param string $start - * @param string $end - * @return array - */ -if ( ! function_exists('time_diff')) -{ - function time_diff($start, $end) - { +if (!function_exists('time_diff')) { + /** + * Calculates a date or time difference. + * + * @author J de Silva + * @copyright Copyright © 2005, J de Silva + * @link http://www.gidnetwork.com/b-16.html + * @param string $start + * @param string $end + * @return mixed Returns the difference as integer or FALSE on error. + */ + function time_diff($start, $end) { $uts['start'] = strtotime($start); $uts['end'] = strtotime($end); if ($uts['start'] !== -1 && $uts['end'] !== -1) { if ($uts['end'] >= $uts['start']) { $diff = $uts['end'] - $uts['start']; $diff = intval($diff); - return ($diff); + return $diff; } } - return (false); + return false; } } -/** - * Function to convert seconds to a pretty string. - * - * @author Karsten Heiken - * @param integer $secs the amount of seconds - * @param boolean $includeseconds should seconds be appended to the string? - * @return string - */ -if ( ! function_exists('prettyTime')) -{ - function prettyTime($secs, $includeseconds = false) - { - +if (!function_exists('prettyTime')) { + /** + * Converts seconds to a pretty string. + * + * @author Karsten Heiken + * @param integer $secs The amount of seconds + * @param boolean $includeseconds Should seconds be appended to the string? + * @return string + */ + function prettyTime($secs, $includeseconds = false) { if(!defined('SECOND')) define("SECOND", 1); if(!defined('MINUTE')) define("MINUTE", 60 * SECOND); if(!defined('HOUR')) define("HOUR", 60 * MINUTE); @@ -112,15 +111,15 @@ if ( ! function_exists('prettyTime')) } } -/** - * Parses any english textual datetime description into a relative date string. - * - * @author Eike Foken - * @param string $date - * @param boolean $show_seconds - * @return string - */ if (!function_exists('relative_time')) { + /** + * Parses any english textual datetime description into a relative date string. + * + * @author Eike Foken + * @param string $date + * @param boolean $show_seconds + * @return string + */ function relative_time($date, $show_seconds = false) { $diff = time() - strtotime($date); diff --git a/application/helpers/MY_directory_helper.php b/application/helpers/MY_directory_helper.php index a476283..7fe2b2c 100644 --- a/application/helpers/MY_directory_helper.php +++ b/application/helpers/MY_directory_helper.php @@ -1,17 +1,42 @@ + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. */ /** - * Creates a directory if it not already exists. Works recursively. + * Extends CI's directory helpers. * - * @param string $path Path to the directory to create - * @return boolean + * @package ScattPort + * @subpackage Helpers + * @author Eike Foken */ + if (!function_exists('mkdirs')) { + /** + * Recursively creates a directory if it not already exists. + * + * @param string $path + * @param integer $mode + * @return boolean Returns TRUE on success or FALSE on failure. + */ function mkdirs($path, $mode = 0777) { if (!is_dir($path)) { $old_umask = umask(0); diff --git a/application/helpers/MY_form_helper.php b/application/helpers/MY_form_helper.php index a07b0bd..3234974 100644 --- a/application/helpers/MY_form_helper.php +++ b/application/helpers/MY_form_helper.php @@ -1,6 +1,6 @@ + * Copyright (c) 2011 Karsten Heiken, Eike Foken * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal diff --git a/application/helpers/MY_language_helper.php b/application/helpers/MY_language_helper.php index a775522..4fa33d5 100644 --- a/application/helpers/MY_language_helper.php +++ b/application/helpers/MY_language_helper.php @@ -1,19 +1,41 @@ - + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. */ /** - * Generates a link for language selection. + * Extends CI's Language helpers. * - * @access public - * @param string $img_folder Folder of the images for the language selection - * @param boolean $index_page Should index_page be added to the JavaScript path - * @return string + * @package ScattPort + * @subpackage Helpers + * @author Eike Foken */ + if (!function_exists('lang_select')) { + /** + * Generates a link for changing the language. + * + * @param string $img_folder The folder containing flags for the language selection + * @return string The generated link + */ function lang_select($img_folder = '') { $CI =& get_instance(); @@ -37,4 +59,3 @@ if (!function_exists('lang_select')) { /* End of file MY_language_helper.php */ /* Location: ./application/helpers/MY_language_helper.php */ - diff --git a/application/helpers/asset_helper.php b/application/helpers/asset_helper.php index bbdb360..2af373b 100644 --- a/application/helpers/asset_helper.php +++ b/application/helpers/asset_helper.php @@ -1,7 +1,31 @@ */ diff --git a/application/helpers/hash_helper.php b/application/helpers/hash_helper.php index 0b977ae..fb40d24 100644 --- a/application/helpers/hash_helper.php +++ b/application/helpers/hash_helper.php @@ -1,23 +1,45 @@ - + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. */ /** - * Generate a pseudo-random SHA1-hash. + * Helper for generating hash values. * - * @access public - * @return integer + * @package ScattPort + * @subpackage Helpers + * @author Karsten Heiken */ -if ( ! function_exists('random_hash')) -{ - function random_hash($len = 40) - { + +if (!function_exists('random_hash')) { + /** + * Generates a pseudo-random SHA1-hash. + * + * @param integer $len + * @return integer + */ + function random_hash($len = 40) { return substr(sha1(rand(1,1000).now().rand(1001,2000)), 0, $len); } } /* End of file MY_date_helper.php */ -/* Location: ./application/helpers/MY_date_helper.php */ \ No newline at end of file +/* Location: ./application/helpers/MY_date_helper.php */