jcb-compiler/src/fa4bf18e-301e-42e3-91fb-6e0096c07adc
2024-12-16 18:27:29 +02:00
..
code.php Update 2024-12-16 18:27:10 2024-12-16 18:27:29 +02:00
code.power Update 2024-09-20 03:29:01 2024-09-20 03:29:00 +02:00
README.md Update 2024-12-16 18:27:10 2024-12-16 18:27:29 +02:00
settings.json Update 2024-07-16 14:08:12 2024-07-16 14:08:43 +02:00

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

class Config (Details)

namespace: VDM\Joomla\Componentbuilder\Compiler extends: ComponentConfig

@startuml
class Config  #Gold {
  # JoomlaRegistry $config
  + __construct(?Input $input = null, ?JoomlaRegistry $params = null, ...)
  # getGiteausername() : ?string
  # getGiteatoken() : ?string
  # getSuperpowerscoreorganisation() : string
  # getSuperpowerscorerepos() : array
  # getAddcontributors() : bool
  # getAddajax() : bool
  # getAddsiteajax() : bool
  # getAddeximport() : bool
  # getAddcheckin() : bool
  # getComponentid() : int
  # getComponentversion() : string
  # getComponentcodename() : string
  # getComponentcontext() : string
  # getComponentcodenamelength() : int
  # getComponentautoloaderpath() : string
  # getComponentinstallerautoloaderpath() : string
  # getAddnamespaceprefix() : bool
  # getNamespaceprefix() : string
  # 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
  # getPercentagelanguageadd() : int
  # getLangtag() : string
  # getLangprefix() : string
  # getLangtarget() : string
  # getLangstringtargets() : array
  # getLangstringkeytargets() : array
  # getFieldbuildertype() : int
  # getDefaultfields() : array
  # getTmppath() : string
  # getCompilerpath() : string
  # getJcbpowerspath() : string
  # getPowerlibraryfolder() : string
  # getLocalpowersrepositorypath() : string
  # getApprovedpaths() : array
  # getJoomlapowerscoreorganisation() : string
  # getJoomlapowersinitrepos() : array
  # getLocaljoomlapowersrepositorypath() : string
  # getApprovedjoomlapaths() : array
  # getBompath() : string
  # getCustomfolderpath() : string
  # getAddassetstablefix() : int
  # getAddassetstablenamefix() : bool
  # getAccessworsecase() : int
  # getMysqltablekeys() : array
  # getAddplaceholders() : bool
  # getAddpower() : bool
  # getAddsuperpowers() : bool
  # getAddownpowers() : bool
  # getBuildtarget() : string
  # getCryptiontypes() : array
  # getBasicencryption() : bool
  # getMediumencryption() : bool
  # getWhmcsencryption() : bool
  # getRemovesitefolder() : bool
  # getRemovesiteeditfolder() : bool
  # getUikit() : int
  # getGooglechart() : bool
  # getFootable() : bool
  # getFootableversion() : int
  # getPermissionstrictperfield() : bool
  # getExporttextonly() : int
}

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::getGiteausername
  get Gitea Username

  since: 3.2.0
  return: ?string
end note

note right of Config::getGiteatoken
  get Gitea Access Token

  since: 3.2.0
  return: ?string
end note

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

note left of Config::getAddcontributors
  get add contributors switch

  since: 3.2.0
  return: bool
end note

note right of Config::getAddajax
  get Add Ajax Switch

  since: 3.2.0
  return: bool
end note

note left of Config::getAddsiteajax
  get Add Site Ajax Switch

  since: 3.2.0
  return: bool
end note

note right of Config::getAddeximport
  get add eximport

  since: 3.2.0
  return: bool
end note

note left of Config::getAddcheckin
  get add checkin

  since: 3.2.0
  return: bool
end note

note right of Config::getComponentid
  get posted component id

  since: 3.2.0
  return: int
end note

note left of Config::getComponentversion
  get component version

  since: 3.2.0
  return: string
end note

note right of Config::getComponentcodename
  get components code name

  since: 3.2.0
  return: string
end note

note left of Config::getComponentcontext
  get component context

  since: 3.2.0
  return: string
end note

note right of Config::getComponentcodenamelength
  get component code name length

  since: 3.2.0
  return: int
end note

note left of Config::getComponentautoloaderpath
  get component autoloader path

  since: 3.2.0
  return: string
end note

note right of Config::getComponentinstallerautoloaderpath
  get component installer autoloader path

  since: 5.0.2
  return: string
end note

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

note left of Config::getJoomlaversion
  get posted Joomla version

  since: 3.2.0
  return: int
end note

note right of Config::getJoomlaversions
  get Joomla versions

  since: 3.2.0
  return: array
end note

note left of Config::getJoomlaversionname
  get posted Joomla version name

  since: 3.2.0
  return: string
end note

note right of Config::getSetjoomlafields
  set joomla fields

  since: 3.2.0
  return: bool
end note

note left of Config::getShowadvancedoptions
  get show advanced options switch

  since: 3.2.0
  return: bool
end note

note right of Config::getIndentationvalue
  get indentation value

  since: 3.2.0
  return: string
end note

note left of Config::getAddbuilddate
  get add build date switch

  since: 3.2.0
  return: int
