Skip to content

Commit

Permalink
Rename FileFinder and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Riimu committed Jan 8, 2015
1 parent 5ace999 commit 57f74b9
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 7 deletions.
5 changes: 5 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog #

## v4.3.0 (2015-01-08) ##

* Introduced ClassFinder for handling class file searching operations.
* Reduced overall code complexity.

## v4.2.0 (2015-01-01) ##

* ClassLoader::findFile now does a better job of canonizing directory separators
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,13 @@ Alternatively, you can add the dependency to your `composer.json` and run
}
```

If you installed the library via Composer. You can load the library by including
the `vendor/autoload.php` file. If you do not want to use Composer, you can
download the latest release and include the `src/autoload.php` file instead.
Library that has been installed via Composer can be loaded by including the
`vendor/autoload.php` file that was generated by Composer.

It is also possible to install this library manually. To do this, download the
[latest release](https://github.com/Riimu/Kit-ClassLoader/releases/latest) and
extract the `src` folder to your project folder. To load the library, include
the provided `src/autoload.php` file.

## Usage ##

Expand Down
4 changes: 2 additions & 2 deletions src/FileFinder.php → src/ClassFinder.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
namespace Riimu\Kit\ClassLoader;

/**
* Class for finding class files.
* Provides method for searching class files in the file system.
* @author Riikka Kalliomäki <riikka.kalliomaki@gmail.com>
* @copyright Copyright (c) 2015, Riikka Kalliomäki
* @license http://opensource.org/licenses/mit-license.php MIT License
*/
class FileFinder
class ClassFinder
{
/** @var string[] List of file extensions used to find files */
private $fileExtensions;
Expand Down
4 changes: 2 additions & 2 deletions src/ClassLoader.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ClassLoader
/** @var callable The autoload method used to load classes */
private $loader;

/** @var \Riimu\Kit\ClassLoader\FileFinder Finder used to find class files */
/** @var \Riimu\Kit\ClassLoader\ClassFinder Finder used to find class files */
private $finder;

/** @var boolean Whether loadClass should return values and throw exceptions or not */
Expand All @@ -57,7 +57,7 @@ public function __construct()
$this->useIncludePath = false;
$this->verbose = true;
$this->loader = [$this, 'loadClass'];
$this->finder = new FileFinder();
$this->finder = new ClassFinder();
}

/**
Expand Down

0 comments on commit 57f74b9

Please sign in to comment.