Powerful Search for use in JCB extensions

Go to file

Robot a8bce7c630 update 2023-05-01 14:00:54		2023-05-01 14:00:58 +02:00
src	update 2023-05-01 14:00:54	2023-05-01 14:00:58 +02:00
README.md	update 2023-05-01 14:00:54	2023-05-01 14:00:58 +02:00
super-powers.json	update 2023-05-01 14:00:54	2023-05-01 14:00:58 +02:00

README.md

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

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]. 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.

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.

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\Search
- abstract class Factory | Details | Code | Settings | 01a89ba8-f8bb-435c-93de-0a8f3fa9432a
- class Agent | Details | Code | Settings | 0b658434-3767-401e-addc-eabfd1d0e94a
- class Config | Details | Code | Settings | 6e2ca779-f70e-4871-a138-0ee5eaec6a97
Namespace: VDM\Joomla\Componentbuilder\Search\Abstraction
- abstract class Engine | Details | Code | Settings | 8f9449fc-bfbc-49a5-b146-d58c8c17dfdf
Namespace: VDM\Joomla\Componentbuilder\Search\Agent
- class Find | Details | Code | Settings | 15d9e1a9-3364-4d69-9d9f-9b87db820e5c
- class Replace | Details | Code | Settings | abc37ddd-1ff5-4204-9e5b-015ab4f3d4c7
- class Search | Details | Code | Settings | e544a248-4b6a-46cb-9926-a3ac9937807c
- class Update | Details | Code | Settings | 3ac29912-0681-4ca9-8197-d5a8f6a49ac7
Namespace: VDM\Joomla\Componentbuilder\Search\Database
- class Insert | Details | Code | Settings | 6caf9473-133c-49a9-afa0-9f84151b5155
- class Load | Details | Code | Settings | 2dabfb4a-64cd-4c04-9772-4a75f9f3b710
Namespace: VDM\Joomla\Componentbuilder\Search\Engine
- class Basic | Details | Code | Settings | db093eca-63b3-4d6c-9232-3ceb058121c0
- class Regex | Details | Code | Settings | 83efa9a0-4aec-41f8-9c05-b1ac9617746e
Namespace: VDM\Joomla\Componentbuilder\Search\Interfaces
- interface FindInterface | Details | Code | Settings | 55280ec7-e48d-431b-af25-10308dd30636
- interface InsertInterface | Details | Code | Settings | 4c44e5d3-750c-4609-88c8-aa441838b8fe
- interface LoadInterface | Details | Code | Settings | 2bd1a32c-3d90-4646-9314-28d44d164f76
- interface ReplaceInterface | Details | Code | Settings | afdae35d-fe7f-4055-99ea-afd8ff8349b6
- interface SearchInterface | Details | Code | Settings | 0d9442ab-54d9-4947-a219-244cfaea3084
- interface SearchTypeInterface | Details | Code | Settings | 117d8c9e-3f8d-40ae-b375-1efa2fe5538a
Namespace: VDM\Joomla\Componentbuilder\Search\Model
- class Insert | Details | Code | Settings | 02efe40a-7792-4c82-9444-7d0377243483
- class Load | Details | Code | Settings | f523ab49-907a-4356-b064-51c85a187fbd
Namespace: VDM\Joomla\Componentbuilder\Search\Service
- class Agent | Details | Code | Settings | cc6972a7-1574-4ae0-92a8-7f1012aac6f7
- class Database | Details | Code | Settings | d5de47ce-9a9e-4e76-a5c6-61ed74842ea3
- class Model | Details | Code | Settings | 7f40cc7d-9ab8-4601-8a2b-4eb3d712a40a
- class Search | Details | Code | Settings | da714ea5-96bb-4eb1-959b-39b457be9cd1

Class Diagrams

VDM Joomla Componentbuilder Search

namespace VDM\Joomla\Componentbuilder\Search

@startuml

namespace VDM\Joomla\Componentbuilder\Search #Olive {


  abstract Factory  #Orange {
    # static $container
    + {static} _() : Mixed
    + {static} getContainer() : Container
    # {static} createContainer() : Container
  }

  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()
    + getValue() : ?string
    + setValue() : bool
    + table() : ?array
    + find() : ?array
    + replace() : int
    # getRow() : array
    # getRowCode() : string
    # getRowEditButton() : string
    # setReturnValue() : void
    # setMarkers() : void
  }

  class Config  #Gold {
    # getTypesearch() : ?int
    # getSearchvalue() : ?string
    # getReplacevalue() : string
    # getMatchcase() : int
    # getWholeword() : int
    # getRegexsearch() : int
    # getComponentid() : int
    # getTablename() : ?string
    # getFieldname() : ?string
    # getItemid() : int
    # getFieldcounter() : int
    # getLinecounter() : int
    # getMarkerstart() : string
    # getMarkerend() : string
  }
}


@enduml

VDM Joomla Componentbuilder Search Abstraction

