Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

JCB! Power

class Agent (Details)

namespace: VDM\Joomla\File

@startuml

class Agent  #Gold {
  # Handler $handler
  # ?Type $type
  + __construct(Handler $handler)
  + type(Type $type) : self
  + get() : Definition
  + delete(string $path) : bool
}

note right of Agent::__construct
  Constructor.

  since: 5.1.4
end note

note right of Agent::type
  Bind a file-type definition to the drop operation.
A file type **must** be assigned before calling `upload()`.

  since: 5.1.4
  return: self
end note

note right of Agent::get
  Get (upload), rename, and finalize file(s).
Workflow:
1) Validate configuration
2) Retrieve uploaded stream
3) Generate deterministic GUID name
4) Move into target directory
6) Model result and return object

  since: 5.1.4
  return: Definition
end note

note right of Agent::delete
  Delete a file from disk.
This is intentionally shallow:
- No permissions
- No ownership checks
- No logging
The caller owns safety.

  since: 5.1.4
  return: bool
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---d4b415ad_20d7_4b33_a957_88024b56e3f0---Power

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


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