aboutsummaryrefslogtreecommitdiff
path: root/vendor/flexi/lib/helper/text_helper.php
blob: c5967277eacc76943653a3a8e69f1ffd81d8bfd3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<?php

# Copyright (c)  2008 - Marcus Lunzenauer <mlunzena@uos.de>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

/**
 * TextHelper.
 *
 *
 * @package    flexi
 * @subpackage helper
 *
 * @author    Marcus Lunzenauer (mlunzena@uos.de)
 * @copyright (c) Authors
 * @version   $Id$
 */

class TextHelper {

  /**
   * Holds the internal cycles.
   *
   * @ignore
   */
  private static $cycles = array();


  /**
   * Returns a camelized string from a lower case and underscored string by
   * replacing slash with underscore and upper-casing each letter preceded
   * by an underscore.
   *
   * @param string String to camelize.
   *
   * @return string Camelized string.
   */
  function camelize($word) {
    return str_replace(' ', '',
                       ucwords(str_replace(array('_', '/'),
                                           array(' ', ' '), $word)));
  }


  /**
   * Creates a Cycle object whose +__toString method cycles through elements of
   * an array every time it is called. This can be used for example, to
   * alternate classes for table rows:
   *
   *   <? foreach ($items as $item) : ?>
   *     <tr class="<?= TextHelper::cycle('odd', 'even') ?>">
   *       <td><?= item ?></td>
   *     </tr>
   *   <? endforeach ?>
   *
   * You can use named cycles to allow nesting in loops.  Passing a single array
   * as the only parameter with a <tt>name</tt> key will create a named cycle.
   * You can manually reset a cycle by calling reset_cycle and passing the
   * name of the cycle.
   *
   *   <? foreach($items as $item) : ?>
   *     <tr class="<?= TextHelper::cycle(array("even", "odd", "name" => "row_class")) ?>">
   *       <td>
   *         <? foreach ($item->values as $value) : ?>
   *           <span style="color:<?= TextHelper::cycle(array("red", "green", "blue", "name" => "colors")) : ?>">
   *             <?= $value ?>
   *           </span>
   *         <? endforeach ?>
   *         <? TextHelper::reset_cycle("colors") ?>
   *       </td>
   *    </tr>
   *  <? endforeach ?>
   */
  static function cycle($first_value) {

    $values = func_get_args();


    if (sizeof($values) == 1 && is_array($values[0])) {
      $values = $values[0];
      $name = isset($values['name']) ? $values['name'] : 'default';
      unset($values['name']);
    }
    else {
      $name = 'default';
    }

    $cycle = self::get_cycle($name);
    if (is_null($cycle) || $cycle->values !== $values) {
      $cycle = self::set_cycle($name, new TextHelperCycle($values));
    }

    return (string) $cycle;
  }


  /**
   * Resets a cycle so that it starts from the first element the next time
   * it is called. Pass in +name+ to reset a named cycle.
   *
   * @param  string   an optional name of a cycle
   *
   * @return void
   */
  public static function reset_cycle($name = 'default') {
    $cycle = self::get_cycle($name);
    if (isset($cycle)) {
      $cycle->reset();
    }
  }


  /**
   * @ignore
   */
  private static function get_cycle($name) {
    return isset(self::$cycles[$name]) ? self::$cycles[$name] : NULL;
  }

  /**
   * @ignore
   */
  private static function set_cycle($name, $cycle) {
    return self::$cycles[$name] = $cycle;
  }
}


/**
 * This class holds an array of string and cycles through them.
 *
 * @package     flexi
 * @subpackage  helper
 *
 * @author    Marcus Lunzenauer (mlunzena@uos.de)
 * @copyright (c) Authors
 * @version   $Id$
 */

class TextHelperCycle {


  public $values;


  function __construct($values) {
    $this->values = (array) $values;
  }


  function cycle() {
    $result = current($this->values);
    if (next($this->values) === FALSE)
      $this->reset();
    return $result;
  }


  function reset() {
    reset($this->values);
  }


  function __toString() {
    return $this->cycle();
  }
}