Skip to content
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

Documentation: Normalize intro table #66

Merged
merged 1 commit into from
Apr 23, 2024
Merged
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions docs/book/v2/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ classes/interfaces as follows:
- `AdapterInterface`: `Laminas\Serializer\Adapter\AdapterInterface`
- `AdapterOptions`: `Laminas\Serializer\Adapter\AdapterOptions`

| Method signature | Description |
|------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `factory(/* ... */) : AdapterInterface` | Create a serializer adapter instance. Arguments are: `string |AdapterInterface $adapterName, AdapterOptions|array|Traversable $adapterOptions = null`.
| `setAdapterPluginManager(AdapterPluginManager $adapters) : void` | Change the adapter plugin manager. |
| `getAdapterPluginManager() : AdapterPluginManager` | Get the adapter plugin manager. |
| `resetAdapterPluginManager() : void` | Resets the internal adapter plugin manager. |
| `setDefaultAdapter(string | AdapterInterface $adapter /* ... */) : void` | Change the default adapter. Full argument list: `string|AdapterInterface $adapter, AdapterOptions|array|Traversable $adapterOptions = null`.
| `getDefaultAdapter() : AdapterInterface` | Get the default adapter. |
| `serialize(mixed $data /* ... */) : string` | Generates a storable representation of a value using the default adapter. Optionally, provide a different adapter via the second argument. Full argument list: `mixed $value, string |AdapterInterface $adapter = null, AdapterOptions|array|Traversable $adapterOptions = null`.
| `unserialize(string $value /* ... */) : mixed` | Creates a PHP value from a stored representation using the default adapter. Optionally, provide a different adapter via the second argument. Full argument list: `string $value, string |AdapterInterface|null $adapter = null, AdapterOptions|array|Traversable $adapterOptions = null`
| Method signature | Description |
|------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `factory(/* ... */) : AdapterInterface` | Create a serializer adapter instance. Arguments are: `string\|AdapterInterface $adapterName, AdapterOptions\|array\|Traversable $adapterOptions = null`. |
| `setAdapterPluginManager(AdapterPluginManager $adapters) : void` | Change the adapter plugin manager. |
| `getAdapterPluginManager() : AdapterPluginManager` | Get the adapter plugin manager. |
| `resetAdapterPluginManager() : void` | Resets the internal adapter plugin manager. |
| `setDefaultAdapter(string\|AdapterInterface $adapter /* ... */): void` | Change the default adapter. Full argument list: `string\|AdapterInterface $adapter, AdapterOptions\|array\|Traversable $adapterOptions = null`. |
| `getDefaultAdapter() : AdapterInterface` | Get the default adapter. |
| `serialize(mixed $data /* ... */) : string` | Generates a storable representation of a value using the default adapter. Optionally, provide a different adapter via the second argument. Full argument list: `mixed $value, string\|AdapterInterface $adapter = null, AdapterOptions\|array\|Traversable $adapterOptions = null`. |
| `unserialize(string $value /* ... */) : mixed` | Creates a PHP value from a stored representation using the default adapter. Optionally, provide a different adapter via the second argument. Full argument list: `string $value, string\|AdapterInterface\|null $adapter = null, AdapterOptions\|array\|Traversable $adapterOptions = null` |