seablast/interfaces

Shared interface contracts for the Seablast for PHP ecosystem, currently including the IdentityManagerInterface contract.

v0.1.3 2026-06-27 22:31 UTC

Requires

• php: >=7.2 <8.6

MIT

• Stanislav Rejthar

Published on Packagist.org on 2026-06-27 22:32 UTC

README

A dedicated repository for shared interfaces related to the Seablast for PHP ecosystem. This package currently provides the IdentityManagerInterface contract for identity-related integrations. By consolidating shared interfaces in one place, Seablast Interfaces ensures consistency, reusability, and maintainability across different components of the Seablast framework.

Key Features

• Centralized Interface Definitions: Provides a single source of truth for shared interfaces used in the Seablast ecosystem, ensuring uniform implementation across different libraries and plugins.
• Enhanced Modularity: Facilitates the development and maintenance of modular components by decoupling interface definitions from their implementations.
• Improved Reusability: Interfaces defined in Seablast Interfaces can be easily reused by various libraries and plugins, promoting code reuse and reducing duplication.
• Ease of Integration: Simplifies the integration process for new libraries and plugins by providing clear and well-documented interfaces that they can implement.
• Consistent API: Ensures that all components adhering to the Seablast standards follow a consistent API, making it easier for developers to work with the ecosystem.

Usage

To use the interfaces defined in Seablast Interfaces within your project, simply include the repository as a dependency in your composer.json file:

{
  "require": {
    "seablast/interfaces": "^0.1.3"
  }
}

Then, run composer install or composer update to install the dependency and set up autoloading.

Example

Here's an example of how to implement an interface from Seablast Interfaces:

// src/IdentityManager.php in a package that consumes seablast/interfaces
namespace Seablast\Auth;

use Seablast\Interfaces\IdentityManagerInterface;

final class IdentityManager implements IdentityManagerInterface
{
    public function getGroups(): array
    {
        return [1, 2];
    }

    public function getRoleId(): int
    {
        return 1;
    }

    public function getUserId(): int
    {
        return 123;
    }

    public function isAuthenticated(): bool
    {
        return true;
    }
}

For unauthenticated users, implementations are recommended to throw an exception from getRoleId() and getUserId(). getGroups() may either return an empty array or throw an exception.

Contribution

We welcome contributions to Seablast Interfaces. If you have suggestions for new interfaces or improvements to existing ones, please open an issue or submit a pull request on our GitHub repository.

License

Seablast Interfaces is open-source software licensed under the MIT License.

Contact

For any questions or support, please contact our development team at https://github.com/WorkOfStan/seablast-interfaces/issues.