---
title: "Phalcon Autoload"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Autoload
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Autoload\Exception
Class
Exceptions thrown in Phalcon\Autoload will use this class
- `\Exception`
- **`Phalcon\Autoload\Exception`**
- [`Phalcon\Autoload\Exceptions\LoaderDirectoriesNotArray`](#autoloadexceptionsloaderdirectoriesnotarray)
- [`Phalcon\Autoload\Exceptions\LoaderMethodNotCallable`](#autoloadexceptionsloadermethodnotcallable)
## Autoload\Exceptions\LoaderDirectoriesNotArray
Class
- `\Exception`
- [`Phalcon\Autoload\Exception`](#autoloadexception)
- **`Phalcon\Autoload\Exceptions\LoaderDirectoriesNotArray`**
`Phalcon\Autoload\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $name = "" );
```
## Autoload\Exceptions\LoaderMethodNotCallable
Class
- `\Exception`
- [`Phalcon\Autoload\Exception`](#autoloadexception)
- **`Phalcon\Autoload\Exceptions\LoaderMethodNotCallable`**
`Phalcon\Autoload\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Autoload\Loader
Class
The Phalcon Autoloader provides an easy way to automatically load classes
(namespaced or not) as well as files. It also features extension loading,
allowing the user to autoload files with different extensions than .php.
- **`Phalcon\Autoload\Loader`**
`Phalcon\Autoload\Exceptions\LoaderDirectoriesNotArray` · `Phalcon\Autoload\Exceptions\LoaderMethodNotCallable` · `Phalcon\Contracts\Autoload\AutoloadTypes` · `Phalcon\Events\Exception` · `Phalcon\Events\ManagerInterface` · `Phalcon\Events\Traits\EventsAwareTrait`
### Method Summary
Loader constructor.
Adds a class to the internal collection for the mapping
Adds a directory for the loaded files
Adds an extension for the loaded files
Adds a file to be added to the loader
Autoloads the registered classes
Get the path the loader is checking for a path
Returns the class-map currently registered in the autoloader
Returns debug information collected
Returns the directories currently registered in the autoloader
Returns the file extensions registered in the loader
Returns the files currently registered in the autoloader
Get the path when a class was found
Returns the namespaces currently registered in the autoloader
Returns isRegistered
Checks if a file exists and then adds the file by doing virtual require
Register the autoload method
Register classes and their locations
Register directories in which "not found" classes could be found
Sets an array of file extensions that the loader must try in each attempt
Sets the file check callback.
Registers files that are "non-classes" hence need a "require". This is
Register namespaces and their related directories
Unregister the autoload method
If the file exists, require it and return true; false otherwise
### Properties
Always holds a callable. The setter accepts a callable or a callable
string and rejects anything else.
### Methods
__construct()
```php
public function __construct( bool $isDebug = false );
```
Loader constructor.
addClass()
```php
public function addClass(
string $name,
string $file
): static;
```
Adds a class to the internal collection for the mapping
addDirectory()
```php
public function addDirectory( string $directory ): static;
```
Adds a directory for the loaded files
addExtension()
```php
public function addExtension( string $extension ): static;
```
Adds an extension for the loaded files
addFile()
```php
public function addFile( string $file ): static;
```
Adds a file to be added to the loader
addNamespace()
```php
public function addNamespace(
string $name,
mixed $directories,
bool $prepend = false
): static;
```
autoload()
```php
public function autoload( string $className ): bool;
```
Autoloads the registered classes
getCheckedPath()
```php
public function getCheckedPath(): string|null;
```
Get the path the loader is checking for a path
getClasses()
```php
public function getClasses(): array;
```
Returns the class-map currently registered in the autoloader
getDebug()
```php
public function getDebug(): array;
```
Returns debug information collected
getDirectories()
```php
public function getDirectories(): array;
```
Returns the directories currently registered in the autoloader
getExtensions()
```php
public function getExtensions(): array;
```
Returns the file extensions registered in the loader
getFiles()
```php
public function getFiles(): array;
```
Returns the files currently registered in the autoloader
getFoundPath()
```php
public function getFoundPath(): string|null;
```
Get the path when a class was found
getNamespaces()
```php
public function getNamespaces(): array;
```
Returns the namespaces currently registered in the autoloader
isRegistered()
```php
public function isRegistered(): bool;
```
Returns isRegistered
loadFiles()
```php
public function loadFiles(): void;
```
Checks if a file exists and then adds the file by doing virtual require
register()
```php
public function register( bool $prepend = false ): static;
```
Register the autoload method
setClasses()
```php
public function setClasses(
array $classes,
bool $merge = false
): static;
```
Register classes and their locations
setDirectories()
```php
public function setDirectories(
array $directories,
bool $merge = false
): static;
```
Register directories in which "not found" classes could be found
setExtensions()
```php
public function setExtensions(
array $extensions,
bool $merge = false
): static;
```
Sets an array of file extensions that the loader must try in each attempt
to locate the file
setFileCheckingCallback()
```php
public function setFileCheckingCallback( mixed $method = null ): static;
```
Sets the file check callback.
```php
// Default behavior.
$loader->setFileCheckingCallback("is_file");
// Faster than `is_file()`, but implies some issues if
// the file is removed from the filesystem.
$loader->setFileCheckingCallback("stream_resolve_include_path");
// Do not check file existence.
$loader->setFileCheckingCallback(null);
```
setFiles()
```php
public function setFiles(
array $files,
bool $merge = false
): static;
```
Registers files that are "non-classes" hence need a "require". This is
very useful for including files that only have functions
setNamespaces()
```php
public function setNamespaces(
array $namespaces,
bool $merge = false
): static;
```
Register namespaces and their related directories
unregister()
```php
public function unregister(): static;
```
Unregister the autoload method
requireFile()
```php
protected function requireFile( string $file ): bool;
```
If the file exists, require it and return true; false otherwise
Source: https://docs.phalcon.io/5.20/api/phalcon_autoload/index.mdx