> For the complete documentation index, see [llms.txt](https://pckg.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pckg.gitbook.io/documentation/core-packages/index-4/entity.md).

# Entity

`Entity` presents a table in your database.

## Example

```php

namespace Vendor\Domain\Entity;

use Pckg\Database\Entity;
use Vendor\Domain\Record\User;

class Users extends Entity
{
    protected $record = User::class;
}
```

## Usage

### Relations

All relations should be defined as an `Entity` method. See [> Relations](/documentation/core-packages/index-4/entity/relations.md) for more examples.

### Scopes

You can extract and reuse common scopes to methods.

```php
// ...
    public function scopeForGuest()
    {
        return $this->where('active')
            ->where('published_at', date('Y-m-d H:i:s'), '<=');
    }
// ...
```

You can then call scopes in your controllers, services or everywhere else.

```php
$filteredUsers = (new Users())
    ->forGuest()
    ->all();
```

### Extensions

You can extend the `Entity`

### Factory

Instead of creating the entity with `new`, you can also create an entity from the factory.

```php
use Pckg\Database\Entity\Factory as EntityFactory;
use Vendor\Domain\Entity\Users;

$usersEntity = EntityFactory::create(Users::class);
$usersCollection = $usersEntity->all();
$usersRecord = $usersCollection->first();
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://pckg.gitbook.io/documentation/core-packages/index-4/entity.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.