forked from joomla/phpseclib
275 lines
12 KiB
Markdown
275 lines
12 KiB
Markdown
```
|
|
███████╗██╗ ██╗██████╗ ███████╗██████╗
|
|
██╔════╝██║ ██║██╔══██╗██╔════╝██╔══██╗
|
|
███████╗██║ ██║██████╔╝█████╗ ██████╔╝
|
|
╚════██║██║ ██║██╔═══╝ ██╔══╝ ██╔══██╗
|
|
███████║╚██████╔╝██║ ███████╗██║ ██║
|
|
╚══════╝ ╚═════╝ ╚═╝ ╚══════╝╚═╝ ╚═╝
|
|
██████╗ ██████╗ ██╗ ██╗███████╗██████╗ ███████╗
|
|
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗██╔════╝
|
|
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝███████╗
|
|
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗╚════██║
|
|
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║███████║
|
|
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝╚══════╝
|
|
```
|
|
|
|
### What is JCB Super Powers?
|
|
The Joomla Component Builder (JCB) Super Power features are designed to enhance JCB's functionality and streamline the development process. These Super Powers enable developers to efficiently manage and share their custom powers across multiple JCB instances through repositories hosted on [https://git.vdm.dev/[username]/[repository-name]](https://git.vdm.dev). JCB Super Powers are managed using a combination of layers, events, tasks, methods, switches, and algorithms, which work together to provide powerful customization and extensibility options. More details on JCB Super Powers can be found in the [Super Powers Documentation](https://git.vdm.dev/joomla/super-powers/wiki).
|
|
|
|
In summary, JCB Super Powers offer a flexible and efficient way to manage and share functionalities between JCB instances. By utilizing a sophisticated system of layers, events, tasks, methods, switches, and algorithms, developers can seamlessly integrate JCB core powers and their custom powers. For more information on how to work with JCB Super Powers, refer to the [Super Powers User Guide](https://git.vdm.dev/joomla/super-powers/wiki).
|
|
|
|
### What can I find here?
|
|
This repository contains an index (see below) of all the approved powers within the JCB GUI. During the compilation of a component, these powers are automatically added to the repository, ensuring a well-organized and accessible collection of functionalities.
|
|
|
|
# Index of powers
|
|
|
|
- **Namespace**: [VDM\Joomla\Componentbuilder](#vdm-joomla-componentbuilder)
|
|
|
|
- **class Crypt** | [Details](src/d357e796-9f22-4615-9ebc-970b42cbd280) | [Code](src/d357e796-9f22-4615-9ebc-970b42cbd280/code.php) | [Settings](src/d357e796-9f22-4615-9ebc-970b42cbd280/settings.json) | Crypt
|
|
- **class Server** | [Details](src/66355f70-c26c-4765-ba48-498e3df740ef) | [Code](src/66355f70-c26c-4765-ba48-498e3df740ef/code.php) | [Settings](src/66355f70-c26c-4765-ba48-498e3df740ef/settings.json) | Server
|
|
- **Namespace**: [VDM\Joomla\Componentbuilder\Crypt](#vdm-joomla-componentbuilder-crypt)
|
|
|
|
- **class Aes** | [Details](src/a25c82c8-14c2-40df-adae-f832709ab49b) | [Code](src/a25c82c8-14c2-40df-adae-f832709ab49b/code.php) | [Settings](src/a25c82c8-14c2-40df-adae-f832709ab49b/settings.json) | Aes
|
|
- **class FOF** | [Details](src/e98b4edc-25b9-49d7-98a0-e42ad3b75efe) | [Code](src/e98b4edc-25b9-49d7-98a0-e42ad3b75efe/code.php) | [Settings](src/e98b4edc-25b9-49d7-98a0-e42ad3b75efe/settings.json) | FOF
|
|
- **class Password** | [Details](src/fea2b107-3ee4-4ebf-84be-d3f2829c8614) | [Code](src/fea2b107-3ee4-4ebf-84be-d3f2829c8614/code.php) | [Settings](src/fea2b107-3ee4-4ebf-84be-d3f2829c8614/settings.json) | Password
|
|
- **Namespace**: [VDM\Joomla\Componentbuilder\Server](#vdm-joomla-componentbuilder-server)
|
|
|
|
- **class Ftp** | [Details](src/11be6be3-ee3e-4771-8663-5545b76b73ab) | [Code](src/11be6be3-ee3e-4771-8663-5545b76b73ab/code.php) | [Settings](src/11be6be3-ee3e-4771-8663-5545b76b73ab/settings.json) | Ftp
|
|
- **class Load** | [Details](src/a3414824-e99d-4878-b3d1-b5deef0cae17) | [Code](src/a3414824-e99d-4878-b3d1-b5deef0cae17/code.php) | [Settings](src/a3414824-e99d-4878-b3d1-b5deef0cae17/settings.json) | Load
|
|
- **class Sftp** | [Details](src/490b6aa5-5de7-4be5-a61a-f634f6e004c0) | [Code](src/490b6aa5-5de7-4be5-a61a-f634f6e004c0/code.php) | [Settings](src/490b6aa5-5de7-4be5-a61a-f634f6e004c0/settings.json) | Sftp
|
|
- **Namespace**: [VDM\Joomla\Componentbuilder\Service](#vdm-joomla-componentbuilder-service)
|
|
|
|
- **class Crypt** | [Details](src/4d8f38ef-8f3a-463d-8678-0bf087ac6815) | [Code](src/4d8f38ef-8f3a-463d-8678-0bf087ac6815/code.php) | [Settings](src/4d8f38ef-8f3a-463d-8678-0bf087ac6815/settings.json) | Crypt
|
|
- **class Server** | [Details](src/42ceff0b-226d-42ff-9ffa-3d5935890337) | [Code](src/42ceff0b-226d-42ff-9ffa-3d5935890337/code.php) | [Settings](src/42ceff0b-226d-42ff-9ffa-3d5935890337/settings.json) | Server
|
|
- **Namespace**: [VDM\Joomla\Componentbuilder\Crypt\Aes](#vdm-joomla-componentbuilder-crypt-aes)
|
|
|
|
- **class Legacy** | [Details](src/437af6b0-ca02-49d7-8739-4edfc8a9ccb0) | [Code](src/437af6b0-ca02-49d7-8739-4edfc8a9ccb0/code.php) | [Settings](src/437af6b0-ca02-49d7-8739-4edfc8a9ccb0/settings.json) | Legacy
|
|
- **Namespace**: [VDM\Joomla\Componentbuilder\Server\Model](#vdm-joomla-componentbuilder-server-model)
|
|
|
|
- **class Load** | [Details](src/f37ee8b7-2909-4319-bdf8-769bd7635490) | [Code](src/f37ee8b7-2909-4319-bdf8-769bd7635490/code.php) | [Settings](src/f37ee8b7-2909-4319-bdf8-769bd7635490/settings.json) | Load
|
|
|
|
# Class Diagrams
|
|
|
|
## VDM Joomla Componentbuilder
|
|
> namespace VDM\Joomla\Componentbuilder
|
|
```uml
|
|
@startuml
|
|
|
|
namespace VDM\Joomla\Componentbuilder #DarkCyan {
|
|
|
|
|
|
class Crypt #Gold {
|
|
# FOF $fof
|
|
# Aes $aes
|
|
# Legacy $legacy
|
|
# Password $password
|
|
# array $options
|
|
# array $passwords
|
|
+ __construct()
|
|
+ encrypt() : string
|
|
+ decrypt() : string
|
|
+ exist() : bool
|
|
- getClassName() : ?string
|
|
- getClassNameFromRegistry() : ?string
|
|
- getClassNameFromOptions() : ?string
|
|
- getPassword() : ?string
|
|
- getPasswordKey() : string
|
|
- name() : string
|
|
}
|
|
|
|
class Server #Gold {
|
|
# Load $load
|
|
# Ftp $ftp
|
|
# Sftp $sftp
|
|
# User $user
|
|
+ __construct()
|
|
+ move() : bool
|
|
+ legacyMove() : bool
|
|
}
|
|
}
|
|
|
|
|
|
@enduml
|
|
```
|
|
|
|
## VDM Joomla Componentbuilder Crypt
|
|
> namespace VDM\Joomla\Componentbuilder\Crypt
|
|
```uml
|
|
@startuml
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Crypt #Olive {
|
|
|
|
|
|
class Aes #Gold {
|
|
# BASEAES $aes
|
|
# Random $random
|
|
# int $size
|
|
+ __construct()
|
|
+ encrypt() : string
|
|
+ decrypt() : string
|
|
}
|
|
|
|
class FOF #Gold {
|
|
# AES $aes
|
|
# Random $random
|
|
# int $size
|
|
+ __construct()
|
|
+ encrypt() : string
|
|
+ decrypt() : string
|
|
# getExpandedKey() : string
|
|
# resizeKey() : ?string
|
|
}
|
|
|
|
class Password #Gold {
|
|
+ get() : ?string
|
|
- local() : string
|
|
}
|
|
}
|
|
|
|
|
|
@enduml
|
|
```
|
|
|
|
## VDM Joomla Componentbuilder Server
|
|
> namespace VDM\Joomla\Componentbuilder\Server
|
|
```uml
|
|
@startuml
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Server #Olive {
|
|
|
|
|
|
class Ftp #Gold {
|
|
# ?FtpClient $client
|
|
# ?object $details
|
|
+ set() : Ftp
|
|
+ move() : bool
|
|
- connected() : bool
|
|
- getClient() : ?FtpClient
|
|
}
|
|
|
|
class Load #Gold {
|
|
# Database $db
|
|
# Model $model
|
|
+ __construct()
|
|
+ value() : mixed|null
|
|
+ item() : ?object
|
|
# setDatabaseFields() : array
|
|
}
|
|
|
|
class Sftp #Gold {
|
|
# KeyLoader $key
|
|
# ?SftpClient $client
|
|
# ?object $details
|
|
+ __construct()
|
|
+ set() : Sftp
|
|
+ move() : bool
|
|
- connected() : bool
|
|
- getClient() : ?SftpClient
|
|
}
|
|
}
|
|
|
|
|
|
@enduml
|
|
```
|
|
|
|
## VDM Joomla Componentbuilder Service
|
|
> namespace VDM\Joomla\Componentbuilder\Service
|
|
```uml
|
|
@startuml
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Service #Olive {
|
|
|
|
|
|
class Crypt #Gold {
|
|
+ register() : void
|
|
+ getCrypt() : Crypto
|
|
+ getPassword() : Password
|
|
+ getRandom() : Random
|
|
+ getKeyLoader() : KeyLoader
|
|
+ getBASEAESCBC() : BASEAES
|
|
+ getAesCBC() : Aes
|
|
+ getAesLEGACY() : Legacy
|
|
+ getFOF() : FOF
|
|
}
|
|
|
|
class Server #Gold {
|
|
+ register() : void
|
|
+ getServer() : Client
|
|
+ getServerLoad() : Load
|
|
+ getServerFtp() : Ftp
|
|
+ getServerSftp() : Sftp
|
|
}
|
|
}
|
|
|
|
|
|
@enduml
|
|
```
|
|
|
|
## VDM Joomla Componentbuilder Crypt Aes
|
|
> namespace VDM\Joomla\Componentbuilder\Crypt\Aes
|
|
```uml
|
|
@startuml
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Crypt\Aes #LightGreen {
|
|
|
|
|
|
class Legacy #Gold {
|
|
# BASEAES $aes
|
|
# int $size
|
|
+ __construct()
|
|
+ encrypt() : string
|
|
+ decrypt() : string
|
|
}
|
|
}
|
|
|
|
|
|
@enduml
|
|
```
|
|
|
|
## VDM Joomla Componentbuilder Server Model
|
|
> namespace VDM\Joomla\Componentbuilder\Server\Model
|
|
```uml
|
|
@startuml
|
|
|
|
namespace VDM\Joomla\Componentbuilder\Server\Model #LightGreen {
|
|
|
|
|
|
class Load #Gold {
|
|
# Crypt $crypt
|
|
+ __construct()
|
|
+ value() : mixed
|
|
# validateBefore() : bool
|
|
# validateAfter() : bool
|
|
# getTable() : string
|
|
}
|
|
}
|
|
|
|
|
|
@enduml
|
|
```
|
|
|
|
|
|
---
|
|
```
|
|
██╗ ██████╗ ██████╗ ███╗ ███╗██╗ █████╗
|
|
██║██╔═══██╗██╔═══██╗████╗ ████║██║ ██╔══██╗
|
|
██║██║ ██║██║ ██║██╔████╔██║██║ ███████║
|
|
██ ██║██║ ██║██║ ██║██║╚██╔╝██║██║ ██╔══██║
|
|
╚█████╔╝╚██████╔╝╚██████╔╝██║ ╚═╝ ██║███████╗██║ ██║
|
|
╚════╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝
|
|
██████╗ ██████╗ ███╗ ███╗██████╗ ██████╗ ███╗ ██╗███████╗███╗ ██╗████████╗
|
|
██╔════╝██╔═══██╗████╗ ████║██╔══██╗██╔═══██╗████╗ ██║██╔════╝████╗ ██║╚══██╔══╝
|
|
██║ ██║ ██║██╔████╔██║██████╔╝██║ ██║██╔██╗ ██║█████╗ ██╔██╗ ██║ ██║
|
|
██║ ██║ ██║██║╚██╔╝██║██╔═══╝ ██║ ██║██║╚██╗██║██╔══╝ ██║╚██╗██║ ██║
|
|
╚██████╗╚██████╔╝██║ ╚═╝ ██║██║ ╚██████╔╝██║ ╚████║███████╗██║ ╚████║ ██║
|
|
╚═════╝ ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚══════╝╚═╝ ╚═══╝ ╚═╝
|
|
██████╗ ██╗ ██╗██╗██╗ ██████╗ ███████╗██████╗
|
|
██╔══██╗██║ ██║██║██║ ██╔══██╗██╔════╝██╔══██╗
|
|
██████╔╝██║ ██║██║██║ ██║ ██║█████╗ ██████╔╝
|
|
██╔══██╗██║ ██║██║██║ ██║ ██║██╔══╝ ██╔══██╗
|
|
██████╔╝╚██████╔╝██║███████╗██████╔╝███████╗██║ ██║
|
|
╚═════╝ ╚═════╝ ╚═╝╚══════╝╚═════╝ ╚══════╝╚═╝ ╚═╝
|
|
```
|
|
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)
|
|
|