Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

JCB! Power

class Persistent (Details)

namespace: VDM\Joomla\Componentbuilder\Import\Item

@startuml

class Persistent  #Gold {
  # Status $status
  # Message $message
  # Mapper $mapper
  # Data $data
  # Importer $importer
  # RowData $rowdata
  # Row $row
  # ParentTable $parenttable
  # JoinTables $jointables
  # Assessor $assessor
  # DataItem $item
  # Entity $entity
  + __construct(Status $status, Message $message, ...)
  + execute(object $payload) : self
  + result() : object
  - prematureError(string $guid, string $message) : void
  - import() : mixed
  - getFile(string $file) : ?object
}

note right of Persistent::__construct
  Constructor.

  since: 5.0.2
  
  arguments:
    Status $status
    Message $message
    Mapper $mapper
    Data $data
    Importer $importer
    RowData $rowdata
    Row $row
    ParentTable $parenttable
    JoinTables $jointables
    Assessor $assessor
    DataItem $item
    Entity $entity
end note

note right of Persistent::execute
  Execute the import process.
Executes the import using the given payload and returns
the current process instance for fluent interaction.

  since: 5.1.4
  return: self
end note

note right of Persistent::result
  Get the result of the last import execution.

  since: 5.1.4
  return: object
end note

note right of Persistent::prematureError
  This is trigger on premature error

  since: 5.0.2
  return: void
end note

note right of Persistent::import
  Save the item calculated values

  since: 5.0.2
  return: mixed
end note

note right of Persistent::getFile
  Get the file details

  since: 5.0.2
  return: ?object
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---2f14ec19_1b67_44be_8306_2a9e74588464---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