website·Indexed 29 days ago
https://swiftapi.github.io/swift-docs/docs/Documentation for the SwiftAPI framework, featuring guides on routing and controllers, GraphQL integration with Relay support, security components including authentication and rate limiting, database relations, and an asynchronous PHP runtime.
Swift distinguishes between two types of authenticated entities. Both are represented as implementations of Swift\Security\User\UserInterface after authentication for consistent usage across the application.
Swift\Security\User\ClientUser class.The Swift database system uses a two-layer architecture to manage data:
Swift employs a code-first approach where the database schema is defined within Entity classes. The ORM automatically synchronizes these definitions with the database schema and manages relationships between data objects, significantly reducing the need to write manual SQL statements.
Swift is a lightweight PHP framework optimized for building APIs and microservices quickly. It is not intended for building full websites or large-scale monolithic applications. Instead, it is designed for specialized services such as:
Under the hood, Swift leverages components from Symfony, Cycle ORM, and graphql-php.
Swift provides a GraphQL component as an alternative to REST endpoints, implementing a declarative, code-first approach inspired by Nexus. It is a wrapper for Webonyx GraphQL and complies with the GraphQL Spec and the Relay Specification.
By default, Swift automatically generates the following for all entities:
Swift\Orm\EntityManager to persist and execute the operation. It is recommended to wrap the run() method in a try-catch block to handle potential errors.$movie = new Movie();
$movie->setTitle( 'Foo bar' );
$movie->setDescription( 'Movie about foo bar' );
$movie->setReleased( new \DateTime() );
$movie->setType( ConditionTypeEnum::OUTSIDE_TEMP );
$this->entityManager->persist( $movie );
try {
$this->entityManager->run();
} catch ( \Throwable $e ) {
// handle error
}ArrayCollection (an ArrayIterator implementation) is used to represent a list of entities for *Many relations. This allows for a simple interface to iterate over related entities. Collections must always be initialized within the entity's constructor to ensure they are available when the entity is instantiated.<?php declare( strict_types=1 );
namespace App\Foo\Repository;
use Swift\Orm\Entity\AbstractEntity;
use Swift\Orm\Attributes\Entity;
use Swift\Orm\Collection\ArrayCollection;
#[Entity( table: 'movie_actors' )]
class Actor extends AbstractEntity {
protected ArrayCollection $movies;
public function __construct() {
// Collections must be initiated in the constructor
$this->movies = new ArrayCollection();
}
}Hook attribute allows you to subscribe to specific entity events using a callable (such as a static method within the entity class). This provides a simple observer pattern to execute logic during the entity lifecycle.<?php declare( strict_types=1 );
namespace Swift\Security\User\Entity;
use Swift\Orm\Attributes\Behavior\Hook;
use Swift\Orm\Attributes\Entity;
use Swift\Orm\Attributes\Field;
use Swift\Orm\Types\FieldTypes;
use Swift\Orm\Entity\AbstractEntity;
#[Entity( table: 'review' )]
#[Hook(
callable: [Review::class, 'onCreate'],
events: [\Swift\Orm\Behavior\Event\Mapper\Command\OnCreate::class],
)]
#[Hook(
callable: [Review::class, 'onUpdate'],
events: [\Swift\Orm\Behavior\Event\Mapper\Command\OnUpdate::class],
)]
class Review extends AbstractEntity {
#[Field( name: 'id', primary: true, type: FieldTypes::INT, length: 11 )]
public int $id;
public static function onCreate( \Swift\Orm\Behavior\Event\Mapper\Command\OnCreate $event ): void {
// logic before review is created
}
public static function onUpdate( \Swift\Orm\Behavior\Event\Mapper\Command\OnUpdate $event ): void {
// logic when review is updated
}
}