From fe9eb529125e2d436f43914505252f40e1de0655 Mon Sep 17 00:00:00 2001
From: Llewellyn <llewellyn@no-reply@vdm.io>
Date: Wed, 11 Sep 2024 02:39:17 +0000
Subject: [PATCH] Create Joomla.File.Type readme file

---
 .../README.md                                 | 101 ++++++++++++++++++
 1 file changed, 101 insertions(+)
 create mode 100644 src/12a2a8de-a893-4dbb-a53d-b52de4f6cb0e/README.md

diff --git a/src/12a2a8de-a893-4dbb-a53d-b52de4f6cb0e/README.md b/src/12a2a8de-a893-4dbb-a53d-b52de4f6cb0e/README.md
new file mode 100644
index 0000000..01e8ba4
--- /dev/null
+++ b/src/12a2a8de-a893-4dbb-a53d-b52de4f6cb0e/README.md
@@ -0,0 +1,101 @@
+```
+██████╗  ██████╗ ██╗    ██╗███████╗██████╗
+██╔══██╗██╔═══██╗██║    ██║██╔════╝██╔══██╗
+██████╔╝██║   ██║██║ █╗ ██║█████╗  ██████╔╝
+██╔═══╝ ██║   ██║██║███╗██║██╔══╝  ██╔══██╗
+██║     ╚██████╔╝╚███╔███╔╝███████╗██║  ██║
+╚═╝      ╚═════╝  ╚══╝╚══╝ ╚══════╝╚═╝  ╚═╝
+```
+# final class Type (Details)
+> namespace: **VDM\Joomla\Componentbuilder\File**
+
+```uml
+@startuml
+class Type << (F,LightGreen) >> #RoyalBlue {
+  # Item $item
+  # string $fileTypes
+  + __construct(Item $item)
+  + get(string $guid) : ?array
+  + details(string $guid) : ?object
+  # getFieldName(array $data) : string
+  # getAllow(array $data) : string
+  # getAllowSpan(array $data) : string
+  # getAllowFormats(array $data) : ?array
+}
+
+note right of Type::__construct
+  Constructor.
+
+  since: 5.0.2
+end note
+
+note right of Type::get
+  Retrieves the file type details (ajax)
+
+  since: 5.0.2
+  return: ?array
+end note
+
+note right of Type::details
+  Retrieves the file type details
+
+  since: 5.0.2
+  return: ?object
+end note
+
+note right of Type::getFieldName
+  Retrieves the field name
+
+  since: 5.0.2
+  return: string
+end note
+
+note right of Type::getAllow
+  Retrieves the allow formats (for script)
+
+  since: 5.0.2
+  return: string
+end note
+
+note right of Type::getAllowSpan
+  Retrieves the allow formats (for span)
+
+  since: 5.0.2
+  return: string
+end note
+
+note right of Type::getAllowFormats
+  Retrieves the allow formats
+
+  since: 5.0.2
+  return: ?array
+end note
+ 
+@enduml
+```
+
+The Power feature in JCB allows you to write PHP classes and their implementations, making it easy to include them in your Joomla project. JCB handles linking, autoloading, namespacing, and folder structure creation for you.
+
+By using the SPK (Super Power Key) in your custom code (replacing the class name in your code with the SPK), JCB will automatically pull the power from the repository into your project. This makes it available in your JCB instance, allowing you to edit it and include the class in your generated Joomla component.
+
+JCB uses placeholders like [[[`NamespacePrefix`]]] and [[[`ComponentNamespace`]]] in namespacing to prevent collisions and improve reusability across different JCB systems. You can also set the **JCB powers path** globally or per component under the **Dynamic Integration** tab, providing flexibility and easy maintainability.
+
+To add this specific Power to your project in JCB:
+
+> simply use this SPK
+```
+Super---12a2a8de_a893_4dbb_a53d_b52de4f6cb0e---Power
+```
+> remember to replace the `---` with `___` to activate this Power in your code
+
+---
+```
+     ██╗ ██████╗██████╗
+     ██║██╔════╝██╔══██╗
+     ██║██║     ██████╔╝
+██   ██║██║     ██╔══██╗
+╚█████╔╝╚██████╗██████╔╝
+ ╚════╝  ╚═════╝╚═════╝
+```
+> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)
+