SproutCMS

This is the code documentation for the SproutCMS project

source of /sprout/Helpers/ColModifier.php

  1. <?php
  2. /*
  3.  * Copyright (C) 2017 Karmabunny Pty Ltd.
  4.  *
  5.  * This file is a part of SproutCMS.
  6.  *
  7.  * SproutCMS is free software: you can redistribute it and/or modify it under the terms
  8.  * of the GNU General Public License as published by the Free Software Foundation, either
  9.  * version 2 of the License, or (at your option) any later version.
  10.  *
  11.  * For more information, visit <http://getsproutcms.com>.
  12.  */
  13.  
  14. namespace Sprout\Helpers;
  15.  
  16.  
  17. /**
  18.  * Base class for modifying values for main_columns of an {@see ItemList},
  19.  * e.g. in {@see ManagedAdminController::_getContents}
  20.  */
  21. abstract class ColModifier {
  22.  
  23. /**
  24.   * Modify a column value
  25.   * This value will be html/csv/etc encoded afterwards.
  26.   *
  27.   * @param string $val The incoming value
  28.   * @param string $field_name The name of the field being modified
  29.   * @return string The modified value
  30.   **/
  31. abstract public function modify($val, $field_name);
  32.  
  33. }
  34.  
  35.  
  36.