> 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/service/contracts.md).

# Contracts

This page describes the behaviors you can rely on when integrating with the Service package.

## Service type contract

Use subclasses of `Quantum\Service\Service` as service targets.

```php
use Quantum\Service\Service;

class ReportService extends Service
{
}
```

Non-service classes are rejected before resolution.

## Resolution modes

### `ServiceFactory::create(string $serviceClass, array $args = [])`

Contract:

* validates service class eligibility
* returns a fresh instance
* accepts runtime constructor arguments

### `ServiceFactory::get(string $serviceClass, array $args = [])`

Contract:

* validates service class eligibility
* registers the service class with DI when needed
* returns the shared instance for that service class
* applies runtime constructor arguments when the shared instance is created
* reuses the same shared instance on later calls for the same service class

## Helper contract

```php
service(string $serviceClass, bool $singleton = false): Service
```

Behavior:

* `false` resolves a fresh instance
* `true` resolves the shared instance
* helper does not accept constructor args

If you need runtime args, use `ServiceFactory::create()` or `ServiceFactory::get()`. For shared services, pass those args on the first `get()` call that creates the instance.

## Undefined method contract

Undefined method calls throw immediately.

Practical effect: service method typos surface immediately instead of being silently ignored.

## Exception cases to handle

* service class does not exist
* class exists but does not extend `Quantum\Service\Service`
* constructor dependencies do not resolve through DI or provided args
* undefined service method is called


---

# 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/service/contracts.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.
