Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

JCB! Power

final class Uri (Details)

namespace: VDM\Joomla\Openai\Utilities

@startuml

class Uri << (F,LightGreen) >> #RoyalBlue {
  - string $version
  - string $url
  + __construct(string $url = 'https://api.openai.com', string $version = 'v1')
  + get(string $path) : JoomlaUri
  + api() : string
  - setUrl(string $url) : void
  - setVersion(string $version) : void
}

note right of Uri::__construct
  Constructor
example: https://api.openai.com

  since: 3.2.0
end note

note right of Uri::get
  Method to build and return a full request URL for the request.  This method will
add appropriate pagination details if necessary and also prepend the API url
to have a complete URL for the request.

  since: 3.2.0
  return: JoomlaUri
end note

note right of Uri::api
  Get the full API URL

  since: 3.2.0
  return: string
end note

note right of Uri::setUrl
  Set the URL of the API
example: https://api.openai.com

  since: 3.2.0
  return: void
end note

note right of Uri::setVersion
  Set the version of the API

  since: 3.2.0
  return: void
end note

@enduml

The Power feature in JCB allows you to write PHP classes and their implementations, making it easy to include them in your Joomla project. JCB handles linking, autoloading, namespacing, and folder structure creation for you.

By using the SPK (Super Power Key) in your custom code (replacing the class name in your code with the SPK), JCB will automatically pull the Power from the repository into your project. This makes it available in your JCB instance, allowing you to edit and include the class in your generated Joomla component.

JCB uses placeholders like [[[NamespacePrefix]]] and [[[ComponentNamespace]]] in namespacing to prevent collisions and improve reusability across different JCB systems.

You can also set the JCB powers path globally or per component under the Dynamic Integration tab, providing flexibility and maintainability.

To add this specific Power to your project in JCB:

Simply use this SPK:

Super---13ef84f4_25b0_43dd_a9f6_0722abf220c1---Power

Remember to replace the --- with ___ to activate this Power in your code.


Joomla Volunteer Portal GitHub Octoleo Llewellyn Telegram Mastodon X (Twitter) GitHub YouTube n8n Docker Hub Open Collective GPG Key