search/src/0b658434-3767-401e-addc-eab.../README.md

164 lines
3.8 KiB
Markdown
Raw Normal View History

2023-04-15 15:01:55 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Agent (Details)
> namespace: **VDM\Joomla\Componentbuilder\Search**
```uml
@startuml
class Agent #Gold {
# Config $config
# Load $load
# Insert $insert
# Find $find
# Replace $replace
# Search $search
# Update $update
# Table $table
# string $return
# array $marker
# array $markerHtml
+ __construct(?Config $config = null, ?Load $load = null, ...)
+ getValue(int $id, string $field, ...) : ?string
+ setValue(mixed $value, int $id, ...) : bool
+ table(?string $table = null) : ?array
+ find(?string $table = null) : ?array
+ replace(?string $table = null) : int
# getRow(string $code, string $table, ...) : array
# getRowCode(string $code) : string
# getRowEditButton(string $view, string $field, ...) : string
# setReturnValue() : void
# setMarkers() : void
}
note right of Agent::__construct
Constructor
since: 3.2.0
arguments:
?Config $config = null
?Load $load = null
?Insert $insert = null
?Find $find = null
?Replace $replace = null
?Search $search = null
?Update $update = null
?Table $table = null
end note
note left of Agent::getValue
Get the value of a field in a row and table
since: 3.2.0
return: ?string
arguments:
int $id
string $field
mixed $line = null
?string $table = null
bool $update = false
end note
note right of Agent::setValue
Set the value of a field in a row and table
since: 3.2.0
return: bool
arguments:
mixed $value
int $id
string $field
?string $table = null
end note
note left of Agent::table
Return Table Ready Search Results
since: 3.2.0
return: ?array
end note
note right of Agent::find
Search the posted table for the search value and return all
since: 3.2.0
return: ?array
end note
note left of Agent::replace
Search the posted table for the search value, and replace all
since: 3.2.0
return: int
end note
note right of Agent::getRow
Return prepared code string for table
since: 3.2.0
return: array
arguments:
string $code
string $table
string $field
int $id
mixed $line
end note
note left of Agent::getRowCode
Return prepared code string for table
since: 3.2.0
return: string
end note
note right of Agent::getRowEditButton
Get the Item button to edit an item
since: 3.2.0
return: string
arguments:
string $view
string $field
int $id
mixed $line
end note
note left of Agent::setReturnValue
Set the return value for this search
since: 3.2.0
return: void
end note
note right of Agent::setMarkers
Set the markers of the found code
since: 3.2.0
return: void
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)