Merge pull request #13986 from seamuslee001/coder_upgrade_uf_tag_sms
[civicrm-core.git] / CRM / Core / TestEntity.php
CommitLineData
cd355351
MWMC
1<?php
2/*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 * This file contains various support functions for test entities in CiviCRM.
30 * Historically there is a lot of inconsistency as to how test entities are displayed.
31 * This class helps resolve that.
32 *
33 * @package CRM
34 * @copyright CiviCRM LLC (c) 2004-2019
35 */
36
37/**
38 * Class CRM_Core_TestEntity.
39 */
40class CRM_Core_TestEntity {
41
42 // @todo extend this class to include functions that control when/where test entities are displayed
43 // and then use those functions everywhere we can display test transactions.
44 // Ideally the display of test transactions would be a per-user setting or permission
45 // so it can be toggled on/off as required and does not affect "day-to-day" usage.
46
47 /**
48 * Append "test" text to a string. eg. Member Dues (test) or My registration (test)
49 *
50 * @param string $text
51 *
52 * @return string
53 */
54 public static function appendTestText($text) {
55 return $text . ' ' . ts('(test)');
56 }
57
58}