jcb-compiler/src/3730a000-ab64-477d-8b0f-70eaf71b517a/README.md
2024-04-15 06:03:20 +02:00

3.2 KiB

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

final class JoomlaPower (Details)

namespace: VDM\Joomla\Componentbuilder\Compiler

@startuml
class JoomlaPower << (F,LightGreen) >> #RoyalBlue {
  + array $active
  + array $namespace
  + array $superpowers
  # string $fixUrl
  # array $state
  # array $retry
  # Config $config
  # Placeholder $placeholder
  # Customcode $customcode
  # Gui $gui
  # Superpower $superpower
  # $db
  # $app
  + __construct(Config $config, Placeholder $placeholder, ...)
  + load(array $guids) : void
  + get(string $guid, int $build) : ?object
  - set(string $guid) : bool
  - isPowerSet(string $guid) : bool
  - isGuidValid(string $guid) : bool
  - getPowerData(string $guid) : ?object
  - getCleanNamespace(string $namespace) : string
  - getUseNamespace(string $namespace, string $as = 'default') : string
  - setSuperPowers(string $guid) : void
}

note right of JoomlaPower::__construct
  Constructor.

  since: 3.2.0
  
  arguments:
    Config $config
    Placeholder $placeholder
    Customcode $customcode
    Gui $gui
    Superpower $superpower
end note

note left of JoomlaPower::load
  load all the powers linked to this component

  since: 3.2.0
  return: void
end note

note right of JoomlaPower::get
  Get a power

  since: 3.2.0
  return: ?object
end note

note left of JoomlaPower::set
  Set a power

  since: 3.2.0
  return: bool
end note

note right of JoomlaPower::isPowerSet
  Check if the power is already set

  since: 3.2.0
  return: bool
end note

note left of JoomlaPower::isGuidValid
  Validate the GUID

  since: 3.2.0
  return: bool
end note

note right of JoomlaPower::getPowerData
  Get the power data from the database

  since: 3.2.0
  return: ?object
end note

note left of JoomlaPower::getCleanNamespace
  Get Clean Namespace without use or ; as part of the name space

  since: 3.2.0
  return: string
end note

note right of JoomlaPower::getUseNamespace
  Get [use Namespace\Class;]

  since: 3.2.0
  return: string
end note

note left of JoomlaPower::setSuperPowers
  Set the super powers of this power

  since: 3.2.0
  return: void
end note
 
@enduml

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

Build with Joomla Component Builder