Merge pull request #5714 from colemanw/uiSelect
[civicrm-core.git] / CRM / Utils / ICalendar.php
index 120bfbb138c2a9cf54bc3dbfc4e20a84df5cdc9e..096ce70f7613bd45f648d32909ac526ec68b3af8 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_Utils_ICalendar {
 
   /**
-   * Escape text elements for safe ICalendar use
-   *
-   * @param $text Text to escape
+   * Escape text elements for safe ICalendar use.
    *
-   * @return  Escaped text
+   * @param $text
+   *   Text to escape.
    *
+   * @return string
+   *   Escaped text
    */
   public static function formatText($text) {
     $text = strip_tags($text);
@@ -62,13 +63,15 @@ class CRM_Utils_ICalendar {
   }
 
   /**
-   * Escape date elements for safe ICalendar use
+   * Escape date elements for safe ICalendar use.
    *
-   * @param $date Date to escape
+   * @param $date
+   *   Date to escape.
    *
    * @param bool $gdata
    *
-   * @return  Escaped date
+   * @return string
+   *   Escaped date
    */
   public static function formatDate($date, $gdata = FALSE) {
 
@@ -91,11 +94,15 @@ class CRM_Utils_ICalendar {
    * - 'text/xml'      : used for gData or rss formatted feeds
    *
    *
-   * @param string $calendar The calendar data to be published.
+   * @param string $calendar
+   *   The calendar data to be published.
    * @param string $content_type
-   * @param string $charset The character set to use, defaults to 'us-ascii'.
-   * @param string $fileName The file name (for downloads)
-   * @param string $disposition How the file should be sent ('attachment' for downloads)
+   * @param string $charset
+   *   The character set to use, defaults to 'us-ascii'.
+   * @param string $fileName
+   *   The file name (for downloads).
+   * @param string $disposition
+   *   How the file should be sent ('attachment' for downloads).
    *
    * @return void
    */
@@ -116,4 +123,5 @@ class CRM_Utils_ICalendar {
 
     echo $calendar;
   }
+
 }