-
-
Notifications
You must be signed in to change notification settings - Fork 112
refactor(db): Introduce new API for entities #1595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
CarlSchwan
wants to merge
5
commits into
master
Choose a base branch
from
carl/entity
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,566
−736
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1dfb69e
refactor(db): Introduce repository concept
CarlSchwan ba0a727
refactor: port remaining entities to new API
CarlSchwan c1cd3cd
fix(tests): Fix tests broken by new entity api
CarlSchwan a070dad
fix(Db): Improve doc
CarlSchwan e587b9c
chore(tests): run rector
CarlSchwan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -80,3 +80,5 @@ typings/ | |
|
|
||
| # VScode settings | ||
| .vscode/settings.json | ||
|
|
||
| tests/.phpunit.cache/test-results | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2025 Nextcloud GmbH | ||
| * SPDX-FileContributor: Carl Schwan | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\Maps\AppFramework\Db\Attribute; | ||
|
|
||
| use Attribute; | ||
| use OCP\AppFramework\Attribute\Consumable; | ||
| use OCP\DB\Types; | ||
|
|
||
| /** | ||
| * Attribute for mapping a property in an entity to a database column. | ||
| * | ||
| * ```php | ||
| * #[Entity(name: 'my_entity'] | ||
| * final class MyEntity { | ||
| * #[Column(name: 'my_column', type: Types::String, default: '')] | ||
| * public string $myColumn = ''; | ||
| * } | ||
| * ``` | ||
| * | ||
| * @since 35.0.0 | ||
| */ | ||
| #[Attribute(Attribute::TARGET_PROPERTY)] | ||
| #[Consumable(since: '35.0.0')] | ||
| final readonly class Column { | ||
| public function __construct( | ||
| /** @param non-empty-string $name The name of the column in the database. */ | ||
| public string $name, | ||
| /** @param Types::* $type The type of the column in the database. */ | ||
| public string $type, | ||
| /** @param ?int $length The length of the column (relevant for Types::STRING) */ | ||
| public ?int $length = null, | ||
| /** @param bool $nullable Whether the column is nullable in the database */ | ||
| public bool $nullable = false, | ||
| /** @param mixed $default The default value for the column in the database. */ | ||
| public mixed $default = null, | ||
| ) { | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2025 Nextcloud GmbH | ||
| * SPDX-FileContributor: Carl Schwan | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\Maps\AppFramework\Db\Attribute; | ||
|
|
||
| use Attribute; | ||
| use OCP\AppFramework\Attribute\Consumable; | ||
|
|
||
| /** | ||
| * Attribute for marking a class as an entity mapped to some database table. | ||
| * | ||
| * ```php | ||
| * #[Entity(name: 'my_entity')] | ||
| * final class MyEntity { | ||
| * #[Column(name: 'my_column', type: Types::String, default: '')] | ||
| * public string $myColumn = ''; | ||
| * } | ||
| * ``` | ||
| * | ||
| * @since 35.0.0 | ||
| */ | ||
| #[Attribute(Attribute::TARGET_CLASS)] | ||
| #[Consumable(since: '35.0.0')] | ||
| final readonly class Entity { | ||
| public function __construct( | ||
| /** @param non-empty-string $name */ | ||
| public string $name, | ||
| ) { | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2025 Nextcloud GmbH | ||
| * SPDX-FileContributor: Carl Schwan | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\Maps\AppFramework\Db\Attribute; | ||
|
|
||
| use Attribute; | ||
| use OCP\AppFramework\Attribute\Consumable; | ||
| use OCP\Snowflake\ISnowflakeGenerator; | ||
|
|
||
| /** | ||
| * Attribute for marking a column as a primary id. | ||
| * | ||
| * ```php | ||
| * #[Entity(name: 'my_entity'] | ||
| * final class MyEntity { | ||
| * #[Id(generatorClass: ISnowflakeGenerator::class)] | ||
| * #[Column(name: 'id', type: Types::BIGINT)] | ||
| * public string $id = ''; | ||
| * } | ||
| * ``` | ||
| * | ||
| * @since 35.0.0 | ||
| */ | ||
| #[Attribute(Attribute::TARGET_PROPERTY)] | ||
| #[Consumable(since: '35.0.0')] | ||
| final readonly class Id { | ||
| public function __construct( | ||
| /** @param class-string<ISnowflakeGenerator> $generatorClass */ | ||
| public ?string $generatorClass = null, | ||
| ) { | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.