CRM/Core/Page.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * A Page is basically data in a nice pretty format.
  20  *
  21  * Pages should not have any form actions / elements in them. If they
  22  * do, make sure you use CRM_Core_Form and the related structures. You can
  23  * embed simple forms in Page and do your own form handling.
  24  *
  25  */
  26 class CRM_Core_Page {
  27
  28   /**
  29    * The name of the page (auto generated from class name)
  30    *
  31    * @var string
  32    */
  33   protected $_name;
  34
  35   /**
  36    * The title associated with this page.
  37    *
  38    * @var object
  39    */
  40   protected $_title;
  41
  42   /**
  43    * A page can have multiple modes. (i.e. displays
  44    * a different set of data based on the input
  45    * @var int
  46    */
  47   protected $_mode;
  48
  49   /**
  50    * Is this object being embedded in another object. If
  51    * so the display routine needs to not do any work. (The
  52    * parent object takes care of the display)
  53    *
  54    * @var bool
  55    */
  56   protected $_embedded = FALSE;
  57
  58   /**
  59    * Are we in print mode? if so we need to modify the display
  60    * functionality to do a minimal display :)
  61    *
  62    * @var bool
  63    */
  64   protected $_print = FALSE;
  65
  66   /**
  67    * Cache the smarty template for efficiency reasons
  68    *
  69    * @var CRM_Core_Smarty
  70    */
  71   static protected $_template;
  72
  73   /**
  74    * Cache the session for efficiency reasons
  75    *
  76    * @var CRM_Core_Session
  77    */
  78   static protected $_session;
  79
  80   /**
  81    * What to return to the client if in ajax mode (snippet=json)
  82    *
  83    * @var array
  84    */
  85   public $ajaxResponse = [];
  86
  87   /**
  88    * Url path used to reach this page
  89    *
  90    * @var array
  91    */
  92   public $urlPath = [];
  93
  94   /**
  95    * Should crm.livePage.js be added to the page?
  96    * @var bool
  97    */
  98   public $useLivePageJS;
  99
 100   /**
 101    * Variables smarty expects to have set.
 102    *
 103    * We ensure these are assigned (value = NULL) when Smarty is instantiated in
 104    * order to avoid e-notices / having to use empty or isset in the template layer.
 105    *
 106    * @var string[]
 107    */
 108   public $expectedSmartyVariables = [
 109     'breadcrumb',
 110     'pageTitle',
 111     'isForm',
 112     'hookContent',
 113     'hookContentPlacement',
 114     // required for footer.tpl
 115     'contactId',
 116     // required for info.tpl
 117     'infoMessage',
 118     'infoTitle',
 119     'infoType',
 120     'infoOptions',
 121     // required for Summary.tpl (contact summary) but seems
 122     // likely to be used more broadly to warrant inclusion here.
 123     'context',
 124   ];
 125
 126   /**
 127    * Class constructor.
 128    *
 129    * @param string $title
 130    *   Title of the page.
 131    * @param int $mode
 132    *   Mode of the page.
 133    *
 134    * @return CRM_Core_Page
 135    */
 136   public function __construct($title = NULL, $mode = NULL) {
 137     $this->_name = CRM_Utils_System::getClassName($this);
 138     $this->_title = $title;
 139     $this->_mode = $mode;
 140
 141     // let the constructor initialize this, should happen only once
 142     if (!isset(self::$_template)) {
 143       self::$_template = CRM_Core_Smarty::singleton();
 144       self::$_session = CRM_Core_Session::singleton();
 145     }
 146     // Smarty $_template is a static var which persists between tests, so
 147     // if something calls clearTemplateVars(), the static still exists but
 148     // our ensured variables get blown away, so we need to set them even if
 149     // it's already been initialized.
 150     self::$_template->ensureVariablesAreAssigned($this->expectedSmartyVariables);
 151
 152     // FIXME - why are we messing with 'snippet'? Why not just pass it directly into $this->_print?
 153     if (!empty($_REQUEST['snippet'])) {
 154       if ($_REQUEST['snippet'] == CRM_Core_Smarty::PRINT_PDF) {
 155         $this->_print = CRM_Core_Smarty::PRINT_PDF;
 156       }
 157       // FIXME - why does this number not match the constant?
 158       elseif ($_REQUEST['snippet'] == 5) {
 159         $this->_print = CRM_Core_Smarty::PRINT_NOFORM;
 160       }
 161       // Support 'json' as well as legacy value '6'
 162       elseif (in_array($_REQUEST['snippet'], [CRM_Core_Smarty::PRINT_JSON, 6])) {
 163         $this->_print = CRM_Core_Smarty::PRINT_JSON;
 164       }
 165       else {
 166         $this->_print = CRM_Core_Smarty::PRINT_SNIPPET;
 167       }
 168     }
 169
 170     // if the request has a reset value, initialize the controller session
 171     if (!empty($_REQUEST['reset'])) {
 172       $this->reset();
 173     }
 174   }
 175
 176   /**
 177    * This function takes care of all the things common to all pages.
 178    *
 179    * This typically involves assigning the appropriate smarty variables :)
 180    */
 181   public function run() {
 182     if ($this->_embedded) {
 183       return NULL;
 184     }
 185
 186     self::$_template->assign('mode', $this->_mode);
 187
 188     $pageTemplateFile = $this->getHookedTemplateFileName();
 189     self::$_template->assign('tplFile', $pageTemplateFile);
 190
 191     // invoke the pagRun hook, CRM-3906
 192     CRM_Utils_Hook::pageRun($this);
 193
 194     if ($this->_print) {
 195       if (in_array($this->_print, [
 196         CRM_Core_Smarty::PRINT_SNIPPET,
 197         CRM_Core_Smarty::PRINT_PDF,
 198         CRM_Core_Smarty::PRINT_NOFORM,
 199         CRM_Core_Smarty::PRINT_JSON,
 200       ])) {
 201         $content = self::$_template->fetch('CRM/common/snippet.tpl');
 202       }
 203       else {
 204         $content = self::$_template->fetch('CRM/common/print.tpl');
 205       }
 206
 207       CRM_Utils_System::appendTPLFile($pageTemplateFile,
 208         $content,
 209         $this->overrideExtraTemplateFileName()
 210       );
 211
 212       //its time to call the hook.
 213       CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 214
 215       if ($this->_print == CRM_Core_Smarty::PRINT_PDF) {
 216         CRM_Utils_PDF_Utils::html2pdf($content, "{$this->_name}.pdf", FALSE);
 217       }
 218       elseif ($this->_print == CRM_Core_Smarty::PRINT_JSON) {
 219         $this->ajaxResponse['content'] = $content;
 220         CRM_Core_Page_AJAX::returnJsonResponse($this->ajaxResponse);
 221       }
 222       else {
 223         echo $content;
 224       }
 225       CRM_Utils_System::civiExit();
 226     }
 227
 228     $config = CRM_Core_Config::singleton();
 229
 230     // @fixme this is probably the wrong place for this.  It is required by jsortable.tpl which is inherited from many page templates.
 231     //   So we have to add it here to deprecate $config->defaultCurrencySymbol
 232     $this->assign('defaultCurrencySymbol', CRM_Core_BAO_Country::defaultCurrencySymbol());
 233
 234     // Intermittent alert to admins
 235     CRM_Utils_Check::singleton()->showPeriodicAlerts();
 236
 237     if ($this->useLivePageJS && Civi::settings()->get('ajaxPopupsEnabled')) {
 238       CRM_Core_Resources::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js', 1, 'html-header');
 239     }
 240
 241     $content = self::$_template->fetch('CRM/common/' . strtolower($config->userFramework) . '.tpl');
 242
 243     // Render page header
 244     if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region::instance('html-header', FALSE)) {
 245       CRM_Utils_System::addHTMLHead($region->render(''));
 246     }
 247     CRM_Utils_System::appendTPLFile($pageTemplateFile, $content);
 248
 249     //its time to call the hook.
 250     CRM_Utils_Hook::alterContent($content, 'page', $pageTemplateFile, $this);
 251
 252     echo CRM_Utils_System::theme($content, $this->_print);
 253   }
 254
 255   /**
 256    * Store the variable with the value in the form scope.
 257    *
 258    * @param string|array $name name of the variable or an assoc array of name/value pairs
 259    * @param mixed $value
 260    *   Value of the variable if string.
 261    */
 262   public function set($name, $value = NULL) {
 263     self::$_session->set($name, $value, $this->_name);
 264   }
 265
 266   /**
 267    * Get the variable from the form scope.
 268    *
 269    * @param string $name name of the variable
 270    *
 271    * @return mixed
 272    */
 273   public function get($name) {
 274     return self::$_session->get($name, $this->_name);
 275   }
 276
 277   /**
 278    * Assign value to name in template.
 279    *
 280    * @param string $var
 281    * @param mixed $value
 282    *   Value of variable.
 283    */
 284   public function assign($var, $value = NULL) {
 285     self::$_template->assign($var, $value);
 286   }
 287
 288   /**
 289    * Assign value to name in template by reference.
 290    *
 291    * @param string $var
 292    * @param mixed $value
 293    *   (reference) value of variable.
 294    */
 295   public function assign_by_ref($var, &$value) {
 296     self::$_template->assign_by_ref($var, $value);
 297   }
 298
 299   /**
 300    * Appends values to template variables.
 301    *
 302    * @param array|string $tpl_var the template variable name(s)
 303    * @param mixed $value
 304    *   The value to append.
 305    * @param bool $merge
 306    */
 307   public function append($tpl_var, $value = NULL, $merge = FALSE) {
 308     self::$_template->append($tpl_var, $value, $merge);
 309   }
 310
 311   /**
 312    * Returns an array containing template variables.
 313    *
 314    * @param string $name
 315    *
 316    * @return array
 317    */
 318   public function get_template_vars($name = NULL) {
 319     return self::$_template->get_template_vars($name);
 320   }
 321
 322   /**
 323    * Destroy all the session state of this page.
 324    */
 325   public function reset() {
 326     self::$_session->resetScope($this->_name);
 327   }
 328
 329   /**
 330    * Use the form name to create the tpl file name.
 331    *
 332    * @return string
 333    */
 334   public function getTemplateFileName() {
 335     return strtr(
 336       CRM_Utils_System::getClassName($this),
 337       [
 338         '_' => DIRECTORY_SEPARATOR,
 339         '\\' => DIRECTORY_SEPARATOR,
 340       ]
 341     ) . '.tpl';
 342   }
 343
 344   /**
 345    * A wrapper for getTemplateFileName that includes calling the hook to
 346    * prevent us from having to copy & paste the logic of calling the hook
 347    */
 348   public function getHookedTemplateFileName() {
 349     $pageTemplateFile = $this->getTemplateFileName();
 350     CRM_Utils_Hook::alterTemplateFile(get_class($this), $this, 'page', $pageTemplateFile);
 351     return $pageTemplateFile;
 352   }
 353
 354   /**
 355    * Default extra tpl file basically just replaces .tpl with .extra.tpl
 356    * i.e. we dont override
 357    *
 358    * @return string
 359    */
 360   public function overrideExtraTemplateFileName() {
 361     return NULL;
 362   }
 363
 364   /**
 365    * Setter for embedded.
 366    *
 367    * @param bool $embedded
 368    */
 369   public function setEmbedded($embedded) {
 370     $this->_embedded = $embedded;
 371   }
 372
 373   /**
 374    * Getter for embedded.
 375    *
 376    * @return bool
 377    *   return the embedded value
 378    */
 379   public function getEmbedded() {
 380     return $this->_embedded;
 381   }
 382
 383   /**
 384    * Setter for print.
 385    *
 386    * @param bool $print
 387    */
 388   public function setPrint($print) {
 389     $this->_print = $print;
 390   }
 391
 392   /**
 393    * Getter for print.
 394    *
 395    * @return bool
 396    *   return the print value
 397    */
 398   public function getPrint() {
 399     return $this->_print;
 400   }
 401
 402   /**
 403    * @return CRM_Core_Smarty
 404    */
 405   public static function &getTemplate() {
 406     return self::$_template;
 407   }
 408
 409   /**
 410    * @param string $name
 411    *
 412    * @return null
 413    */
 414   public function getVar($name) {
 415     return $this->$name ?? NULL;
 416   }
 417
 418   /**
 419    * @param string $name
 420    * @param $value
 421    */
 422   public function setVar($name, $value) {
 423     $this->$name = $value;
 424   }
 425
 426   /**
 427    * Assign metadata about fields to the template.
 428    *
 429    * In order to allow the template to format fields we assign information about them to the template.
 430    *
 431    * At this stage only date field metadata is assigned as that is the only use-case in play and
 432    * we don't want to assign a lot of unneeded data.
 433    *
 434    * @param string $entity
 435    *   The entity being queried.
 436    *
 437    * @throws \CiviCRM_API3_Exception
 438    */
 439   protected function assignFieldMetadataToTemplate($entity) {
 440     $fields = civicrm_api3($entity, 'getfields', ['action' => 'get']);
 441     $dateFields = [];
 442     foreach ($fields['values'] as $fieldName => $fieldMetaData) {
 443       if (isset($fieldMetaData['html']) && CRM_Utils_Array::value('type', $fieldMetaData['html']) == 'Select Date') {
 444         $dateFields[$fieldName] = CRM_Utils_Date::addDateMetadataToField($fieldMetaData, $fieldMetaData);
 445       }
 446     }
 447     $this->assign('fields', $dateFields);
 448   }
 449
 450   /**
 451    * Handy helper to produce the standard markup for an icon with alternative
 452    * text for a title and screen readers.
 453    *
 454    * See also the smarty block function `icon`
 455    *
 456    * @param string $icon
 457    *   The class name of the icon to display.
 458    * @param string $text
 459    *   The translated text to display.
 460    * @param bool $condition
 461    *   Whether to display anything at all. This helps simplify code when a
 462    *   checkmark should appear if something is true.
 463    * @param array $attribs
 464    *   Attributes to set or override on the icon element.  Any standard
 465    *   attribute can be unset by setting the value to an empty string.
 466    *
 467    * @return string
 468    *   The whole bit to drop in.
 469    */
 470   public static function crmIcon($icon, $text = NULL, $condition = TRUE, $attribs = []) {
 471     if (!$condition) {
 472       return '';
 473     }
 474
 475     // Add icon classes to any that might exist in $attribs
 476     $classes = array_key_exists('class', $attribs) ? explode(' ', $attribs['class']) : [];
 477     $classes[] = 'crm-i';
 478     $classes[] = $icon;
 479     $attribs['class'] = implode(' ', array_unique($classes));
 480
 481     $standardAttribs = ['aria-hidden' => 'true'];
 482     if ($text === NULL || $text === '') {
 483       $title = $sr = '';
 484     }
 485     else {
 486       $standardAttribs['title'] = $text;
 487       $sr = "<span class=\"sr-only\">$text</span>";
 488     }
 489
 490     // Assemble attribs
 491     $attribString = '';
 492     // Strip out title if $attribs specifies a blank title
 493     $attribs = array_merge($standardAttribs, $attribs);
 494     foreach ($attribs as $attrib => $val) {
 495       if (strlen($val)) {
 496         $val = htmlspecialchars($val);
 497         $attribString .= " $attrib=\"$val\"";
 498       }
 499     }
 500
 501     return "<i$attribString></i>$sr";
 502   }
 503
 504 }