ca7e1532-c285-4b4e-9b67-f485cc039bc7

JCB! Power

final class TypeDefinition (Details)

namespace: VDM\Joomla\File

@startuml

class TypeDefinition << (F,LightGreen) >> #RoyalBlue {
  # string $field
  # string $type
  # ?string $filter
  # string $path
  # array $formats
  + __construct(array $config)
  + field() : string
  + type() : string
  + filter() : ?string
  + path() : string
  + formats() : array
  + toArray() : array
}

note right of TypeDefinition::__construct
  Constructor.
Required configuration keys:
- `field`
- `type`
- `path`
Optional configuration keys:
- `filter`
- `formats`
- `crop`

  since: 5.1.4
end note

note right of TypeDefinition::field
  Get the upload field name.

  since: 5.1.4
  return: string
end note

note right of TypeDefinition::type
  Get the defined file type.

  since: 5.1.4
  return: string
end note

note right of TypeDefinition::filter
  Get the upload filter mode.

  since: 5.1.4
  return: ?string
end note

note right of TypeDefinition::path
  Get the target filesystem path.

  since: 5.1.4
  return: string
end note

note right of TypeDefinition::formats
  Get the allowed file extensions.

  since: 5.1.4
  return: array
end note

note right of TypeDefinition::toArray
  Export the file type definition as an associative array.
This returns the same structure used to construct the
base TypeDefinition instance, allowing the configuration
to be serialized, stored, or cloned cleanly.

  since: 5.1.4
  return: array
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---ca7e1532_c285_4b4e_9b67_f485cc039bc7---Power

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

Used in Joomla Component Builder - Source - Mirror - Download

---