jcb-compiler/src/6784dd52-0909-451a-a872-9a9...
Robot 3e3cd1e212
update 2023-10-24 10:36:32
2023-10-24 10:36:39 +02:00
..
README.md update 2023-10-24 10:36:32 2023-10-24 10:36:39 +02:00
code.php update 2023-10-24 10:36:32 2023-10-24 10:36:39 +02:00
code.power update 2023-10-24 10:36:32 2023-10-24 10:36:39 +02:00
settings.json update 2023-04-30 01:34:12 2023-04-30 01:34:15 +02:00

README.md

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

final class Grep (Details)

namespace: VDM\Joomla\Componentbuilder\Power

@startuml
class Grep << (F,LightGreen) >> #RoyalBlue {
  + ?string $path
  + ?array $paths
  # Contents $contents
  # CMSApplication $app
  + __construct(string $path, array $paths, ...)
  + getRemotePowersGuid() : ?array
  + get(string $guid, array $order = ['local', 'remote']) : ?object
  - searchLocal(string $guid) : ?object
  - searchRemote(string $guid) : ?object
  - getLocal(object $path, string $guid) : ?object
  - getRemote(object $path, string $guid) : ?object
  - init() : void
  - localIndex(object $path) : void
  - remoteIndex(object $path) : void
  - loadRemoteFile(string $owner, string $repo, ...) : mixed
  - getFunctionName(string $name) : ?string
}

note right of Grep::__construct
  Constructor.

  since: 3.2.0
  
  arguments:
    string $path
    array $paths
    Contents $contents
    ?CMSApplication $app = null
end note

note left of Grep::getRemotePowersGuid
  Get all remote powers GUID's

  since: 3.2.0
  return: ?array
end note

note right of Grep::get
  Get a power

  since: 3.2.0
  return: ?object
end note

note left of Grep::searchLocal
  Search for a local power

  since: 3.2.0
  return: ?object
end note

note right of Grep::searchRemote
  Search for a remote power

  since: 3.2.0
  return: ?object
end note

note left of Grep::getLocal
  Get a local power

  since: 3.2.0
  return: ?object
end note

note right of Grep::getRemote
  Get a remote power

  since: 3.2.0
  return: ?object
end note

note left of Grep::init
  Set path details

  since: 3.2.0
  return: void
end note

note right of Grep::localIndex
  Load the local repository index of powers

  since: 3.2.0
  return: void
end note

note left of Grep::remoteIndex
  Load the remote repository index of powers

  since: 3.2.0
  return: void
end note

note right of Grep::loadRemoteFile
  Load the remote file

  since: 3.2.0
  return: mixed
  
  arguments:
    string $owner
    string $repo
    string $path
    ?string $branch
end note

note left of Grep::getFunctionName
  Get function name

  since: 3.2.0
  return: ?string
end note
 
@enduml

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

Build with Joomla Component Builder