BulkUploader
class BulkUploader implements GridField_HTMLProvider, GridField_URLHandler (View source)
GridField component for uploading images in bulk.
Properties
| protected | array | $config | Component configuration. |
|
| protected | bool | $autoPublishDataObject | If true, the component will Publish Versioned DataObject if fasle they will be left as draft. |
|
| protected | array | $ufSetup | UploadField setup function calls. |
Methods
Component constructor.
Returns one $config reference or the full $config.
Returns one $ufSetup reference or the full config.
Get the first has_one Image/File relation from the GridField managed DataObject i.e. 'MyImage' => 'Image' will return 'MyImage'.
Returns the name of the Image/File field name from the managed record Either as set in the component config or the default one.
Return the ClassName of the fileRelation i.e. 'MyImage' => 'Image' will return 'Image' i.e. 'MyImage' => 'File' will return 'File'.
Returned a configured UploadField instance embedded in the gridfield heard.
Pass control over to the RequestHandler.
Details
__construct(string $fileRelationName = null, string $recordClassName = null, $autoPublish = false)
Component constructor.
setConfig(string $reference, mixed $value)
Set a component configuration parameter.
setAutoPublishDataObject(bool $autoPublish)
Set Versioned DataObject auto publish config
bool
getAutoPublishDataObject()
Get Versioned DataObject auto publish config
setUfSetup(string $function, mixed $param)
Set an UploadField setup function call.
mixed
getConfig(string $reference = false)
Returns one $config reference or the full $config.
mixed
getUfSetup(string $reference = false)
Returns one $ufSetup reference or the full config.
string
getRecordClassName($gridField)
Returns the class name of container DataObject record.
Either as set in the component config or from the Gridfield dataClass.
string
getDefaultFileRelationName(GridField $gridField)
Get the first has_one Image/File relation from the GridField managed DataObject i.e. 'MyImage' => 'Image' will return 'MyImage'.
string
getFileRelationName(GridField $gridField)
Returns the name of the Image/File field name from the managed record Either as set in the component config or the default one.
string
getFileRelationClassName(GridField $gridField)
Return the ClassName of the fileRelation i.e. 'MyImage' => 'Image' will return 'Image' i.e. 'MyImage' => 'File' will return 'File'.
UploadField
bulkUploadField(GridField $gridField)
Returned a configured UploadField instance embedded in the gridfield heard.
array
getHTMLFragments(GridField $gridField)
HTML to be embedded into the GridField.
array
getURLHandlers(GridField $gridField)
Component URL handlers.
mixed
handleBulkUpload(GridField $gridField, HTTPRequest $request)
Pass control over to the RequestHandler.