jcb-compiler/src/a900b836-f2eb-4f13-8f28-b7c.../README.md

155 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2023-03-21 22:52:57 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Structure (Details)
> namespace: **VDM\Joomla\Componentbuilder\Compiler\Joomlaplugin**
```uml
@startuml
class Structure #Gold {
# Plugin $plugin
# Component $component
# Config $config
# Registry $registry
# Dispenser $dispenser
2023-10-24 08:36:39 +00:00
# Event $event
2023-03-21 22:52:57 +00:00
# Counter $counter
# Folder $folder
# File $file
# Files $files
2023-10-24 08:36:39 +00:00
+ __construct(Plugin $plugin, Component $component, ...)
2023-03-21 22:52:57 +00:00
+ build() : void
2023-10-24 08:36:39 +00:00
# getXML(object $plugin) : string
# pluginPath(object $plugin) : void
# setMainClassFile(object $plugin) : void
2024-03-14 12:29:20 +00:00
# setMainXmlFile(object $plugin) : void
2023-10-24 08:36:39 +00:00
# setInstallScript(object $plugin) : void
# setReadme(object $plugin) : void
# setForms(object $plugin) : void
# setSQL(object $plugin) : void
# setFiles(object $plugin) : void
# setFolders(object $plugin) : void
# setUrls(object $plugin) : void
2023-03-21 22:52:57 +00:00
}
note right of Structure::__construct
2023-10-24 08:36:39 +00:00
Constructor.
2023-03-21 22:52:57 +00:00
since: 3.2.0
arguments:
2023-10-24 08:36:39 +00:00
Plugin $plugin
Component $component
Config $config
Registry $registry
Dispenser $dispenser
Event $event
Counter $counter
Folder $folder
File $file
Files $files
2023-03-21 22:52:57 +00:00
end note
2023-10-24 08:36:39 +00:00
note left of Structure::build
2023-03-21 22:52:57 +00:00
Build the Plugins files, folders, url's and config
since: 3.2.0
return: void
end note
note right of Structure::getXML
get the plugin xml template
since: 3.2.0
return: string
end note
2023-10-24 08:36:39 +00:00
note left of Structure::pluginPath
set the plugin path
since: 3.2.0
return: void
end note
note right of Structure::setMainClassFile
set the main class path
since: 3.2.0
return: void
end note
note left of Structure::setMainXmlFile
set the main xml file
since: 3.2.0
return: void
end note
note right of Structure::setInstallScript
set the install script file
since: 3.2.0
return: void
end note
note left of Structure::setReadme
set the readme file
since: 3.2.0
return: void
end note
note right of Structure::setForms
set the form files and folders
since: 3.2.0
return: void
end note
note left of Structure::setSQL
set the sql stuff
since: 3.2.0
return: void
end note
note right of Structure::setFiles
set the files
since: 3.2.0
return: void
end note
note left of Structure::setFolders
set the folders
since: 3.2.0
return: void
end note
note right of Structure::setUrls
set the urls
since: 3.2.0
return: void
end note
2023-03-21 22:52:57 +00:00
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)