CRM/Core/Smarty/plugins/modifier.substring.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /*
  37    * Smarty plugin
  38    * Type: modifier
  39    * Name: substring
  40    * Version: 0.1
  41    * Date: 2006-16-02
  42    * Author: Thorsten Albrecht <thor_REMOVE.THIS_@wolke7.net>
  43    * Purpose: "substring" allows you to retrieve a small part (substring) of a string.
  44    * Notes: The substring is specified by giving the start  position and the length.
  45    * Unlike the original function substr() in PHP the position of the characters
  46    * in the string starts at 1 (not at 0 as usual in php).
  47    * Example smarty code:
  48    *   {$my_string|substring:2:4}
  49    *   returns substring from character 2 until character 6
  50    * @link based on substr(): http://www.zend.com/manual/function.substr.php
  51    * @param string
  52    * @param position: startposition of the substring, beginning with 0
  53    * @param length: length of  substring
  54    * @return string
  55    *
  56    * -------------------------------------------------------------
  57    */
  58 function smarty_modifier_substring($string, $position, $length) {
  59   return substr($string, $position, $length);
  60 }
  61