dd43b20b-e89e-48c0-b47e-b02e65b02e3c

JCB! Power

abstract class Config (Details)

namespace: VDM\Joomla\Abstraction\Remote

@startuml

abstract Config  #Orange {
  # Table $core
  # string $table
  # ?string $area
  # array $ignore
  # array $files
  # array $folders
  # array $map
  # array $children
  # array $placeholders
  + __construct(Table $core)
  + getPlaceholders() : array
  + table(string $table) : self
  + getTable() : string
  + getListViewCodeName() : ?string
  + area(string $area) : self
  + getArea() : ?string
  + setSettingsName(string $settingsName) : self
  + getSettingsName() : string
  + setIndexPath(string $indexPath) : void
  + getIndexPath() : string
  + getIndexMap() : array
  + getIndexHeader() : array
  + getSrcPath() : string
  + getMainReadmePath() : string
  + hasMainReadme() : bool
  + getItemReadmeName() : string
  + hasItemReadme() : bool
  + getFiles() : array
  + getFolders() : array
  + getMap() : array
  + getChildren() : array
  + getTitleName() : string
  + getGuidField() : string
  + getGuidHelperField() : ?string
  + getPrefixKey() : string
  + getSuffixKey() : string
}

note right of Config::__construct
  Constructor.

  since: 5.1.1
end note

note left of Config::getPlaceholders
  Get core placeholders

  since: 5.1.1
  return: array
end note

note right of Config::table
  Set the current active table

  since: 3.2.2
  return: self
end note

note left of Config::getTable
  Get the current active table

  since: 3.2.2
  return: string
end note

note right of Config::getListViewCodeName
  Get the current active table list view code name

  since: 5.1.2
  return: ?string
end note

note left of Config::area
  Set the current active area

  since: 3.2.2
  return: self
end note

note right of Config::getArea
  Get the current active area

  since: 3.2.2
  return: ?string
end note

note left of Config::setSettingsName
  Set the settings file name

  since: 3.2.2
  return: self
end note

note right of Config::getSettingsName
  Get the settings file name

  since: 3.2.2
  return: string
end note

note left of Config::setIndexPath
  Set the index path

  since: 3.2.2
  return: void
end note

note right of Config::getIndexPath
  Get the index path

  since: 3.2.2
  return: string
end note

note left of Config::getIndexMap
  Get index map

  since: 5.1.1
  return: array
end note

note right of Config::getIndexHeader
  Get index header

  since: 5.1.1
  return: array
end note

note left of Config::getSrcPath
  Get src path

  since: 5.1.1
  return: string
end note

note right of Config::getMainReadmePath
  Get main readme path

  since: 5.1.1
  return: string
end note

note left of Config::hasMainReadme
  Has main readme

  since: 5.1.1
  return: bool
end note

note right of Config::getItemReadmeName
  Get item readme path

  since: 5.1.1
  return: string
end note

note left of Config::hasItemReadme
  Has item readme

  since: 5.1.1
  return: bool
end note

note right of Config::getFiles
  Get the field names of the files in the entity

  since: 5.1.1
  return: array
end note

note left of Config::getFolders
  Get the field names of the folders in the entity

  since: 5.1.1
  return: array
end note

note right of Config::getMap
  Get map
Builds (and caches) an associative map of the table’s field names,
automatically removing any fields defined in $this->ignore.

  since: 5.1.1
  return: array
end note

note left of Config::getChildren
  Get the direct entities/children of this entity

  since: 5.1.1
  return: array
end note

note right of Config::getTitleName
  Get the table title name field

  since: 5.1.1
  return: string
end note

note left of Config::getGuidField
  Get GUID field

  since: 5.1.1
  return: string
end note

note right of Config::getGuidHelperField
  Get GUID Helper field

  since: 5.1.4
  return: ?string
end note

note left of Config::getPrefixKey
  Get Prefix Key

  since: 5.1.1
  return: string
end note

note right of Config::getSuffixKey
  Get Suffix Key

  since: 5.1.1
  return: string
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 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 maintainability.

To add this specific Power to your project in JCB:

Simply use this SPK:

Super---dd43b20b_e89e_48c0_b47e_b02e65b02e3c---Power

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

Used in Joomla Component Builder - Source - Mirror - Download

---