jcb-compiler/src/9387215f-a965-4421-acf3-5e8f9d11382f/README.md

59 lines
1.9 KiB
Markdown
Raw Normal View History

2023-03-21 22:52:57 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Name (Details)
> namespace: **VDM\Joomla\Componentbuilder\Compiler\Field**
```uml
@startuml
class Name #Gold {
# array $unique
# Placeholder $placeholder
2023-10-04 18:28:29 +00:00
# UniqueName $uniquename
# CategoryOtherName $categoryothername
+ __construct(Placeholder $placeholder, UniqueName $uniquename, ...)
2023-03-21 22:52:57 +00:00
+ get(array $field, ?string $listViewName = null, ...) : string
}
note right of Name::__construct
2023-10-04 18:28:29 +00:00
Constructor.
2023-03-21 22:52:57 +00:00
since: 3.2.0
arguments:
2023-10-04 18:28:29 +00:00
Placeholder $placeholder
UniqueName $uniquename
CategoryOtherName $categoryothername
2023-03-21 22:52:57 +00:00
end note
note right of Name::get
Get the field's actual name
since: 3.2.0
return: string
arguments:
array $field
?string $listViewName = null
string $amicably = ''
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)