+--------------------------------------------------------------------+
| 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$
*
*/
protected $_name;
/**
- * The title associated with this page
+ * The title associated with this page.
*
* @var object
*/
public $useLivePageJS;
/**
- * Class constructor
+ * Class constructor.
*
* @param string $title
* Title of the page.
/**
* This function takes care of all the things common to all
- * pages. This typically involves assigning the appropriate
- * smarty variable :)
+ * pages. This typically involves assigning the appropriate smarty
+ * variable :)
*
- * @return string
+ * @return void|string
* The content generated by running this page
*/
public function run() {
if ($this->_embedded) {
- return;
+ return NULL;
}
self::$_template->assign('mode', $this->_mode);
CRM_Core_Smarty::PRINT_SNIPPET,
CRM_Core_Smarty::PRINT_PDF,
CRM_Core_Smarty::PRINT_NOFORM,
- CRM_Core_Smarty::PRINT_JSON
+ CRM_Core_Smarty::PRINT_JSON,
))) {
$content = self::$_template->fetch('CRM/common/snippet.tpl');
}
CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
echo CRM_Utils_System::theme($content, $this->_print);
- return;
}
/**
- * Store the variable with the value in the form scope
+ * 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
}
/**
- * Get the variable from the form scope
- *
- * @param string name : name of the variable
+ * Get the variable from the form scope.
*
+ * @param string $name name of the variable
*
* @return mixed
*/
}
/**
- * Assign value to name in template
+ * Assign value to name in template.
*
* @param string $var
* @param mixed $value
}
/**
- * Assign value to name in template by reference
+ * Assign value to name in template by reference.
*
* @param string $var
* @param mixed $value
}
/**
- * Appends values to template variables
+ * Appends values to template variables.
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value
}
/**
- * Returns an array containing template variables
+ * Returns an array containing template variables.
*
* @param string $name
*
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
public function getTemplateFileName() {
- return str_replace('_',
- DIRECTORY_SEPARATOR,
- CRM_Utils_System::getClassName($this)
+ return strtr(
+ CRM_Utils_System::getClassName($this),
+ array(
+ '_' => DIRECTORY_SEPARATOR,
+ '\\' => DIRECTORY_SEPARATOR,
+ )
) . '.tpl';
}
}
/**
- * Setter for embedded
+ * Setter for embedded.
*
* @param bool $embedded
*
}
/**
- * Getter for embedded
+ * Getter for embedded.
*
- * @return boolean
+ * @return bool
* return the embedded value
*/
public function getEmbedded() {
}
/**
- * Setter for print
+ * Setter for print.
*
* @param bool $print
*
}
/**
- * Getter for print
+ * Getter for print.
*
- * @return boolean
+ * @return bool
* return the print value
*/
public function getPrint() {
public function setVar($name, $value) {
$this->$name = $value;
}
+
}