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

# Helpers

The package exposes two helpers.

## `csrf()`

```php
function csrf(): \Quantum\Csrf\Csrf
```

Behavior:

1. checks whether `Quantum\Csrf\Csrf` is registered in `Quantum\Di\Di`
2. registers it if missing
3. returns the container-managed instance

That means repeated `csrf()` calls in the same container return the same `Csrf` object.

Because that object uses session-backed storage, the important shared state is the active session token rather than object-local properties.

## `csrf_token()`

```php
function csrf_token(): ?string
```

This is the convenience helper for rendering tokens into forms or page output.

Behavior:

1. reads `APP_KEY` from the environment
2. throws an app exception if `APP_KEY` is missing
3. calls `csrf()->generateToken($appKey)`
4. returns the stored token

Use this helper when you want framework-default token generation without manually passing a key.


---

# 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://quantumphp.gitbook.io/docs/packages/csrf/helpers.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.