Download the PHP package pfaciana/composer-autoloader-plugin without Composer

Composer Autoloader Plugin

Generate Composer bootstrap files from PHP attributes or directory patterns.

This package is a Composer plugin. It runs during composer dump-autoload, writes generated bootstrap files into vendor/composer by default, and registers those files with Composer's autoload.files list.

Install

After changing config, adding or removing autoload attributes, or changing matched files, regenerate Composer autoload files:

Understanding Patterns

A major feature of this plugin is that it can scan files by patterns. These patterns mirror the patterns used by .gitignore files. If you already know how to use a .gitignore file, then you know how to use patterns here. The only difference is this plugins uses "include" patterns instead of "ignore" patterns. So your patterns will likely be inverted from your .gitignore file.

This done using the pfaciana/includefile package, which is an inverted wrapper around automattic/ignorefile.

Both autoload-by-attr.patterns and autoload-by-dir.patterns use pfaciana/includefile.

Example patterns:

Attribute Autoloading

Attribute autoloading scans PHP files for functions or public static methods marked with an attribute, then generates a bootstrap file that calls them.

By default, it looks for #[AutoRun].

Default output autoload file location:

Inputs

#[AutoRun] Arguments

Supported Import type values:

Import argument

import controls how the generated bootstrap loads PHP files.

This matters because PHP functions are not class-autoloaded. If an attributed function lives in src/functions.php, the generated bootstrap must load that file before it can call the function.

Generated output includes the file import before the function call:

Static methods are different. Composer can autoload the class, so static method entries usually do not need a file import:

Use none when the function or file is already loaded somewhere else.

Directory autoloading also uses import; there it controls how each matched file is included.

Check argument

check is only useful for attributed functions.

When check: true, the generated bootstrap wraps the file import in function_exists checks. If the function already exists, the file is not imported again.

Generated output:

Use this when a function file might already be loaded before Composer's generated bootstrap runs. It helps avoid fatal "Cannot redeclare function" errors.

Custom Attribute

AutoRun is only the default. You can scan for a different attribute name:

The configured attribute can also set default argument values:

Runtime

AutoRunPlugin::runtime() is a runtime version of the Plugin. It operates outside the context of Composer. It scans source code only. It does not load scanned files during discovery, so runtime attribute usage must be simple and statically readable.

Runtime-only rules:

• Do not use attribute aliases such as use AutoRun as Run; #[Run].
• Use literal attribute arguments only: numbers, strings, booleans, or null.
• Do not use constants, class constants, enum values, expressions, or function calls in runtime attribute arguments.

Avoid in runtime mode:

Use Composer/plugin generation when you need PHP reflection to resolve aliases, constants, or more complex attribute arguments.

Directory Autoloading

Directory autoloading scans files by pattern and generates a bootstrap file that imports each matched PHP file.

Default output:

Pattern Examples

These examples use Git-style include/exclude patterns through pfaciana/includefile.

String patterns can also be newline-separated:

Inputs

Runtime

AutoloadPlugin::runtime() is a runtime version of the Plugin. It operates outside the context of Composer.

Performance

cwd is the scan root. The plugin starts file discovery from cwd, then applies patterns.

This matters for performance. If cwd is the project root, the plugin must walk files and directories from the project root before patterns can include or exclude them.

Negated patterns like !vendor and !node_modules help, but they still require the scanner to start at the root and decide what to skip.

If you only need files under one directory, set cwd to that directory.

Less efficient:

More efficient:

Use project root as cwd only when you need to scan across multiple root-level directories.

Notes

• Generated files live in vendor/composer by default. Do not edit them by hand.
• Attribute mode sorts calls by priority, lowest first.
• Function entries need their source file imported before the function can be called.
• Static method entries rely on Composer class autoloading.
• Files with only declarations are safely loaded for reflection. Files with top-level executable code use token fallback instead.
• Token fallback avoids running app code during composer dump-autoload, but it cannot verify every runtime detail the same way reflection can.

• Multiple separate attribute groups are supported:

• Multiple attributes in the same group are not currently supported by the token scanner:

Use separate attribute groups when combining AutoRun with other attributes.