backup malkusch/php-index

Author: Sebastian Detert

.gitignore

@@ -0,0 +1,2 @@
+nbproject
+tests/unit/sandbox.php

.travis.yml

@@ -0,0 +1,15 @@
+language: php
+
+php:
+    - 5.5
+    - 5.4
+    - 5.3
+
+install:
+    - pyrus install pear/PHP_CodeSniffer
+    - phpenv rehash
+
+script:
+    - phpunit tests/unit
+    - phpcs --standard=PSR2 classes/ docs/
+

LICENSE

@@ -0,0 +1,14 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+

README.md

@@ -0,0 +1,40 @@
+# About PHP-Index
+
+This library provides an API to perform binary search operations on a sorted
+index. The index can be a XML document, an CSV document, or an arbitrary text
+file where the key has a fixed position. You can easily implement your own
+index. This API comes handy on any sorted data structure where realtime search
+operations are necessary without the detour of a DBS import.
+
+
+# Installation
+
+Use [Composer](https://getcomposer.org/):
+
+```json
+{
+    "require": {
+        "malkusch/php-index": "0.0.1"
+    }
+}
+```
+
+
+# Usage
+
+Have a look at the docs/examples/ folder. You can find there examples for each
+implemented index structure.
+
+
+# License and author
+
+This project is free and under WTFPL.
+Responsable for this project is Markus Malkusch <markus@malkusch.de>.
+
+## Donations
+
+If you like BAV and feel generous donate a few Bitcoins here:
+[1335STSwu9hST4vcMRppEPgENMHD2r1REK](bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK)
+
+
+[![Build Status](https://travis-ci.org/malkusch/php-index.svg)](https://travis-ci.org/malkusch/php-index)

autoloader/InstantAutoloader.php

@@ -0,0 +1,248 @@
+<?php
+
+/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
+
+/**
+ * Defines the class InstantAutoloader
+ *
+ * PHP version 5
+ *
+ * LICENSE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.
+ * If not, see <http://php-autoloader.malkusch.de/en/license/>.
+ *
+ * @category  PHP
+ * @package   Autoloader
+ * @author    Markus Malkusch <markus@malkusch.de>
+ * @copyright 2009 - 2010 Markus Malkusch
+ * @license   http://php-autoloader.malkusch.de/en/license/ GPL 3
+ * @version   SVN: $Id$
+ * @link      http://php-autoloader.malkusch.de/en/
+ */
+
+namespace malkusch\autoloader;
+
+/**
+ * There might be several InstantAutoloaders deployed in a project.
+ * One is enough.
+ */
+if (! class_exists("malkusch\autoloader\InstantAutoloader", false)) {
+
+    /**
+     * An instant autoloader for shipping with project builds
+     *
+     * You can build a complete index of your project (by calling
+     * Autoloader::buildIndex()). If you use AutoloaderIndex_PHPArrayCode as
+     * index you can only use this instant autoloader for your project. This class
+     * has no further dependency on any other class. Just copy this class and the
+     * generated index anywhere into your project.
+     *
+     * Consider setting the AutoloaderIndexFilter_RelativePath filter.
+     *
+     * @category PHP
+     * @package  Autoloader
+     * @author   Markus Malkusch <markus@malkusch.de>
+     * @license  http://php-autoloader.malkusch.de/en/license/ GPL 3
+     * @version  Release: 1.12
+     * @link     http://php-autoloader.malkusch.de/en/
+     * @see      Autoloader::buildIndex()
+     * @see      AutoloaderIndex_PHPArrayCode()
+     * @see      AutoloaderIndexFilter_RelativePath()
+     */
+    class InstantAutoloader
+    {
+
+        const
+            /**
+             * The name of the class constructor is classConstructor().
+             */
+            CLASS_CONSTRUCTOR = 'classConstructor';
+
+        private
+            /**
+             * @var string
+             */
+            $_basePath = "",
+            /**
+             * @var array
+             */
+            $_index = array();
+
+        /**
+         * Loads the generated index array
+         *
+         * The index must be a generated AutoloaderIndex_PHPArrayCode index.
+         *
+         * @param string $indexPath Path to the generated index
+         */
+        public function __construct($indexPath)
+        {
+            $this->_index = require $indexPath;
+        }
+
+        /**
+         * Registers this autoloader at the autoloader stack
+         *
+         * @return void
+         */
+        public function register()
+        {
+            // spl_autoload_register() disables __autoload(). This might be unwanted.
+            if (\function_exists("__autoload")) {
+                \spl_autoload_register("__autoload");
+
+            }
+            \spl_autoload_register(array($this, "__autoload"));
+        }
+
+        /**
+         * Includes all class paths
+         *
+         * You can use this as an alternative to the autoload mechanism. This
+         * simply includes all classes without any autoloader.
+         *
+         * @return void
+         */
+        public function requireAll()
+        {
+            foreach ($this->_index as $classPath) {
+                $this->_requirePath($classPath);
+
+            }
+        }
+
+        /**
+         * Sets the base path for the class paths in the index
+         *
+         * @param string $basePath Base path for the class paths in the index
+         *
+         * @return void
+         */
+        public function setBasePath($basePath)
+        {
+            $this->_basePath = $basePath;
+        }
+
+        /**
+         * Autoloader callback
+         *
+         * @param string $class Class name
+         *
+         * @return void
+         */
+        public function __autoload($class)
+        {
+            $this->_normalizeClass($class);
+
+            /*
+             * spl_autoload_call() runs the complete stack,
+             * even though the class is already defined by
+             * a previously registered method.
+             */
+            if (
+                \class_exists($class, false)
+                || \interface_exists($class, false)
+            ) {
+                return;
+
+            }
+            if (
+                \version_compare(PHP_VERSION, "5.4", '>=')
+                && \trait_exists($class, false)
+            ) {
+                return;
+
+            }
+            if (!\array_key_exists($class, $this->_index)) {
+                return;
+
+            }
+
+            $this->_requirePath($this->_index[$class]);
+
+            $this->_callClassConstructor($class, self::CLASS_CONSTRUCTOR);
+        }
+
+        /**
+         * Requires a class path
+         *
+         * @param string $path Class path
+         *
+         * @return void
+         */
+        private function _requirePath($path)
+        {
+            if (!empty($this->_basePath)) {
+                $path = $this->_basePath . DIRECTORY_SEPARATOR . $path;
+
+            }
+            require_once $path;
+        }
+
+        /**
+         * Normalizes the reference of a class name with strtolower()
+         *
+         * Normalizing is needed as PHP is case insensitive.
+         *
+         * @param String &$class The reference of a class name
+         *
+         * @see strtolower().
+         * @return void
+         */
+        private function _normalizeClass(&$class)
+        {
+            $class = \strtolower($class);
+        }
+
+        /**
+         * Calls the class constructor
+         *
+         * If the class $class has the method public static $constructor, it
+         * will be called.
+         *
+         * @param String $class A class which might have a class constructor
+         * @param String $constructorName the method name of the class constructor
+         *
+         * @return bool true if the class constructor was called
+         */
+        public static function _callClassConstructor($class, $constructorName)
+        {
+            $reflectionClass = new \ReflectionClass($class);
+            if (!$reflectionClass->hasMethod($constructorName)) {
+                return false;
+
+            }
+
+            $constructor = $reflectionClass->getMethod($constructorName);
+            if (!$constructor->isStatic()) {
+                return false;
+
+            }
+
+            if (\version_compare(PHP_VERSION, "5.4", '>=') && $reflectionClass->isTrait()) {
+                return false;
+
+            }
+
+            if ($constructor->getDeclaringClass()->getName() != $reflectionClass->getName()) {
+                return false;
+
+            }
+
+            $constructor->invoke(null);
+            return true;
+        }
+
+    }
+
+}

autoloader/autoloader.php

@@ -0,0 +1,23 @@
+<?php
+
+/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
+
+/**
+ * Autoloader
+ * 
+ * This code was generated automatically.
+ * Don't edit this file. Changes will get lost when
+ * building a new autoloader.
+ *
+ * @see  AutoloaderBuilder::build()
+ * @link http://php-autoloader.malkusch.de/en/
+ */
+
+namespace malkusch\autoloader;
+
+require_once __DIR__ . '/InstantAutoloader.php';
+
+$_autoloader = new InstantAutoloader(__DIR__ . '/index/0.php');
+$_autoloader->setBasePath(__DIR__);
+$_autoloader->register();
+unset($_autoloader);

autoloader/index/0.php

@@ -0,0 +1,38 @@
+<?php
+
+/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
+
+/**
+ * Class index for autoloading
+ * 
+ * This class index was generated automatically.
+ * Don't edit this file. Changes might get lost when
+ * generating a new index.
+ *
+ * @see  Autoloader::buildIndex()
+ * @see  AutoloaderIndex_PHPArrayCode
+ * @link http://php-autoloader.malkusch.de/en/
+ */
+
+return array(
+    'malkusch\index\file' => '../classes/file/File.php',
+    'malkusch\index\index' => '../classes/Index.php',
+    'malkusch\index\range' => '../classes/Range.php',
+    'malkusch\index\result' => '../classes/Result.php',
+    'malkusch\index\parser' => '../classes/parser/Parser.php',
+    'malkusch\index\xmlindex' => '../classes/xml/XmlIndex.php',
+    'malkusch\index\byterange' => '../classes/binarySearch/ByteRange.php',
+    'malkusch\index\keyreader' => '../classes/binarySearch/KeyReader.php',
+    'malkusch\index\xmlparser' => '../classes/xml/XmlParser.php',
+    'malkusch\index\binarysearch' => '../classes/binarySearch/BinarySearch.php',
+    'malkusch\index\iteratorutil' => '../classes/iterator/IteratorUtil.php',
+    'malkusch\index\indexiterator' => '../classes/iterator/IndexIterator.php',
+    'malkusch\index\rangeiterator' => '../classes/iterator/RangeIterator.php',
+    'malkusch\index\indexexception' => '../classes/exceptions/IndexException.php',
+    'malkusch\index\fixedsizeindex' => '../classes/fixedSize/FixedSizeIndex.php',
+    'malkusch\index\resultiterator' => '../classes/iterator/ResultIterator.php',
+    'malkusch\index\fixedsizeparser' => '../classes/fixedSize/FixedSizeParser.php',
+    'malkusch\index\ioindexexception' => '../classes/exceptions/IOIndexException.php',
+    'malkusch\index\fileexistsioexception' => '../classes/exceptions/FileExistsIOException.php',
+    'malkusch\index\readdataindexexception' => '../classes/exceptions/ReadDataIndexException.php',
+);