GridFieldBulkUpload
class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandler (View source)
GridField component for uploading images in bulk.
Properties
| protected | array | $config | Component configuration. |
|
| protected | array | $ufConfig | UploadField configuration. |
|
| protected | array | $ufSetup | UploadField setup function calls. |
|
| protected | array | $ufValidatorSetup | UploadField Validator setup function calls. |
Methods
Set an UploadField Validator setup function call.
Returns one $config reference or the full $config.
Returns one $ufConfig reference or the full config.
Returns one $ufSetup reference or the full config.
Returns one $ufValidatorSetup 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, $recordClassName = null)
Component constructor.
setConfig(string $reference, mixed $value)
Set a component configuration parameter.
setUfConfig(string $reference, mixed $value)
Set an UploadField configuration parameter.
setUfSetup(string $function, mixed $param)
Set an UploadField setup function call.
setUfValidatorSetup(string $function, mixed $param)
Set an UploadField Validator setup function call.
mixed
getConfig(string $reference = false)
Returns one $config reference or the full $config.
mixed
getUfConfig(string $reference = false)
Returns one $ufConfig reference or the full config.
mixed
getUfSetup(string $reference = false)
Returns one $ufSetup reference or the full config.
mixed
getUfValidatorSetup(string $reference = false)
Returns one $ufValidatorSetup reference or the full config.
string
getRecordClassName($gridField)
Returns the class name of container DataObject record.
Either as set in the component config or fron the Gridfield `dataClass.
string
getDefaultFileRelationName($gridField)
Get the first has_one Image/File relation from the GridField managed DataObject i.e. 'MyImage' => 'Image' will return 'MyImage'.
string
getFileRelationName($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)
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)
HTML to be embedded into the GridField.
getURLHandlers($gridField)
Component URL handlers.
mixed
handleBulkUpload(GridField $gridField, SS_HTTPRequest $request)
Pass control over to the RequestHandler.