CRM/Utils/Check/Message.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id: $
  33  *
  34  */
  35 class CRM_Utils_Check_Message {
  36   /**
  37    * @var string
  38    */
  39   private $name;
  40
  41   /**
  42    * @var string
  43    */
  44   private $message;
  45
  46   /**
  47    * @var string
  48    */
  49   private $title;
  50
  51   /**
  52    * @var string
  53    * @see Psr\Log\LogLevel
  54    */
  55   private $level;
  56
  57   /**
  58    * @var string
  59    *   help text (to be presented separately from the message)
  60    */
  61   private $help;
  62
  63   /**
  64    * @param string $name
  65    *   Symbolic name for the check.
  66    * @param string $message
  67    *   Printable message (short or long).
  68    * @param string $title
  69    *   Printable message (short).
  70    * @param string $level
  71    *   The severity of the message. Use PSR-3 log levels.
  72    *
  73    * @see Psr\Log\LogLevel
  74    */
  75   public function __construct($name, $message, $title, $level = \Psr\Log\LogLevel::WARNING) {
  76     $this->name = $name;
  77     $this->message = $message;
  78     $this->title = $title;
  79     // Handle non-integer severity levels.
  80     if (!CRM_Utils_Rule::integer($level)) {
  81       $level = CRM_Utils_Check::severityMap($level);
  82     }
  83     $this->level = $level;
  84   }
  85
  86   /**
  87    * @return string
  88    */
  89   public function getName() {
  90     return $this->name;
  91   }
  92
  93   /**
  94    * @return string
  95    */
  96   public function getMessage() {
  97     return $this->message;
  98   }
  99
 100   /**
 101    * @return string
 102    */
 103   public function getTitle() {
 104     return $this->title;
 105   }
 106
 107   /**
 108    * @return string
 109    * @see Psr\Log\LogLevel
 110    */
 111   public function getLevel() {
 112     return $this->level;
 113   }
 114
 115   /**
 116    * Alias for Level
 117    * @return string
 118    */
 119   public function getSeverity() {
 120     return $this->getLevel();
 121   }
 122
 123   /**
 124    * Set optional additional help text
 125    * @param string $help
 126    */
 127   public function addHelp($help) {
 128     $this->help = $help;
 129   }
 130
 131   /**
 132    * @return array
 133    */
 134   public function toArray() {
 135     $array = array(
 136       'name' => $this->name,
 137       'message' => $this->message,
 138       'title' => $this->title,
 139       'severity' => $this->level,
 140     );
 141     if (!empty($this->help)) {
 142       $array['help'] = $this->help;
 143     }
 144     return $array;
 145   }
 146
 147 }