aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIvan Enderlin <ivan.enderlin@hoa-project.net>2014-01-03 14:42:49 +0100
committerIvan Enderlin <ivan.enderlin@hoa-project.net>2014-01-03 14:42:49 +0100
commit428999cab865b4a410ce268d9700adf14b8df5cb (patch)
tree4de5877c9f4e1df180dcccafa2591b1f21fdb9aa
parenta39ec0f2b8142d8e54a322b47d31195be98e96a0 (diff)
downloadIterator-428999cab865b4a410ce268d9700adf14b8df5cb.zip
Iterator-428999cab865b4a410ce268d9700adf14b8df5cb.tar.gz
Iterator-428999cab865b4a410ce268d9700adf14b8df5cb.tar.bz2
Add the `Hoa\Iterator\Counter` iterator.
This is simply a counter: foreach(new Hoa\Iterator\Counter(2, 15, 3) as $v) var_dump($v); /** * Will output: * int(2) * int(5) * int(8) * int(11) * int(14) */
-rw-r--r--Counter.php182
1 files changed, 182 insertions, 0 deletions
diff --git a/Counter.php b/Counter.php
new file mode 100644
index 0000000..3aca18e
--- /dev/null
+++ b/Counter.php
@@ -0,0 +1,182 @@
+<?php
+
+/**
+ * Hoa
+ *
+ *
+ * @license
+ *
+ * New BSD License
+ *
+ * Copyright © 2007-2013, Ivan Enderlin. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Hoa nor the names of its contributors may be
+ * used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+namespace {
+
+from('Hoa')
+
+/**
+ * \Hoa\Iterator
+ */
+-> import('Iterator.~')
+
+/**
+ * \Hoa\Iterator\Exception
+ */
+-> import('Iterator.Exception');
+
+}
+
+namespace Hoa\Iterator {
+
+/**
+ * Class \Hoa\Iterator\Counter.
+ *
+ * A counter.
+ *
+ * @author Ivan Enderlin <ivan.enderlin@hoa-project.net>
+ * @copyright Copyright © 2007-2013 Ivan Enderlin.
+ * @license New BSD License
+ */
+
+class Counter implements Iterator {
+
+ /**
+ * From (lower bound).
+ *
+ * @var \Hoa\Iterator\Counter int
+ */
+ protected $_from = 0;
+
+ /**
+ * Current index.
+ *
+ * @var \Hoa\Iterator\Counter int
+ */
+ protected $_i = 0;
+
+ /**
+ * To (upper bound).
+ *
+ * @var \Hoa\Iterator\Counter int
+ */
+ protected $_to = 0;
+
+ /**
+ * Step.
+ *
+ * @var \Hoa\Iterator\Counter int
+ */
+ protected $_step = 0;
+
+
+
+ /**
+ * Constructor.
+ * Equivalent to:
+ * for($i = $from; $i < $to; $i += $step)
+ *
+ * @access public
+ * @param int $from Start value.
+ * @param int $to Maximum value.
+ * @param int $step Step.
+ * @return void
+ * @throw \Hoa\Iterator\Exception
+ */
+ public function __construct ( $from, $to, $step ) {
+
+ if($step <= 0)
+ throw new Exception(
+ 'The step must be non-negative; given %d.', 0, $step);
+
+ $this->_from = $from;
+ $this->_to = $to;
+ $this->_step = $step;
+
+ return;
+ }
+
+ /**
+ * Return the current element.
+ *
+ * @access public
+ * @return int
+ */
+ public function current ( ) {
+
+ return $this->_i;
+ }
+
+ /**
+ * Return the key of the current element.
+ *
+ * @access public
+ * @return int
+ */
+ public function key ( ) {
+
+ return $this->_i;
+ }
+
+ /**
+ * Move forward to next element.
+ *
+ * @access public
+ * @return void
+ */
+ public function next ( ) {
+
+ $this->_i += $this->_step;
+
+ return;
+ }
+
+ /**
+ * Rewind the iterator to the first element.
+ *
+ * @access public
+ * @return void
+ */
+ public function rewind ( ) {
+
+ $this->_i = $this->_from;
+
+ return;
+ }
+
+ /**
+ * Check if current position is valid.
+ *
+ * @access public
+ * @return bool
+ */
+ public function valid ( ) {
+
+ return $this->_i < $this->_to;
+ }
+}
+
+}