Skip to content

Updated documentation detailing entity-behavior-identifier #190

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.

Sign up for GitHub

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
puzzledpolymath wants to merge 2 commits into
base: 2.x
Choose a base branch
from
Open

Updated documentation detailing entity-behavior-identifier #190

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67ea319
Updated documentation detailing usage of the cycle/entity-behavior-id…
puzzledpolymath Apr 12, 2026
6c4c819
updated entity.md re-adding link to UUID docs
puzzledpolymath May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions docs/en/annotated/entity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,7 @@ class Pivot
```

> Read how to use non-incremental primary keys in the Advanced section:
> - [UUID](/docs/en/entity-behaviors/uuid.md)
> - [Snowflake IDs](/docs/en/entity-behaviors/uuid.md#snowflake-ids)
> - [Identifiers](/docs/en/entity-behaviors/identifiers.md)
Copy link
Copy Markdown
Member

@roxblnfk roxblnfk Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't replace old UUIDs with the new Identifiers, especially since ramsey/identifier hasn't even been released yet.

We should either add a warning that this is not a stable package yet, or postpone the documentation changes until a stable release.

Copy link
Copy Markdown
Author

@puzzledpolymath puzzledpolymath May 1, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@roxblnfk I've re-added the original link for UUID's. Removed dead link "Snowflake IDs".
Is the plan to create a release for cycle/entity-behavior-identifier, await feedback, issues from users?

Copy link
Copy Markdown
Member

@roxblnfk roxblnfk May 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v0.1.0? I think it's a good idea

Copy link
Copy Markdown
Author

@puzzledpolymath puzzledpolymath May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@roxblnfk Sounds like a plan 👍


You can use multiple attributes at the same time with shorter syntax:

Expand Down Expand Up @@ -296,7 +295,7 @@ class User

#[Column(type: 'enum', values: UserStatus::class, default: 'active')]
private string $status;

// Or pass a specific enum instance
#[Column(type: 'enum', values: UserStatus::Active)]
private string $defaultActive;
Expand All @@ -311,7 +310,7 @@ class User
{
#[Column(type: 'enum', values: ['active', 'disabled', 'banned'])]
private string $status;

// Mix of strings and enum values
#[Column(type: 'enum', values: [UserStatus::Active, 'custom'])]
private string $mixedStatus;
Expand All @@ -337,15 +336,15 @@ class PostgresEntity
// PostgreSQL JSONB with indexing support
#[Column(type: 'jsonb')]
private array $metadata;

// PostgreSQL timestamp with timezone
#[Column(type: 'timestamptz')]
private \DateTimeInterface $scheduledAt;

// PostgreSQL geometric types
#[Column(type: 'point')]
private string $location;

// PostgreSQL network address types
#[Column(type: 'inet')]
private string $ipAddress;
Expand Down Expand Up @@ -421,7 +420,7 @@ class User
#[Column(type: 'primary')]
#[GeneratedValue(onInsert: true)]
private int $id;

// Database default timestamp (PostgreSQL: DEFAULT NOW())
#[Column(type: 'datetime', default: 'CURRENT_TIMESTAMP')]
#[GeneratedValue(onInsert: true)]
Expand All @@ -446,7 +445,7 @@ class Document
#[Column(type: 'uuid', primary: true)]
#[GeneratedValue(beforeInsert: true)]
private string $id;

#[Column(type: 'datetime')]
#[GeneratedValue(beforeInsert: true)]
private \DateTimeInterface $createdAt;
Expand All @@ -460,7 +459,7 @@ class Document
- Creation timestamps set by ORM
- Custom business logic for initial values

> Read more about UUID generation in [Entity Behaviors: UUID](/docs/en/entity-behaviors/uuid.md).
> Read more about identifier generation in [Entity Behaviors: Identifiers](/docs/en/entity-behaviors/identifiers.md).

#### 3. PHP-Generated Before Update (`beforeUpdate: true`)

Expand All @@ -473,11 +472,11 @@ class Article
#[Column(type: 'primary')]
#[GeneratedValue(onInsert: true)]
private int $id;

#[Column(type: 'datetime')]
#[GeneratedValue(beforeInsert: true)]
private \DateTimeInterface $createdAt;

// Automatically updated on every save
#[Column(type: 'datetime')]
#[GeneratedValue(beforeInsert: true, beforeUpdate: true)]
Expand All @@ -502,7 +501,7 @@ class Post
#[Column(type: 'datetime')]
#[GeneratedValue(beforeInsert: true, beforeUpdate: true)]
private \DateTimeInterface $lastModified; // Set on create AND update

#[Column(type: 'datetime')]
#[GeneratedValue(beforeInsert: true)]
private \DateTimeInterface $createdAt; // Set only on create
Expand Down Expand Up @@ -603,7 +602,7 @@ class UserPost
{
#[Column(type: 'integer')]
private int $user_id;

#[Column(type: 'integer')]
private int $post_id;
}
Expand Down Expand Up @@ -676,7 +675,7 @@ class Post
{
#[Column(type: 'primary')]
public int $id;

#[Column(type: 'integer')]
#[ForeignKey(target: User::class, action: 'CASCADE')]
private int $userId;
Expand All @@ -699,7 +698,7 @@ class Post
{
#[Column(type: 'primary')]
public int $id;

#[Column(type: 'integer')]
private int $user_id;
}
Expand Down
Loading