field name of the $has_one File/Image relation * 'recordClassName' => overrides the automatic DataObject class detection from gridfield->dataClass with a custom class name * * @var array */ protected $config = array( 'fileRelationName' => null, 'recordClassName' => null ); /** * UploadField configuration. * These options are passed on directly to the UploadField * via {@link UploadField::setConfig()} api. * * Defaults are: * 'sequentialUploads' => false : process uploads 1 after the other rather than all at once * 'canAttachExisting' => true : displays "From files" button in the UploadField * 'canPreviewFolder' => true : displays the upload location in the UploadField * * @var array */ protected $ufConfig = array( 'sequentialUploads' => false, 'canAttachExisting' => true, 'canPreviewFolder' => true, ); /** * UploadField setup function calls. * List of setup functions to call on {@link UploadField} with the value to pass. * * e.g. array('setFolderName' => 'bulkUpload') will result in: * $uploadField->setFolderName('bulkUpload') * * @var array */ protected $ufSetup = array( 'setFolderName' => 'bulkUpload', ); /** * UploadField Validator setup function calls. * List of setup functions to call on {@link Upload::validator} with the value to pass. * * e.g. array('setAllowedMaxFileSize' => 10) will result in: * $uploadField->getValidator()->setAllowedMaxFileSize(10) * * @var array */ protected $ufValidatorSetup = array( 'setAllowedMaxFileSize' => null, ); /** * Component constructor. * * @param string $fileRelationName * @param string $recordClassName */ public function __construct($fileRelationName = null, $recordClassName = null) { if ($fileRelationName != null) { $this->setConfig('fileRelationName', $fileRelationName); } if ($recordClassName != null) { $this->setConfig('recordClassName', $recordClassName); } } /* ********************************************************************** * Components settings and custom methodes * */ /** * Set a component configuration parameter. * * @param string $reference * @param mixed $value */ public function setConfig($reference, $value) { if (!array_key_exists($reference, $this->config)) { user_error("Unknown option reference: $reference", E_USER_ERROR); } $this->config[$reference] = $value; return $this; } /** * Set an UploadField configuration parameter. * * @param string $reference * @param mixed $value */ public function setUfConfig($reference, $value) { $this->ufConfig[$reference] = $value; return $this; } /** * Set an UploadField setup function call. * * @param string $function * @param mixed $param */ public function setUfSetup($function, $param) { $this->ufSetup[$function] = $param; return $this; } /** * Set an UploadField Validator setup function call. * * @param string $function * @param mixed $param */ public function setUfValidatorSetup($function, $param) { $this->ufValidatorSetup[$function] = $param; return $this; } /** * Returns one $config reference or the full $config. * * @param string $reference $congif parameter to return * * @return mixed */ public function getConfig($reference = false) { if ($reference) { return $this->config[$reference]; } else { return $this->config; } } /** * Returns one $ufConfig reference or the full config. * * @param string $reference $ufConfig parameter to return * * @return mixed */ public function getUfConfig($reference = false) { if ($reference) { return $this->ufConfig[$reference]; } else { return $this->ufConfig; } } /** * Returns one $ufSetup reference or the full config. * * @param string $reference $ufSetup parameter to return * * @return mixed */ public function getUfSetup($reference = false) { if ($reference) { return $this->ufSetup[$reference]; } else { return $this->ufSetup; } } /** * Returns one $ufValidatorSetup reference or the full config. * * @param string $reference $ufValidatorSetup parameter to return * * @return mixed */ public function getUfValidatorSetup($reference = false) { if ($reference) { return $this->ufValidatorSetup[$reference]; } else { return $this->ufValidatorSetup; } } /** * Returns the class name of container `DataObject` record. * Either as set in the component config or from the `Gridfield` `dataClass`. * * @return string */ public function getRecordClassName($gridField) { return $this->getConfig('recordClassName') ? $this->getConfig('recordClassName') : $gridField->list->dataClass; } /** * Get the first has_one Image/File relation from the GridField managed DataObject * i.e. 'MyImage' => 'Image' will return 'MyImage'. * * @param GridField $gridField * @return string Name of the $has_one relation */ public function getDefaultFileRelationName($gridField) { $recordClass = $this->getRecordClassName($gridField); $hasOneFields = Config::inst()->get($recordClass, 'has_one'); $imageField = null; foreach ($hasOneFields as $field => $type) { if ($type === 'SilverStripe\\Assets\\Image' || $type === 'SilverStripe\\Assets\\File' || is_subclass_of($type, 'SilverStripe\\Assets\\File') ) { $imageField = $field; break; } } return $imageField; } /** * Returns the name of the Image/File field name from the managed record * Either as set in the component config or the default one. * * @param GridField $gridField * @return string */ public function getFileRelationName($gridField) { $configFileRelationName = $this->getConfig('fileRelationName'); return $configFileRelationName ? $configFileRelationName : $this->getDefaultFileRelationName($gridField); } /** * Return the ClassName of the fileRelation * i.e. 'MyImage' => 'Image' will return 'Image' * i.e. 'MyImage' => 'File' will return 'File'. * * @param GridField $gridField * @return string file relation className */ public function getFileRelationClassName($gridField) { $recordClass = $this->getRecordClassName($gridField); $hasOneFields = Config::inst()->get($recordClass, 'has_one'); $fieldName = $this->getFileRelationName($gridField); if ($fieldName) { return $hasOneFields[$fieldName]; } else { return 'SilverStripe\\Assets\\File'; } } /** * Returned a configured UploadField instance * embedded in the gridfield heard. * * @param GridField $gridField Current GridField * * @return UploadField Configured UploadField instance */ public function bulkUploadField($gridField) { $fileRelationName = $this->getFileRelationName($gridField); $uploadField = BulkUploadField::create($gridField, $fileRelationName, '') ->setForm($gridField->getForm()) /*->setConfig('previewMaxWidth', 20) ->setConfig('previewMaxHeight', 20) ->setConfig('changeDetection', false)*/ ->setRecord(DataObject::create()) // avoid UploadField to get auto-config from the Page (e.g fix allowedMaxFileNumber) /*->setTemplate('BulkUploadField') ->setDownloadTemplateName('colymba-bulkuploaddownloadtemplate') ->setConfig('url', $gridField->Link('bulkupload/upload')) ->setConfig('urlSelectDialog', $gridField->Link('bulkupload/select')) ->setConfig('urlAttach', $gridField->Link('bulkupload/attach')) ->setConfig('urlFileExists', $gridField->Link('bulkupload/fileexists'))*/ ; /* //set UploadField config foreach ($this->ufConfig as $key => $val) { $uploadField->setConfig($key, $val); } */ //UploadField setup foreach ($this->ufSetup as $fn => $param) { $uploadField->{$fn}($param); } /* //UploadField Validator setup foreach ($this->ufValidatorSetup as $fn => $param) { $uploadField->getValidator()->{$fn}($param); } */ $uploadLink = $gridField->Link('bulkupload/upload'); $schema['data']['createFileEndpoint'] = [ 'url' => $uploadLink, 'method' => 'post', 'payloadFormat' => 'urlencoded', ]; $uploadField->setSchemaData($schema); return $uploadField; } /* ********************************************************************** * GridField_HTMLProvider * */ /** * HTML to be embedded into the GridField. * * @param GridField $gridField * * @return array */ public function getHTMLFragments($gridField) { // permission check if (!singleton($gridField->getModelClass())->canEdit()) { return array(); } // upload management buttons $finishButton = FormAction::create('Finish', _t('GRIDFIELD_BULK_UPLOAD.FINISH_BTN_LABEL', 'Finish')) ->addExtraClass('bulkUploadFinishButton') ->setAttribute('data-icon', 'accept') ->setUseButtonTag(true); $clearErrorButton = FormAction::create('ClearError', _t('GRIDFIELD_BULK_UPLOAD.CLEAR_ERROR_BTN_LABEL', 'Clear errors')) ->addExtraClass('bulkUploadClearErrorButton') ->setAttribute('data-icon', 'arrow-circle-double') ->setUseButtonTag(true); // get uploadField $uploadField = $this->bulkUploadField($gridField); $data = ArrayData::create(array( 'Finish' => $finishButton, 'ClearErrors' => $clearErrorButton, 'Colspan' => (count($gridField->getColumns())), 'UploadField' => $uploadField->Field() // call ->Field() to get requirements in right order )); Requirements::javascript('colymba/gridfield-bulk-editing-tools:client/dist/js/bulkTools.js'); Requirements::css('colymba/gridfield-bulk-editing-tools:client/dist/styles/bulkTools.css'); Requirements::add_i18n_javascript('colymba/gridfield-bulk-editing-tools:lang'); return array( 'header' => $data->renderWith('Colymba\\BulkUpload\\BulkUploader'), ); } /* ********************************************************************** * GridField_URLHandler * */ /** * Component URL handlers. * * @param GridField $gridField * * @return array */ public function getURLHandlers($gridField) { return array( 'bulkupload' => 'handleBulkUpload' ); } /** * Pass control over to the RequestHandler. * * @param GridField $gridField * @param HTTPRequest $request * * @return mixed */ public function handleBulkUpload($gridField, $request) { $controller = $gridField->getForm()->getController(); $handler = new \Colymba\BulkUpload\BulkUploaderRequest($gridField, $this, $controller); return $handler->handleRequest($request); } }