Skip to content

Commit 9a00351

Browse files
committed
docs(src): add ARFA 1.3 @author/@since/@Package docblocks to all 15 source files
1 parent 5cc4140 commit 9a00351

13 files changed

Lines changed: 99 additions & 2 deletions

src/Attribute/Serialize.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@
77
/**
88
* Marks a property for serialization control.
99
*
10-
* Parameters: name (wire-name override), groups (string[]), format-specific options.
10+
* Parameters: name (wire-name override), groups (string[]), ignore (bool).
11+
* Properties without this attribute are included automatically using their property name.
12+
*
13+
* @package KaririCode\Serializer\Attribute
14+
* @author Walmir Silva <walmir.silva@kariricode.org>
15+
* @since 3.1.0 ARFA 1.3
1116
*/
1217
#[\Attribute(\Attribute::TARGET_PROPERTY)]
1318
final readonly class Serialize

src/Configuration/SerializerConfiguration.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
namespace KaririCode\Serializer\Configuration;
66

7+
/**
8+
* Immutable configuration value object for the serializer engine.
9+
*
10+
* @package KaririCode\Serializer\Configuration
11+
* @author Walmir Silva <walmir.silva@kariricode.org>
12+
* @since 3.1.0 ARFA 1.3
13+
*/
714
final readonly class SerializerConfiguration
815
{
916
public function __construct(

src/Contract/EncoderRegistry.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
namespace KaririCode\Serializer\Contract;
66

7+
/**
8+
* Contract for format-encoder registries.
9+
*
10+
* @package KaririCode\Serializer\Contract
11+
* @author Walmir Silva <walmir.silva@kariricode.org>
12+
* @since 3.1.0 ARFA 1.3
13+
*/
714
interface EncoderRegistry
815
{
916
public function register(Encoder $encoder): void;

src/Core/InMemoryEncoderRegistry.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88
use KaririCode\Serializer\Contract\EncoderRegistry;
99
use KaririCode\Serializer\Exception\SerializationException;
1010

11+
/**
12+
* In-memory encoder registry backed by a plain PHP array.
13+
*
14+
* Throws SerializationException on duplicate registration or unknown format lookup.
15+
*
16+
* @package KaririCode\Serializer\Core
17+
* @author Walmir Silva <walmir.silva@kariricode.org>
18+
* @since 3.1.0 ARFA 1.3
19+
*/
1120
final class InMemoryEncoderRegistry implements EncoderRegistry
1221
{
1322
/** @var array<string, Encoder> */

src/Core/SerializationContextImpl.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@
66

77
use KaririCode\Serializer\Contract\SerializationContext;
88

9+
/**
10+
* Immutable serialization context carrying the active format and parameters.
11+
*
12+
* Uses the named-constructor pattern: instantiate via `SerializationContextImpl::create()`.
13+
* `withFormat()` and `withParameters()` return new instances (full immutability).
14+
*
15+
* @package KaririCode\Serializer\Core
16+
* @author Walmir Silva <walmir.silva@kariricode.org>
17+
* @since 3.1.0 ARFA 1.3
18+
*/
919
final readonly class SerializationContextImpl implements SerializationContext
1020
{
1121
/**

src/Encoder/JsonEncoder.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@
88
use KaririCode\Serializer\Contract\SerializationContext;
99
use KaririCode\Serializer\Exception\SerializationException;
1010

11+
/**
12+
* Encodes/decodes data as RFC 8259-compliant JSON.
13+
*
14+
* Uses JSON_THROW_ON_ERROR for deterministic error handling.
15+
* Supports `pretty` context parameter for human-readable output.
16+
*
17+
* @package KaririCode\Serializer\Encoder
18+
* @author Walmir Silva <walmir.silva@kariricode.org>
19+
* @since 3.1.0 ARFA 1.3
20+
*/
1121
final readonly class JsonEncoder implements Encoder
1222
{
1323
/** @param array<mixed> $data */

src/Encoder/QueryStringEncoder.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@
77
use KaririCode\Serializer\Contract\Encoder;
88
use KaririCode\Serializer\Contract\SerializationContext;
99

10-
/** Encodes/decodes URL query strings (application/x-www-form-urlencoded). */
10+
/**
11+
* Encodes/decodes data as RFC 3986-compliant URL query strings (application/x-www-form-urlencoded).
12+
*
13+
* @package KaririCode\Serializer\Encoder
14+
* @author Walmir Silva <walmir.silva@kariricode.org>
15+
* @since 3.1.0 ARFA 1.3
16+
*/
1117
final readonly class QueryStringEncoder implements Encoder
1218
{
1319
/** @param array<mixed> $data */

src/Encoder/XmlEncoder.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@
88
use KaririCode\Serializer\Contract\SerializationContext;
99
use KaririCode\Serializer\Exception\SerializationException;
1010

11+
/**
12+
* Encodes/decodes arrays as application/xml via SimpleXMLElement + DOMDocument.
13+
*
14+
* Uses `libxml_use_internal_errors` to suppress PHP notices on malformed XML decode.
15+
* Supports `root` and `pretty` context parameters.
16+
*
17+
* @package KaririCode\Serializer\Encoder
18+
* @author Walmir Silva <walmir.silva@kariricode.org>
19+
* @since 3.1.0 ARFA 1.3
20+
*/
1121
final readonly class XmlEncoder implements Encoder
1222
{
1323
/** @param array<mixed> $data */

src/Event/SerializationCompletedEvent.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66

77
use KaririCode\Serializer\Result\SerializationResult;
88

9+
/**
10+
* Event emitted when a serialization operation completes successfully.
11+
*
12+
* @package KaririCode\Serializer\Event
13+
* @author Walmir Silva <walmir.silva@kariricode.org>
14+
* @since 3.1.0 ARFA 1.3
15+
*/
916
final readonly class SerializationCompletedEvent
1017
{
1118
public function __construct(public SerializationResult $result, public float $durationMs, public float $timestamp = 0)

src/Event/SerializationStartedEvent.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44

55
namespace KaririCode\Serializer\Event;
66

7+
/**
8+
* Event emitted when a serialization operation begins.
9+
*
10+
* @package KaririCode\Serializer\Event
11+
* @author Walmir Silva <walmir.silva@kariricode.org>
12+
* @since 3.1.0 ARFA 1.3
13+
*/
714
final readonly class SerializationStartedEvent
815
{
916
public function __construct(public string $format, public float $timestamp = 0)

0 commit comments

Comments
 (0)