end note

note right of Config::getBuilddate
  get build date

  since: 3.2.0
  return: string
end note

note left of Config::getBackup
  get posted backup switch

  since: 3.2.0
  return: int
end note

note right of Config::getRepository
  get posted repository switch

  since: 3.2.0
  return: int
end note

note left of Config::getDebuglinenr
  get posted debuglinenr switch

  since: 3.2.0
  return: int
end note

note right of Config::getMinify
  get posted minify switch

  since: 3.2.0
  return: int
end note

note left of Config::getRemovelinebreaks
  get posted remove line breaks switch

  since: 3.2.0
  return: bool
end note

note right of Config::getTidy
  get system tidy state

  since: 3.2.0
  return: bool
end note

note left of Config::getSettidywarning
  add tidy warning

  since: 3.2.0
  return: bool
end note

note right of Config::getSettaghistory
  get history tag switch

  since: 3.2.0
  return: bool
end note

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
  get language tag

  since: 3.2.0
  return: string
end note

note left of Config::getLangprefix
  get language prefix

  since: 3.2.0
  return: string
end note

note right of Config::getLangtarget
  get language target

  since: 3.2.0
  return: string
end note

note left of Config::getLangstringtargets
  get language string targets

  since: 3.2.0
  return: array
end note

note right of Config::getLangstringkeytargets
  get language string targets (by key name)

  since: 3.2.0
  return: array
end note

note left of Config::getFieldbuildertype
  get field builder type

  since: 3.2.0
  return: int
end note

note right of Config::getDefaultfields
  get default fields

  since: 3.2.0
  return: array
end note

note left of Config::getTmppath
  get temporary path

  since: 3.2.0
  return: string
end note

note right of Config::getCompilerpath
  get compiler path

  since: 3.2.0
  return: string
end note

note left of Config::getJcbpowerspath
  get jcb powers path

  since: 3.2.0
  return: string
end note

note right of Config::getPowerlibraryfolder
  get jcb powers path

  since: 3.2.0
  return: string
end note

note left of Config::getLocalpowersrepositorypath
  Get local super powers repository path

  since: 3.2.0
  return: string
end note

note right of Config::getApprovedpaths
  Get super power approved paths

  since: 3.2.0
  return: array
end note

note left of Config::getJoomlapowerscoreorganisation
  Get super power core organisation

  since: 3.2.0
  return: string
end note

note right of Config::getJoomlapowersinitrepos
  Get Joomla power init repos

  since: 3.2.0
  return: array
end note

note left of Config::getLocaljoomlapowersrepositorypath
  Get local joomla super powers repository path

  since: 3.2.0
  return: string
end note

note right of Config::getApprovedjoomlapaths
  Get joomla power approved paths

  since: 3.2.0
  return: array
end note

note left of Config::getBompath
  get bom path

  since: 3.2.0
  return: string
end note

note right of Config::getCustomfolderpath
  get custom folder path

  since: 3.2.0
  return: string
end note

note left of Config::getAddassetstablefix
  get switch to add assets table fix

  since: 3.2.0
  return: int
end note

note right of Config::getAddassetstablenamefix
  get switch to add assets table name fix

  since: 3.2.0
  return: bool
end note

note left of Config::getAccessworsecase
  get access worse case size

  since: 3.2.0
  return: int
end note

note right of Config::getMysqltablekeys
  get mysql table keys

  since: 3.2.0
  return: array
end note

note left of Config::getAddplaceholders
  get switch add placeholders

  since: 3.2.0
  return: bool
end note

note right of Config::getAddpower
  get switch add power

  since: 3.2.0
  return: bool
end note

note left of Config::getAddsuperpowers
  Get switch to add super powers

  since: 3.2.0
  return: bool
end note

note right of Config::getAddownpowers
  Get switch to add own super powers

  since: 3.2.0
  return: bool
end note

note left of Config::getBuildtarget
  get switch build target switch

  since: 3.2.0
  return: string
end note

note right of Config::getCryptiontypes
  get encryption types

  since: 3.2.0
  return: array
end note

note left of Config::getBasicencryption
  get basic encryption switch

  since: 3.2.0
  return: bool
end note

note right of Config::getMediumencryption
  get medium encryption switch

  since: 3.2.0
  return: bool
end note

note left of Config::getWhmcsencryption
  get whmcs encryption switch

  since: 3.2.0
  return: bool
end note

note right of Config::getRemovesitefolder
  Should we remove the site folder

  since: 3.2.0
  return: bool
end note

note left of Config::getRemovesiteeditfolder
  Should we remove the site edit folder

  since: 3.2.0
  return: bool
end note

note right of Config::getUikit
  The Uikit switch

  since: 3.2.0
  return: int
end note

note left of Config::getGooglechart
  The google chart switch

  since: 3.2.0
  return: bool
end note

note right of Config::getFootable
  The footable switch

  since: 3.2.0
  return: bool
end note

note left of Config::getFootableversion
  The footable version

  since: 3.2.0
  return: int
end note

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
 
@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---fa4bf18e_301e_42e3_91fb_6e0096c07adc---Power

remember to replace the --- with ___ to activate this Power in your code


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

Build with Joomla Component Builder