Sort index, and remove uml from main readme. #1

Merged
Llewellyn merged 1 commits from dev into master 2023-05-22 01:00:32 +00:00
2 changed files with 108 additions and 307 deletions

203
README.md
View File

@ -31,7 +31,9 @@ This repository contains an index (see below) of all the approved powers within
- **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) | Super__a25c82c8_14c2_40df_adae_f832709ab49b__Power
- **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) | Super__e98b4edc_25b9_49d7_98a0_e42ad3b75efe__Power
- **class KeyLoader** | [Details](src/6da44dff-a221-4f22-b9d9-b2fc2a724b4b) | [Code](src/6da44dff-a221-4f22-b9d9-b2fc2a724b4b/code.php) | [Settings](src/6da44dff-a221-4f22-b9d9-b2fc2a724b4b/settings.json) | Super__6da44dff_a221_4f22_b9d9_b2fc2a724b4b__Power
- **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) | Super__fea2b107_3ee4_4ebf_84be_d3f2829c8614__Power
- **class Random** | [Details](src/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c) | [Code](src/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c/code.php) | [Settings](src/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c/settings.json) | Super__c46a42b4_b0d3_48e7_a6fa_af0399e1e66c__Power
- **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) | Super__11be6be3_ee3e_4771_8663_5545b76b73ab__Power
@ -48,207 +50,6 @@ This repository contains an index (see below) of all the approved powers within
- **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) | Super__f37ee8b7_2909_4319_bdf8_769bd7635490__Power
# 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
```
---
```
██╗ ██████╗ ██████╗ ███╗ ███╗██╗ █████╗

View File

