The framework does not enforce any specific namespace or directory structure, so feel free to change them.
The default directory structure can be controlled via mapDirectories method of Kernel class. By default, all
application directories will be calculated based on root using the following pattern:
| Directory | Value |
|---|---|
| root | set by user |
| vendor | root/vendor |
| runtime | root/runtime |
| cache | root/runtime/cache |
| public | root/public |
| app | root/app |
| config | app/config |
| resources | app/resources |
Some components will declare their own directories such as:
| Component | Directory | Value |
|---|---|---|
| spiral/views | views | app/views |
| spiral/translator | locale | app/locale |
| spiral/migrations | migrations | app/migrations |
You can specify root or any other directory value in your app.php file as argument to App:
$app = \App\App::create([
'root' => __DIR__
])->run();
For example, we can change runtime directory location:
$app = \App\App::create([
'root' => __DIR__,
'runtime' => \sys_get_temp_dir()
])->run();
To resolve directory alias within your application, use Spiral\Boot\DirectoriesInterface:
use Spiral\Boot\DirectoriesInterface;
// ...
function test(DirectoriesInterface $dirs): void
{
\dump($dirs->get('app'));
// output: <your root path>/app/
}
You can also use the function directory inside the global IoC scope (config files, controllers, service code).
function test(): void
{
\dump(directory('app'));
// output: <your root path>/app/
}
Note
: If you would like a directory names always be constrained by a specific method, you may create a helper class, for example AppDirectories.
<?php
declare(strict_types=1);
namespace App;
use Spiral\Boot\DirectoriesInterface;
final class AppDirectories
{
public function __construct(
private readonly DirectoriesInterface $directories
) {
}
/**
* Application root directory.
*
* @return non-empty-string
*/
public function getRoot(?string $path = null): string
{
return $this->buildPath('root', $path);
}
/**
* Application directory.
*
* @return non-empty-string
*/
public function getApp(?string $path = null): string
{
return $this->buildPath('app', $path);
}
/**
* Public directory.
*
* @return non-empty-string
*/
public function getPublic(?string $path = null): string
{
return $this->buildPath('public', $path);
}
/**
* Runtime directory.
*
* @return non-empty-string
*/
public function getRuntime(?string $path = null): string
{
return $this->buildPath('runtime', $path);
}
/**
* Runtime cache directory.
*
* @return non-empty-string
*/
public function getCache(?string $path = null): string
{
return $this->buildPath('cache', $path);
}
/**
* Vendor libraries directory.
*
* @return non-empty-string
*/
public function getVendor(?string $path = null): string
{
return $this->buildPath('vendor', $path);
}
/**
* Config directory.
*
* @return non-empty-string
*/
public function getConfig(?string $path = null): string
{
return $this->buildPath('config', $path);
}
/**
* Resources directory.
*
* @return non-empty-string
*/
public function getResources(?string $path = null): string
{
return $this->buildPath('resources', $path);
}
private function buildPath(string $key, ?string $path = null): string
{
return \rtrim($this->directories->get($key), '/') . ($path ? '/' . \ltrim($path, '/') : '');
}
}
By default, all skeleton applications use App root namespace pointing to app/src directory. You can change the base
to any desired namespace in composer.json:
{
"autoload": {
"psr-4": {
"App\\": "app/src/"
}
}
}