namespace VDM\Joomla\Componentbuilder\Search\Abstraction

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Abstraction #LightGreen {


  abstract Engine  #Orange {
    # Config $config
    # ?string $searchValue
    # string $replaceValue
    # int $matchCase
    # int $wholeWord
    # string $start
    # string $end
    + __construct()
    # lineCounter()
  }
}


@enduml

VDM Joomla Componentbuilder Search Agent

namespace VDM\Joomla\Componentbuilder\Search\Agent

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Agent #LightGreen {


  class Find  #Gold {
    # array $found
    # Config $config
    # Search $search
    + __construct()
    + get() : ?array
    + item() : void
    + items() : void
    + reset() : void
  }

  class Replace  #Gold {
    # array $updated
    # Config $config
    # Update $update
    + __construct()
    + get() : ?array
    + item() : void
    + items() : void
    + reset() : void
  }

  class Search  #Gold {
    # array $found
    # Config $config
    # SearchEngine $search
    + __construct()
    + get() : ?array
    + value() : bool
    + reset() : void
    # searchValue() : ?array
    # string() : ?array
    # prep() : void
    # fieldCounter()
  }

  class Update  #Gold {
    # SearchEngine $search
    + __construct()
    + value() : mixed
    # updateValue() : mixed
    # validateUpdateKey() : bool
    # string() : string
  }
}


@enduml

VDM Joomla Componentbuilder Search Database

namespace VDM\Joomla\Componentbuilder\Search\Database

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Database #LightGreen {


  class Insert  #Gold {
    # Config $config
    # Table $table
    # Model $model
    # \JDatabaseDriver $db
    + __construct()
    + value() : bool
    + item() : bool
    + items() : bool
  }

  class Load  #Gold {
    # int $bundle
    # Config $config
    # Table $table
    # Model $model
    # Database $load
    + __construct()
    + value() : mixed
    + item() : ?object
    + items() : ?array
    # next() : int
    # incremental() : int
    # setDatabaseFields() : ?array
  }
}


@enduml

VDM Joomla Componentbuilder Search Engine

namespace VDM\Joomla\Componentbuilder\Search\Engine

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Engine #LightGreen {


  class Basic  #Gold {
    # string $regexValue
    + __construct()
    + string() : ?string
    + replace() : string
    # replaceWhole() : string
    # searchWhole() : ?string
    + match() : bool
    # searchAll() : ?string
    # replaceAll() : string
  }

  class Regex  #Gold {
    # string $regexValue
    + __construct()
    + string() : ?string
    + replace() : string
    + match() : bool
  }
}


@enduml

VDM Joomla Componentbuilder Search Interfaces

namespace VDM\Joomla\Componentbuilder\Search\Interfaces

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Interfaces #LightGreen {


  interface FindInterface  #Lavender {
    + get() : ?array
    + item() : void
    + items() : void
    + reset() : void
  }

  interface InsertInterface  #Lavender {
    + value() : bool
    + item() : bool
    + items() : bool
  }

  interface LoadInterface  #Lavender {
    + value() : mixed
    + item() : ?object
    + items() : ?array
  }

  interface ReplaceInterface  #Lavender {
    + get() : ?array
    + item() : void
    + items() : void
    + reset() : void
  }

  interface SearchInterface  #Lavender {
    + get() : ?array
    + value() : bool
    + reset() : void
  }

  interface SearchTypeInterface  #Lavender {
    + string() : ?string
    + replace() : string
  }
}


@enduml

VDM Joomla Componentbuilder Search Model

namespace VDM\Joomla\Componentbuilder\Search\Model

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Model #LightGreen {


  class Insert  #Gold {
    # Config $config
    + __construct()
    + value() : mixed
    # validateBefore() : bool
    # validateAfter() : bool
    # getTable() : string
  }

  class Load  #Gold {
    # Config $config
    + __construct()
    + value() : mixed
    # validateBefore() : bool
    # validateAfter() : bool
    # getTable() : string
  }
}


@enduml

VDM Joomla Componentbuilder Search Service

namespace VDM\Joomla\Componentbuilder\Search\Service

@startuml

namespace VDM\Joomla\Componentbuilder\Search\Service #LightGreen {


  class Agent  #Gold {
    + register() : void
    + getAgent() : SearchAgent
    + getFind() : Find
    + getReplace() : Replace
    + getSearch() : Search
    + getUpdate() : Update
  }

  class Database  #Gold {
    + register() : void
    + getLoad() : Load
    + getDatabaseLoad() : LoadDatabase
    + getDatabaseInsert() : InsertDatabase
  }

  class Model  #Gold {
    + register() : void
    + getModelLoad() : Load
    + getModelInsert() : Insert
  }

  class Search  #Gold {
    # $searchEngine
    + register() : void
    + getConfig() : Config
    + getTable() : Table
    + getRegex() : Regex
    + getBasic() : Basic
    + getSearch() : SearchEngine
  }
}


@enduml

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

Build with Joomla Component Builder