jcb-compiler/src/fa4bf18e-301e-42e3-91fb-6e0.../README.md

612 lines
11 KiB
Markdown
Raw Permalink Normal View History

2023-03-21 22:52:57 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Config (Details)
> namespace: **VDM\Joomla\Componentbuilder\Compiler**
2023-10-04 18:28:29 +00:00
> extends: **BaseConfig**
2023-03-21 22:52:57 +00:00
```uml
@startuml
class Config #Gold {
# JoomlaRegistry $config
+ __construct(?Input $input = null, ?JoomlaRegistry $params = null, ...)
# getGiteatoken() : ?string
2023-10-04 18:28:29 +00:00
# getAddcustomgiteaurl() : int
# getCustomgiteaurl() : ?string
# getCustomgiteatoken() : ?string
2023-10-24 08:36:39 +00:00
# getSuperpowerscoreorganisation() : string
# getSuperpowerscorerepos() : array
2023-03-21 22:52:57 +00:00
# getAddcontributors() : bool
# getAddajax() : bool
# getAddsiteajax() : bool
# getAddeximport() : bool
# getAddcheckin() : bool
# getComponentid() : int
# getComponentversion() : string
# getComponentcodename() : string
# getComponentcontext() : string
# getComponentcodenamelength() : int
2024-01-27 07:09:33 +00:00
# getAddnamespaceprefix() : bool
# getNamespaceprefix() : string
2023-03-21 22:52:57 +00:00
# getJoomlaversion() : int
# getJoomlaversions() : array
# getJoomlaversionname() : string
# getSetjoomlafields() : bool
# getShowadvancedoptions() : bool
# getIndentationvalue() : string
# getAddbuilddate() : int
# getBuilddate() : string
# getBackup() : int
# getRepository() : int
# getDebuglinenr() : int
# getMinify() : int
# getRemovelinebreaks() : bool
# getTidy() : bool
# getSettidywarning() : bool
# getSettaghistory() : bool
2024-01-27 07:09:33 +00:00
# getPercentagelanguageadd() : int
2023-03-21 22:52:57 +00:00
# getLangtag() : string
# getLangprefix() : string
# getLangtarget() : string
# getLangstringtargets() : array
# getLangstringkeytargets() : array
# getFieldbuildertype() : int
# getDefaultfields() : array
# getTmppath() : string
# getCompilerpath() : string
# getJcbpowerspath() : string
2024-01-27 07:09:33 +00:00
# getPowerlibraryfolder() : string
2023-03-21 22:52:57 +00:00
# getLocalpowersrepositorypath() : string
# getApprovedpaths() : array
2023-03-21 22:52:57 +00:00
# getBompath() : string
# getCustomfolderpath() : string
# getAddassetstablefix() : int
# getAddassetstablenamefix() : bool
# getAccessworsecase() : int
# getMysqltablekeys() : array
# getAddplaceholders() : bool
# getAddpower() : bool
# getAddsuperpowers() : bool
# getAddownpowers() : bool
2023-03-21 22:52:57 +00:00
# getBuildtarget() : string
# getCryptiontypes() : array
# getBasicencryption() : bool
# getMediumencryption() : bool
# getWhmcsencryption() : bool
# getRemovesitefolder() : bool
# getRemovesiteeditfolder() : bool
# getUikit() : int
# getGooglechart() : bool
# getFootable() : bool
# getFootableversion() : int
2024-01-27 07:09:33 +00:00
# getPermissionstrictperfield() : bool
# getExporttextonly() : int
2023-03-21 22:52:57 +00:00
}
note right of Config::__construct
Constructor
since: 3.2.0
arguments:
?Input $input = null
?JoomlaRegistry $params = null
?JoomlaRegistry $config = null
end note
note left of Config::getGiteatoken
get Gitea Access Token
since: 3.2.0
return: ?string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getAddcustomgiteaurl
get Add Custom Gitea URL
since: 3.2.0
return: int
end note
note left of Config::getCustomgiteaurl
get Custom Gitea URL
since: 3.2.0
return: ?string
end note
note right of Config::getCustomgiteatoken
get Custom Gitea Access Token
since: 3.2.0
return: ?string
end note
2023-10-24 08:36:39 +00:00
note left of Config::getSuperpowerscoreorganisation
Get super power core organisation
since: 3.2.0
return: string
end note
note right of Config::getSuperpowerscorerepos
Get super power core repos
since: 3.2.0
return: array
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddcontributors
2023-03-21 22:52:57 +00:00
get add contributors switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getAddajax
2023-03-21 22:52:57 +00:00
get Add Ajax Switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddsiteajax
2023-03-21 22:52:57 +00:00
get Add Site Ajax Switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getAddeximport
2023-03-21 22:52:57 +00:00
get add eximport
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddcheckin
2023-03-21 22:52:57 +00:00
get add checkin
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getComponentid
2023-03-21 22:52:57 +00:00
get posted component id
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note left of Config::getComponentversion
2023-03-21 22:52:57 +00:00
get component version
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getComponentcodename
2023-03-21 22:52:57 +00:00
get components code name
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note left of Config::getComponentcontext
2023-03-21 22:52:57 +00:00
get component context
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getComponentcodenamelength
2023-03-21 22:52:57 +00:00
get component code name length
since: 3.2.0
return: int
end note
2024-01-27 07:09:33 +00:00
note left of Config::getAddnamespaceprefix
get add namespace prefix
since: 3.2.0
return: bool
end note
note right of Config::getNamespaceprefix
get namespace prefix
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note left of Config::getJoomlaversion
2023-03-21 22:52:57 +00:00
get posted Joomla version
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note right of Config::getJoomlaversions
2023-03-21 22:52:57 +00:00
get Joomla versions
since: 3.2.0
return: array
end note
2023-10-04 18:28:29 +00:00
note left of Config::getJoomlaversionname
2023-03-21 22:52:57 +00:00
get posted Joomla version name
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getSetjoomlafields
2023-03-21 22:52:57 +00:00
set joomla fields
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getShowadvancedoptions
2023-03-21 22:52:57 +00:00
get show advanced options switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getIndentationvalue
2023-03-21 22:52:57 +00:00
get indentation value
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddbuilddate
2023-03-21 22:52:57 +00:00
get add build date switch
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note right of Config::getBuilddate
2023-03-21 22:52:57 +00:00
get build date
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note left of Config::getBackup
2023-03-21 22:52:57 +00:00
get posted backup switch
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note right of Config::getRepository
2023-03-21 22:52:57 +00:00
get posted repository switch
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note left of Config::getDebuglinenr
2023-03-21 22:52:57 +00:00
get posted debuglinenr switch
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note right of Config::getMinify
2023-03-21 22:52:57 +00:00
get posted minify switch
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note left of Config::getRemovelinebreaks
2023-03-21 22:52:57 +00:00
get posted remove line breaks switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getTidy
2023-03-21 22:52:57 +00:00
get system tidy state
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getSettidywarning
2023-03-21 22:52:57 +00:00
add tidy warning
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getSettaghistory
2023-03-21 22:52:57 +00:00
get history tag switch
since: 3.2.0
return: bool
end note
2024-01-27 07:09:33 +00:00
note left of Config::getPercentagelanguageadd
get percentage when a language should be added
since: 3.2.0
return: int
end note
note right of Config::getLangtag
2023-03-21 22:52:57 +00:00
get language tag
since: 3.2.0
return: string
end note
2024-01-27 07:09:33 +00:00
note left of Config::getLangprefix
2023-03-21 22:52:57 +00:00
get language prefix
since: 3.2.0
return: string
end note
2024-01-27 07:09:33 +00:00
note right of Config::getLangtarget
2023-03-21 22:52:57 +00:00
get language target
since: 3.2.0
return: string
end note
2024-01-27 07:09:33 +00:00
note left of Config::getLangstringtargets
2023-03-21 22:52:57 +00:00
get language string targets
since: 3.2.0
return: array
end note
2024-01-27 07:09:33 +00:00
note right of Config::getLangstringkeytargets
2023-03-21 22:52:57 +00:00
get language string targets (by key name)
since: 3.2.0
return: array
end note
2024-01-27 07:09:33 +00:00
note left of Config::getFieldbuildertype
2023-03-21 22:52:57 +00:00
get field builder type
since: 3.2.0
return: int
end note
2024-01-27 07:09:33 +00:00
note right of Config::getDefaultfields
2023-03-21 22:52:57 +00:00
get default fields
since: 3.2.0
return: array
end note
2024-01-27 07:09:33 +00:00
note left of Config::getTmppath
2023-03-21 22:52:57 +00:00
get temporary path
since: 3.2.0
return: string
end note
2024-01-27 07:09:33 +00:00
note right of Config::getCompilerpath
2023-03-21 22:52:57 +00:00
get compiler path
since: 3.2.0
return: string
end note
2024-01-27 07:09:33 +00:00
note left of Config::getJcbpowerspath
get jcb powers path
since: 3.2.0
return: string
end note
note right of Config::getPowerlibraryfolder
2023-03-21 22:52:57 +00:00
get jcb powers path
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note left of Config::getLocalpowersrepositorypath
2023-03-21 22:52:57 +00:00
Get local super powers repository path
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getApprovedpaths
Get super power approved paths
since: 3.2.0
return: array
end note
2023-10-04 18:28:29 +00:00
note left of Config::getBompath
2023-03-21 22:52:57 +00:00
get bom path
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getCustomfolderpath
2023-03-21 22:52:57 +00:00
get custom folder path
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddassetstablefix
2023-03-21 22:52:57 +00:00
get switch to add assets table fix
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note right of Config::getAddassetstablenamefix
2023-03-21 22:52:57 +00:00
get switch to add assets table name fix
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAccessworsecase
2023-03-21 22:52:57 +00:00
get access worse case size
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note right of Config::getMysqltablekeys
2023-03-21 22:52:57 +00:00
get mysql table keys
since: 3.2.0
return: array
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddplaceholders
2023-03-21 22:52:57 +00:00
get switch add placeholders
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getAddpower
2023-03-21 22:52:57 +00:00
get switch add power
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getAddsuperpowers
2023-03-21 22:52:57 +00:00
Get switch to add super powers
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getAddownpowers
Get switch to add own super powers
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getBuildtarget
2023-03-21 22:52:57 +00:00
get switch build target switch
since: 3.2.0
return: string
end note
2023-10-04 18:28:29 +00:00
note right of Config::getCryptiontypes
2023-03-21 22:52:57 +00:00
get encryption types
since: 3.2.0
return: array
end note
2023-10-04 18:28:29 +00:00
note left of Config::getBasicencryption
2023-03-21 22:52:57 +00:00
get basic encryption switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getMediumencryption
2023-03-21 22:52:57 +00:00
get medium encryption switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getWhmcsencryption
2023-03-21 22:52:57 +00:00
get whmcs encryption switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getRemovesitefolder
2023-03-21 22:52:57 +00:00
Should we remove the site folder
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getRemovesiteeditfolder
2023-03-21 22:52:57 +00:00
Should we remove the site edit folder
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getUikit
2023-03-21 22:52:57 +00:00
The Uikit switch
since: 3.2.0
return: int
end note
2023-10-04 18:28:29 +00:00
note left of Config::getGooglechart
2023-03-21 22:52:57 +00:00
The google chart switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note right of Config::getFootable
2023-03-21 22:52:57 +00:00
The footable switch
since: 3.2.0
return: bool
end note
2023-10-04 18:28:29 +00:00
note left of Config::getFootableversion
2023-03-21 22:52:57 +00:00
The footable version
since: 3.2.0
return: int
end note
2024-01-27 07:09:33 +00:00
note right of Config::getPermissionstrictperfield
The Permission Strict Per Field Switch
since: 3.2.0
return: bool
end note
note left of Config::getExporttextonly
The Export Text Only Switch
since: 3.2.0
return: int
end note
2023-03-21 22:52:57 +00:00
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)