jcb-compiler/src/071c7cff-4c88-4b80-bd99-066...
Robot c7492eb08e
update 2024-01-27
2024-01-27 09:09:33 +02:00
..
README.md update 2023-10-24 10:36:32 2023-10-24 10:36:39 +02:00
code.php update 2024-01-27 2024-01-27 09:09:33 +02:00
code.power update 2024-01-27 2024-01-27 09:09:33 +02:00
settings.json update 2023-10-24 10:36:32 2023-10-24 10:36:39 +02:00

README.md

██████╗  ██████╗ ██╗    ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║    ██║██╔════╝██╔══██╗
██████╔╝██║   ██║██║ █╗ ██║█████╗  ██████╔╝
██╔═══╝ ██║   ██║██║███╗██║██╔══╝  ██╔══██╗
██║     ╚██████╔╝╚███╔███╔╝███████╗██║  ██║
╚═╝      ╚═════╝  ╚══╝╚══╝ ╚══════╝╚═╝  ╚═╝

class Structure (Details)

namespace: VDM\Joomla\Componentbuilder\Compiler\Joomlamodule

@startuml
class Structure  #Gold {
  # Module $module
  # Component $component
  # Config $config
  # Registry $registry
  # Dispenser $dispenser
  # Event $event
  # Counter $counter
  # Folder $folder
  # File $file
  # Files $files
  # TemplateData $templatedata
  + __construct(Module $module, Component $component, ...)
  + build() : void
  # getXML(object $module) : string
  # getCustomScriptField(array $fieldScriptBucket) : string
  # modulePath(object $module) : void
  # setMainModFile(object $module) : void
  # setCustomGet(object $module) : void
  # setHelperFile(object $module) : void
  # setMainXmlFile(object $module) : void
  # setDefaultFile(object $module) : void
  # setTemplateFiles(object $module) : void
  # setInstallScript(object $module) : void
  # setReadme(object $module) : void
  # setCssJsForm(object $module) : void
  # setCssForm(object $module, string $targetPath, ...) : void
  # setJsForm(object $module, string $targetPath, ...) : void
  # setForms(object $module) : void
  # setSQL(object $module) : void
  # setFiles(object $module) : void
  # setFolders(object $module) : void
  # setUrls(object $module) : void
}

note right of Structure::__construct
  Constructor.

  since: 3.2.0
  
  arguments:
    Module $module
    Component $component
    Config $config
    Registry $registry
    Dispenser $dispenser
    Event $event
    Counter $counter
    Folder $folder
    File $file
    Files $files
    TemplateData $templatedata
end note

note left of Structure::build
  Build the Modules files, folders, url's and config

  since: 3.2.0
  return: void
end note

note right of Structure::getXML
  get the module xml template

  since: 3.2.0
  return: string
end note

note left of Structure::getCustomScriptField
  get the module admin custom script field

  since: 3.2.0
  return: string
end note

note right of Structure::modulePath
  Set the module path

  since: 3.2.0
  return: void
end note

note left of Structure::setMainModFile
  Set the main module file

  since: 3.2.0
  return: void
end note

note right of Structure::setCustomGet
  Set the custom get file

  since: 3.2.0
  return: void
end note

note left of Structure::setHelperFile
  Set the helper file

  since: 3.2.0
  return: void
end note

note right of Structure::setMainXmlFile
  Set the main XML file

  since: 3.2.0
  return: void
end note

note left of Structure::setDefaultFile
  Set the main default template file

  since: 3.2.0
  return: void
end note

note right of Structure::setTemplateFiles
  Set the additional template files

  since: 3.2.0
  return: void
end note

note left of Structure::setInstallScript
  Set the install script file

  since: 3.2.0
  return: void
end note

note right of Structure::setReadme
  Set the readme file

  since: 3.2.0
  return: void
end note

note left of Structure::setCssJsForm
  Set the css and javascript in form

  since: 3.2.0
  return: void
end note

note right of Structure::setCssForm
  Set the css in form

  since: 3.2.0
  return: void
  
  arguments:
    object $module
    string $targetPath
    array $bucket
end note

note left of Structure::setJsForm
  Set the javascript in form

  since: 3.2.0
  return: void
  
  arguments:
    object $module
    string $targetPath
    array $bucket
end note

note right of Structure::setForms
  Set the form folders and files as needed

  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
 
@enduml

     ██╗ ██████╗██████╗
     ██║██╔════╝██╔══██╗
     ██║██║     ██████╔╝
██   ██║██║     ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
 ╚════╝  ╚═════╝╚═════╝

Build with Joomla Component Builder