@ -1,36 +1,25 @@
{
"c46a42b4-b0d3-48e7-a6fa-af0399e1e66c": {
"name": "Random",
"11be6be3-ee3e-4771-8663-5545b76b73ab": {
"name": "Ftp",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c\/code.php",
"power": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c\/code.power",
"settings": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c\/settings.json",
"path": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c",
"spk": "Super__c46a42b4_b0d3_48e7_a6fa_af0399e1e66c__Power",
"guid": "c46a42b4-b0d3-48e7-a6fa-af0399e1e66c"
"namespace": "VDM\\Joomla\\Componentbuilder\\Server",
"code": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab\/code.php",
"power": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab\/code.power",
"settings": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab\/settings.json",
"path": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab",
"spk": "Super__11be6be3_ee3e_4771_8663_5545b76b73ab__Power",
"guid": "11be6be3-ee3e-4771-8663-5545b76b73ab"
},
"e98b4edc-25b9-49d7-98a0-e42ad3b75efe": {
"name": "FOF",
"42ceff0b-226d-42ff-9ffa-3d5935890337": {
"name": "Server",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe\/code.php",
"power": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe\/code.power",
"settings": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe\/settings.json",
"path": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe",
"spk": "Super__e98b4edc_25b9_49d7_98a0_e42ad3b75efe__Power",
"guid": "e98b4edc-25b9-49d7-98a0-e42ad3b75efe"
},
"a25c82c8-14c2-40df-adae-f832709ab49b": {
"name": "Aes",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/a25c82c8-14c2-40df-adae-f832709ab49b\/code.php",
"power": "src\/a25c82c8-14c2-40df-adae-f832709ab49b\/code.power",
"settings": "src\/a25c82c8-14c2-40df-adae-f832709ab49b\/settings.json",
"path": "src\/a25c82c8-14c2-40df-adae-f832709ab49b",
"spk": "Super__a25c82c8_14c2_40df_adae_f832709ab49b__Power",
"guid": "a25c82c8-14c2-40df-adae-f832709ab49b"
"namespace": "VDM\\Joomla\\Componentbuilder\\Service",
"code": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337\/code.php",
"power": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337\/code.power",
"settings": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337\/settings.json",
"path": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337",
"spk": "Super__42ceff0b_226d_42ff_9ffa_3d5935890337__Power",
"guid": "42ceff0b-226d-42ff-9ffa-3d5935890337"
},
"437af6b0-ca02-49d7-8739-4edfc8a9ccb0": {
"name": "Legacy",
@ -43,38 +32,16 @@
"spk": "Super__437af6b0_ca02_49d7_8739_4edfc8a9ccb0__Power",
"guid": "437af6b0-ca02-49d7-8739-4edfc8a9ccb0"
},
"fea2b107-3ee4-4ebf-84be-d3f2829c8614": {
"name": "Password",
"490b6aa5-5de7-4be5-a61a-f634f6e004c0": {
"name": "Sftp",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614\/code.php",
"power": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614\/code.power",
"settings": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614\/settings.json",
"path": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614",
"spk": "Super__fea2b107_3ee4_4ebf_84be_d3f2829c8614__Power",
"guid": "fea2b107-3ee4-4ebf-84be-d3f2829c8614"
},
"d357e796-9f22-4615-9ebc-970b42cbd280": {
"name": "Crypt",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder",
"code": "src\/d357e796-9f22-4615-9ebc-970b42cbd280\/code.php",
"power": "src\/d357e796-9f22-4615-9ebc-970b42cbd280\/code.power",
"settings": "src\/d357e796-9f22-4615-9ebc-970b42cbd280\/settings.json",
"path": "src\/d357e796-9f22-4615-9ebc-970b42cbd280",
"spk": "Super__d357e796_9f22_4615_9ebc_970b42cbd280__Power",
"guid": "d357e796-9f22-4615-9ebc-970b42cbd280"
},
"6da44dff-a221-4f22-b9d9-b2fc2a724b4b": {
"name": "KeyLoader",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b\/code.php",
"power": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b\/code.power",
"settings": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b\/settings.json",
"path": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b",
"spk": "Super__6da44dff_a221_4f22_b9d9_b2fc2a724b4b__Power",
"guid": "6da44dff-a221-4f22-b9d9-b2fc2a724b4b"
"namespace": "VDM\\Joomla\\Componentbuilder\\Server",
"code": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0\/code.php",
"power": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0\/code.power",
"settings": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0\/settings.json",
"path": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0",
"spk": "Super__490b6aa5_5de7_4be5_a61a_f634f6e004c0__Power",
"guid": "490b6aa5-5de7-4be5-a61a-f634f6e004c0"
},
"4d8f38ef-8f3a-463d-8678-0bf087ac6815": {
"name": "Crypt",
@ -87,16 +54,38 @@
"spk": "Super__4d8f38ef_8f3a_463d_8678_0bf087ac6815__Power",
"guid": "4d8f38ef-8f3a-463d-8678-0bf087ac6815"
},
"f37ee8b7-2909-4319-bdf8-769bd7635490": {
"name": "Load",
"66355f70-c26c-4765-ba48-498e3df740ef": {
"name": "Server",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Server\\Model",
"code": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490\/code.php",
"power": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490\/code.power",
"settings": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490\/settings.json",
"path": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490",
"spk": "Super__f37ee8b7_2909_4319_bdf8_769bd7635490__Power",
"guid": "f37ee8b7-2909-4319-bdf8-769bd7635490"
"namespace": "VDM\\Joomla\\Componentbuilder",
"code": "src\/66355f70-c26c-4765-ba48-498e3df740ef\/code.php",
"power": "src\/66355f70-c26c-4765-ba48-498e3df740ef\/code.power",
"settings": "src\/66355f70-c26c-4765-ba48-498e3df740ef\/settings.json",
"path": "src\/66355f70-c26c-4765-ba48-498e3df740ef",
"spk": "Super__66355f70_c26c_4765_ba48_498e3df740ef__Power",
"guid": "66355f70-c26c-4765-ba48-498e3df740ef"
},
"6da44dff-a221-4f22-b9d9-b2fc2a724b4b": {
"name": "KeyLoader",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b\/code.php",
"power": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b\/code.power",
"settings": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b\/settings.json",
"path": "src\/6da44dff-a221-4f22-b9d9-b2fc2a724b4b",
"spk": "Super__6da44dff_a221_4f22_b9d9_b2fc2a724b4b__Power",
"guid": "6da44dff-a221-4f22-b9d9-b2fc2a724b4b"
},
"a25c82c8-14c2-40df-adae-f832709ab49b": {
"name": "Aes",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/a25c82c8-14c2-40df-adae-f832709ab49b\/code.php",
"power": "src\/a25c82c8-14c2-40df-adae-f832709ab49b\/code.power",
"settings": "src\/a25c82c8-14c2-40df-adae-f832709ab49b\/settings.json",
"path": "src\/a25c82c8-14c2-40df-adae-f832709ab49b",
"spk": "Super__a25c82c8_14c2_40df_adae_f832709ab49b__Power",
"guid": "a25c82c8-14c2-40df-adae-f832709ab49b"
},
"a3414824-e99d-4878-b3d1-b5deef0cae17": {
"name": "Load",
@ -109,48 +98,59 @@
"spk": "Super__a3414824_e99d_4878_b3d1_b5deef0cae17__Power",
"guid": "a3414824-e99d-4878-b3d1-b5deef0cae17"
},
"11be6be3-ee3e-4771-8663-5545b76b73ab": {
"name": "Ftp",
"c46a42b4-b0d3-48e7-a6fa-af0399e1e66c": {
"name": "Random",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Server",
"code": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab\/code.php",
"power": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab\/code.power",
"settings": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab\/settings.json",
"path": "src\/11be6be3-ee3e-4771-8663-5545b76b73ab",
"spk": "Super__11be6be3_ee3e_4771_8663_5545b76b73ab__Power",
"guid": "11be6be3-ee3e-4771-8663-5545b76b73ab"
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c\/code.php",
"power": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c\/code.power",
"settings": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c\/settings.json",
"path": "src\/c46a42b4-b0d3-48e7-a6fa-af0399e1e66c",
"spk": "Super__c46a42b4_b0d3_48e7_a6fa_af0399e1e66c__Power",
"guid": "c46a42b4-b0d3-48e7-a6fa-af0399e1e66c"
},
"490b6aa5-5de7-4be5-a61a-f634f6e004c0": {
"name": "Sftp",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Server",
"code": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0\/code.php",
"power": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0\/code.power",
"settings": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0\/settings.json",
"path": "src\/490b6aa5-5de7-4be5-a61a-f634f6e004c0",
"spk": "Super__490b6aa5_5de7_4be5_a61a_f634f6e004c0__Power",
"guid": "490b6aa5-5de7-4be5-a61a-f634f6e004c0"
},
"66355f70-c26c-4765-ba48-498e3df740ef": {
"name": "Server",
"d357e796-9f22-4615-9ebc-970b42cbd280": {
"name": "Crypt",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder",
"code": "src\/66355f70-c26c-4765-ba48-498e3df740ef\/code.php",
"power": "src\/66355f70-c26c-4765-ba48-498e3df740ef\/code.power",
"settings": "src\/66355f70-c26c-4765-ba48-498e3df740ef\/settings.json",
"path": "src\/66355f70-c26c-4765-ba48-498e3df740ef",
"spk": "Super__66355f70_c26c_4765_ba48_498e3df740ef__Power",
"guid": "66355f70-c26c-4765-ba48-498e3df740ef"
"code": "src\/d357e796-9f22-4615-9ebc-970b42cbd280\/code.php",
"power": "src\/d357e796-9f22-4615-9ebc-970b42cbd280\/code.power",
"settings": "src\/d357e796-9f22-4615-9ebc-970b42cbd280\/settings.json",
"path": "src\/d357e796-9f22-4615-9ebc-970b42cbd280",
"spk": "Super__d357e796_9f22_4615_9ebc_970b42cbd280__Power",
"guid": "d357e796-9f22-4615-9ebc-970b42cbd280"
},
"42ceff0b-226d-42ff-9ffa-3d5935890337": {
"name": "Server",
"e98b4edc-25b9-49d7-98a0-e42ad3b75efe": {
"name": "FOF",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Service",
"code": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337\/code.php",
"power": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337\/code.power",
"settings": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337\/settings.json",
"path": "src\/42ceff0b-226d-42ff-9ffa-3d5935890337",
"spk": "Super__42ceff0b_226d_42ff_9ffa_3d5935890337__Power",
"guid": "42ceff0b-226d-42ff-9ffa-3d5935890337"
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe\/code.php",
"power": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe\/code.power",
"settings": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe\/settings.json",
"path": "src\/e98b4edc-25b9-49d7-98a0-e42ad3b75efe",
"spk": "Super__e98b4edc_25b9_49d7_98a0_e42ad3b75efe__Power",
"guid": "e98b4edc-25b9-49d7-98a0-e42ad3b75efe"
},
"f37ee8b7-2909-4319-bdf8-769bd7635490": {
"name": "Load",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Server\\Model",
"code": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490\/code.php",
"power": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490\/code.power",
"settings": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490\/settings.json",
"path": "src\/f37ee8b7-2909-4319-bdf8-769bd7635490",
"spk": "Super__f37ee8b7_2909_4319_bdf8_769bd7635490__Power",
"guid": "f37ee8b7-2909-4319-bdf8-769bd7635490"
},
"fea2b107-3ee4-4ebf-84be-d3f2829c8614": {
"name": "Password",
"type": "class",
"namespace": "VDM\\Joomla\\Componentbuilder\\Crypt",
"code": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614\/code.php",
"power": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614\/code.power",
"settings": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614\/settings.json",
"path": "src\/fea2b107-3ee4-4ebf-84be-d3f2829c8614",
"spk": "Super__fea2b107_3ee4_4ebf_84be_d3f2829c8614__Power",
"guid": "fea2b107-3ee4-4ebf-84be-d3f2829c8614"
}
}