README.md

JCB! Power

interface InsertInterface (Details)

namespace: VDM\Joomla\Interfaces\Data

@startuml

interface InsertInterface  #Lavender {
  + insertids(bool $reset = true) : array
  + table(?string $table) : self
  + value(mixed $value, string $field, ...) : bool
  + row(array $item) : bool
  + rows(?array $items) : bool
  + item(object $item) : bool
  + items(?array $items) : bool
  + getTable() : string
}

note right of InsertInterface::insertids
  Get the auto-increment IDs generated by the most recent INSERT batch.
This method returns the ordered list of auto-increment IDs calculated
from the last executed multi-row INSERT operation.
Behavioral notes:
- IDs are only valid immediately after an INSERT operation.
- The order of IDs matches the insertion order.
- AUTO_INCREMENT values are assumed to be sequential within a single
INSERT statement (as guaranteed by Joomla-supported databases).
- When `$reset` is enabled, the internal ID bucket is cleared after
the values are retrieved.
after retrieval.

  since: 5.1.4
  return: array
end note

note left of InsertInterface::table
  Set the current active table

  since: 3.2.2
  return: self
end note

note right of InsertInterface::value
  Insert a value to a given table
Example: $this->value(Value, 'value_key', 'GUID');

  since: 3.2.0
  return: bool
  
  arguments:
    mixed $value
    string $field
    string $keyValue
    string $key = 'guid'
end note

note left of InsertInterface::row
  Insert single row with multiple values to a given table
Example: $this->item(Array);

  since: 3.2.0
  return: bool
end note

note right of InsertInterface::rows
  Insert multiple rows to a given table
Example: $this->items(Array);

  since: 3.2.0
  return: bool
end note

note left of InsertInterface::item
  Insert single item with multiple values to a given table
Example: $this->item(Object);

  since: 3.2.0
  return: bool
end note

note right of InsertInterface::items
  Insert multiple items to a given table
Example: $this->items(Array);

  since: 3.2.0
  return: bool
end note

note left of InsertInterface::getTable
  Get the current active table

  since: 3.2.2
  return: string
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---03bbc8d5_86e8_4d2f_ae5f_0d44a4f7af13---Power

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

Used in Joomla Component Builder - Source - Mirror - Download

---