From c1a0933151e575b9d9fca23e1fb78cfd662976b2 Mon Sep 17 00:00:00 2001 From: Llewellyn Date: Wed, 11 Sep 2024 02:39:21 +0000 Subject: [PATCH] Create JCB.File.Service.File readme file --- .../README.md | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 src/202ccd9e-dfcf-4cde-a0ce-bde1fd27f088/README.md diff --git a/src/202ccd9e-dfcf-4cde-a0ce-bde1fd27f088/README.md b/src/202ccd9e-dfcf-4cde-a0ce-bde1fd27f088/README.md new file mode 100644 index 0000000..88cb2ea --- /dev/null +++ b/src/202ccd9e-dfcf-4cde-a0ce-bde1fd27f088/README.md @@ -0,0 +1,60 @@ +``` +██████╗ ██████╗ ██╗ ██╗███████╗██████╗ +██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗ +██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝ +██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗ +██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║ +╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝ +``` +# class File (Details) +> namespace: **VDM\Joomla\Componentbuilder\File\Service** + +```uml +@startuml +class File #Gold { + + register(Container $container) : void + + getFileType(Container $container) : FileType +} + +note right of File::register + Registers the service provider with a DI container. + + since: 5.0.3 + return: void +end note + +note right of File::getFileType + Get The File Type Class. + + since: 5.0.3 + return: FileType +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---202ccd9e_dfcf_4cde_a0ce_bde1fd27f088---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) +