|
| 1 | +--- |
| 2 | +title: Introduction |
| 3 | +description: "Tempest is a framework for PHP development, designed to get out of your way. Its core philosophy is to help you focus on your application code, without being bothered hand-holding the framework." |
| 4 | +--- |
| 5 | + |
| 6 | +Tempest's goal is to make you more productive when building web and console apps in PHP. It handles all the boilerplate parts of such projects for you, so that you can focus on what matters the most: writing application code. |
| 7 | + |
| 8 | +People using Tempest say it's the sweet spot between the robustness of Symfony and the eloquence of Laravel. It feels lightweight and close to vanilla PHP; and yet powerful and feature-rich. On this page, you'll read what sets Tempest apart as a framework for modern PHP development. If you're already convinced, you can head over to the [installation page](../0-getting-started/02-installation.md) and get started with Tempest. |
| 9 | + |
| 10 | +## Vision |
| 11 | + |
| 12 | +Tempest's vision can be summarized like this: **it's a community-driven, modern PHP framework that gets out of your way and dares to think outside the box**. Let's dissect that vision in depth. |
| 13 | + |
| 14 | +### Community driven |
| 15 | + |
| 16 | +Tempest started out as an educational project, without the intention for it to be something real. People picked up on it, though, and it was only after a strong community had formed that we considered making it something real. |
| 17 | + |
| 18 | +Currently, there are three core members dedicating a lot of their time to Tempest, as well as over [50 additional contributors](https://github.com/tempestphp/tempest-framework). We have an active [Discord server](/discord) with close to 400 members. |
| 19 | + |
| 20 | +Tempest isn't a solo project and never has been. It is a new framework and has a way to go compared to Symfony or Laravel, but there already is significant momentum and will only keep growing. |
| 21 | + |
| 22 | +### Embracing modern PHP |
| 23 | + |
| 24 | +The benefit of starting from scratch like Tempest did is having a clean slate. Tempest embraced modern PHP features from the start, and its goal is to keep doing this in the future by shipping built-in upgraders whenever breaking changes happen (think of it as Laravel Shift, but built into the framework). |
| 25 | + |
| 26 | +Just to name a couple of examples, Tempest uses property hooks: |
| 27 | + |
| 28 | +```php |
| 29 | +interface DatabaseMigration |
| 30 | +{ |
| 31 | + public string $name { |
| 32 | + get; |
| 33 | + } |
| 34 | + |
| 35 | + public function up(): ?QueryStatement; |
| 36 | + |
| 37 | + public function down(): ?QueryStatement; |
| 38 | +} |
| 39 | +``` |
| 40 | + |
| 41 | +Attributes: |
| 42 | + |
| 43 | +```php |
| 44 | +final class BookController |
| 45 | +{ |
| 46 | + #[Get('/books/{book}')] |
| 47 | + public function show(Book $book): Response { /* … */ } |
| 48 | +} |
| 49 | +``` |
| 50 | + |
| 51 | +Proxy objects: |
| 52 | + |
| 53 | +```php |
| 54 | +use Tempest\Container\Proxy; |
| 55 | + |
| 56 | +final readonly class BookController |
| 57 | +{ |
| 58 | + public function __construct( |
| 59 | + #[Proxy] private SlowDependency $slowDependency, |
| 60 | + ) { /* … */ } |
| 61 | +} |
| 62 | +``` |
| 63 | + |
| 64 | +And a lot more. |
| 65 | + |
| 66 | +### Getting out of your way |
| 67 | + |
| 68 | +A core part of Tempest's philosophy is that it wants to "get out of your way" as best as possible. For starters, Tempest is designed to structure your project code however you want, without making any assumptions or forcing conventions on you. You can prefer a classic MVC application, DDD or hexagonal design, microservices, or something else; Tempest works with any project structure out of the box without any configuration. |
| 69 | + |
| 70 | +Behind Tempest's flexibility is one of its most powerful features: [discovery](../internals/discovery). Discovery gives Tempest a great number of insights into your codebase, without any handholding. Discovery handles routing, console commands, view components, event listeners, command handlers, middleware, schedules, migrations, and more. |
| 71 | + |
| 72 | +```php |
| 73 | +final class ConsoleCommandDiscovery implements Discovery |
| 74 | +{ |
| 75 | + use IsDiscovery; |
| 76 | + |
| 77 | + public function __construct( |
| 78 | + private readonly ConsoleConfig $consoleConfig, |
| 79 | + ) {} |
| 80 | + |
| 81 | + public function discover(DiscoveryLocation $location, ClassReflector $class): void |
| 82 | + { |
| 83 | + foreach ($class->getPublicMethods() as $method) { |
| 84 | + if ($consoleCommand = $method->getAttribute(ConsoleCommand::class)) { |
| 85 | + $this->discoveryItems->add($location, [$method, $consoleCommand]); |
| 86 | + } |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + public function apply(): void |
| 91 | + { |
| 92 | + foreach ($this->discoveryItems as [$method, $consoleCommand]) { |
| 93 | + $this->consoleConfig->addCommand($method, $consoleCommand); |
| 94 | + } |
| 95 | + } |
| 96 | +} |
| 97 | +``` |
| 98 | + |
| 99 | +Discovery makes Tempest truly understand your codebase so that you don't have to explain the framework how to use it. Of course, discovery is heavily optimized for local development and entirely cached in production, so there's no performance overhead. Even better: discovery isn't just a core framework feature, you're encouraged to write your own project-specific discovery classes wherever they make sense. That's the Tempest way. |
| 100 | + |
| 101 | +Besides Discovery, Tempest is designed to be extensible. You'll find that any part of the framework can be replaced and hooked into by implementing an interface and plugging it into the container. No fighting the framework, Tempest gets out of your way. |
| 102 | + |
| 103 | +```php |
| 104 | +use Tempest\View\ViewRenderer; |
| 105 | + |
| 106 | +$container->singleton(ViewRenderer::class, $myCustomViewRenderer); |
| 107 | +``` |
| 108 | + |
| 109 | +### Thinking outside the box |
| 110 | + |
| 111 | +Finally, since Tempest originated as an educational project, many Tempest features dare to rethink the things we've gotten used to. For example, [console commands](../1-essentials/04-console-commands), which in Tempest are designed to be very similar to controller actions: |
| 112 | + |
| 113 | +```php |
| 114 | +final readonly class BooksCommand |
| 115 | +{ |
| 116 | + use HasConsole; |
| 117 | + |
| 118 | + public function __construct( |
| 119 | + private BookRepository $repository, |
| 120 | + ) {} |
| 121 | + |
| 122 | + #[ConsoleCommand] |
| 123 | + public function find(?string $initial = null): void |
| 124 | + { |
| 125 | + $book = $this->search( |
| 126 | + 'Find your book', |
| 127 | + $this->repository->find(...), |
| 128 | + ); |
| 129 | + } |
| 130 | + |
| 131 | + #[ConsoleCommand(middleware: [CautionMiddleware::class])] |
| 132 | + public function delete(string $title, bool $verbose = false): void |
| 133 | + { /* … */ } |
| 134 | +} |
| 135 | +``` |
| 136 | + |
| 137 | +Or what about [Tempest's ORM](../1-essentials/03-database), which aims to have truly decoupled models: |
| 138 | + |
| 139 | +```php |
| 140 | +use Tempest\Validation\Rules\Length; |
| 141 | +use App\Author; |
| 142 | + |
| 143 | +final class Book |
| 144 | +{ |
| 145 | + #[Length(min: 1, max: 120)] |
| 146 | + public string $title; |
| 147 | + |
| 148 | + public ?Author $author = null; |
| 149 | + |
| 150 | + /** @var \App\Chapter[] */ |
| 151 | + public array $chapters = []; |
| 152 | +} |
| 153 | +``` |
| 154 | + |
| 155 | +```php |
| 156 | +final class BookRepository |
| 157 | +{ |
| 158 | + public function findById(int $id): Book |
| 159 | + { |
| 160 | + return query(Book::class) |
| 161 | + ->select() |
| 162 | + ->with('chapters', 'author') |
| 163 | + ->where('id = ?', $id) |
| 164 | + ->first(); |
| 165 | + } |
| 166 | +} |
| 167 | +``` |
| 168 | + |
| 169 | +Then there's our view engine, which embraces the most original template engine of all time: HTML; |
| 170 | + |
| 171 | +```html |
| 172 | +<x-base :title="$this->seo->title"> |
| 173 | + <ul> |
| 174 | + <li :foreach="$this->books as $book"> |
| 175 | + {{ $book->title }} |
| 176 | + |
| 177 | + <span :if="$this->showDate($book)"> |
| 178 | + <x-tag> |
| 179 | + {{ $book->publishedAt }} |
| 180 | + </x-tag> |
| 181 | + </span> |
| 182 | + </li> |
| 183 | + </ul> |
| 184 | +</x-base> |
| 185 | +``` |
| 186 | + |
| 187 | +## Getting started |
| 188 | + |
| 189 | +Are you intrigued? Want to give Tempest a try? Head over to [the next chapter](../0-getting-started/02-installation.md) to learn about how to get started with Tempest. |
| 190 | + |
| 191 | +If you want to become part of our community, you're more than welcome to [join our Discord server](/discord), and to check out [Tempest on GitHub](https://github.com/tempestphp/tempest-framework). |
| 192 | + |
| 193 | +Enjoy! |
0 commit comments