Skip to content

Adding doc for getClassMap #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
moufmouf merged 1 commit into from
Jan 10, 2020
Merged

Adding doc for getClassMap #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,14 @@ recursively by passing `false` to the 5th parameter:
```php
$explorer = new GlobClassExplorer('\\This\\Namespace\\Only\\', $psr16Cache, $cacheTtl, null, false);
```

You can also get a class map using the `getClassMap` method.
A class map is an array associating the name of the classes found (in key), to the file they are
linked to (a `SplFileInfo` in value).

```php
$classMap = $explorer->getClassMap();
foreach ($classMap as $class => $fileInfo) {
echo 'Class '.$class.' found in file '.$fileInfo->getPathname();
}
```