INFRA-132 - CRM/Contribute - Misc
[civicrm-core.git] / CRM / Core / Page.php
index d90f98066eca206e04e5245753aaa2cb8b7b8c7c..561cb3dac2cef69d09253bf3f20b5e4ab800c312 100644 (file)
@@ -120,8 +120,10 @@ class CRM_Core_Page {
   /**
    * Class constructor
    *
-   * @param string $title title of the page
-   * @param int    $mode  mode of the page
+   * @param string $title
+   *   Title of the page.
+   * @param int $mode
+   *   Mode of the page.
    *
    * @return CRM_Core_Page
    */
@@ -165,7 +167,8 @@ class CRM_Core_Page {
    * pages. This typically involves assigning the appropriate
    * smarty variable :)
    *
-   * @return string The content generated by running this page
+   * @return string
+   *   The content generated by running this page
    */
   public function run() {
     if ($this->_embedded) {
@@ -243,8 +246,9 @@ class CRM_Core_Page {
   /**
    * Store the variable with the value in the form scope
    *
-   * @param  string|array $name  name  of the variable or an assoc array of name/value pairs
-   * @param  mixed        $value value of the variable if string
+   * @param string|array $name name of the variable or an assoc array of name/value pairs
+   * @param mixed $value
+   *   Value of the variable if string.
    *
    *
    * @return void
@@ -257,7 +261,7 @@ class CRM_Core_Page {
   /**
    * Get the variable from the form scope
    *
-   * @param  string name  : name  of the variable
+   * @param string name : name of the variable
    *
    *
    * @return mixed
@@ -271,7 +275,8 @@ class CRM_Core_Page {
    * Assign value to name in template
    *
    * @param string $var
-   * @param mixed $value value of varaible
+   * @param mixed $value
+   *   Value of varaible.
    *
    * @return void
    */
@@ -283,7 +288,8 @@ class CRM_Core_Page {
    * Assign value to name in template by reference
    *
    * @param string $var
-   * @param mixed $value (reference) value of varaible
+   * @param mixed $value
+   *   (reference) value of varaible.
    *
    * @return void
    */
@@ -295,10 +301,11 @@ class CRM_Core_Page {
    * Appends values to template variables
    *
    * @param array|string $tpl_var the template variable name(s)
-   * @param mixed $value the value to append
+   * @param mixed $value
+   *   The value to append.
    * @param bool $merge
    */
-  public function append($tpl_var, $value=NULL, $merge=FALSE) {
+  public function append($tpl_var, $value = NULL, $merge = FALSE) {
     self::$_template->append($tpl_var, $value, $merge);
   }
 
@@ -309,7 +316,7 @@ class CRM_Core_Page {
    *
    * @return array
    */
-  public function get_template_vars($name=null) {
+  public function get_template_vars($name = NULL) {
     return self::$_template->get_template_vars($name);
   }
 
@@ -358,7 +365,7 @@ class CRM_Core_Page {
   /**
    * Setter for embedded
    *
-   * @param boolean $embedded
+   * @param bool $embedded
    *
    * @return void
    */
@@ -378,7 +385,7 @@ class CRM_Core_Page {
   /**
    * Setter for print
    *
-   * @param boolean $print
+   * @param bool $print
    *
    * @return void
    */