From 250f919cc8596897c26d12ed2a66ec0b8c16b90a Mon Sep 17 00:00:00 2001
From: Cerys <cerysamberlewis@gmail.com>
Date: Sun, 9 Jun 2024 02:31:45 +0100
Subject: [PATCH] added an example (source see desc.)

https://schemas.auxiliumsoftware.co.uk/v1/message.json
---
 Examples/SchemaBuilder/Schemas/Message.php | 62 ++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Examples/SchemaBuilder/Schemas/Message.php

diff --git a/Examples/SchemaBuilder/Schemas/Message.php b/Examples/SchemaBuilder/Schemas/Message.php
new file mode 100644
index 0000000..58883ec
--- /dev/null
+++ b/Examples/SchemaBuilder/Schemas/Message.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace Darksparrow\Deegraph\Examples\SchemaBuilder\Schemas;
+require_once __DIR__ . "/../../../vendor/autoload.php";
+
+use Darksparrow\DeegraphPHP\Enumerators\SchemaFieldExistence;
+use Darksparrow\DeegraphPHP\SchemaBuilder\Attributes\SchemaDocument;
+use Darksparrow\DeegraphPHP\SchemaBuilder\Attributes\SchemaDocumentField;
+
+#[SchemaDocument(
+    Name: "Message",
+    MimeType: "message/rfc822",
+)]
+class Message
+{
+    #[SchemaDocumentField(
+        Name: "sender",
+        Existence: SchemaFieldExistence::SHOULD,
+        Comment: "The sender should be attached to a user object if known",
+        ValidSchemas: [
+            "https://schemas.auxiliumsoftware.co.uk/v1/user.json"
+        ],
+    )]
+    public string $Sender;
+
+    #[SchemaDocumentField(
+        Name: "recipients",
+        Existence: SchemaFieldExistence::SHOULD,
+        Comment: "All direct recipients that are known should be attached",
+        ValidSchemas: [
+            "https://schemas.auxiliumsoftware.co.uk/v1/collection.json"
+        ],
+        MaxSize: 0,
+    )]
+    public string $Recipients;
+
+    #[SchemaDocumentField(
+        Name: "indirect_recipients",
+        Existence: SchemaFieldExistence::SHOULD,
+        Comment: "All cc'd recipients that are known should be attached",
+        ValidSchemas: [
+            "https://schemas.auxiliumsoftware.co.uk/v1/collection.json"
+        ],
+        MaxSize: 0,
+        Child: [
+            "@comment"=>"All direct recipients should be addressed",
+            "@valid_schemas"=>[
+                "https://schemas.auxiliumsoftware.co.uk/v1/user.json"
+            ]
+        ]
+    )]
+    public string $IndirectRecipients;
+
+    #[SchemaDocumentField(
+        Name: "sent_at",
+        Existence: SchemaFieldExistence::SHOULD,
+        Comment: "The date the message was actually sent, if supplied MUST be in ISO 8601 format",
+        MaxSize: 64,
+        MimeType: "text/plain",
+    )]
+    public string $SentAt;
+}