GridFieldBulkEditingTools/code/GridFieldBulkImageUpload.php
colymba bdb3ce7c5e API: Added config vars to component
Switching all component settings to a config variable with getter and
setter
2012-07-20 21:02:45 +03:00

200 lines
4.1 KiB
PHP

<?php
/**
* GridField component for uploading images in bulk
*/
class GridFieldBulkImageUpload implements GridField_HTMLProvider, GridField_URLHandler {
/**
* Target record Image foreign key field name
*
* @var string
*/
protected $recordImageFieldName;
/**
* Target record editable fields
*
* @var array
*/
protected $recordEditableFields;
/**
* component configuration
*
* @var array
*/
protected $config = array(
'imageFieldName' => null,
'editableFields' => null,
'fieldsClassBlacklist' => array( 'GridField', 'UploadField' ),
'fieldsNameBlacklist' => array()
);
/**
*
* @param string $imageField
* @param string/array $editableFields
*/
public function __construct($imageField = null, $editableFields = null)
{
$this->setRecordImageField($imageField);
if ( !is_array($editableFields) && $editableFields != null ) $editableFields = array($editableFields);
$this->setRecordEditableFields($editableFields);
}
function setConfig ( $reference, $value )
{
if ( isset( $this->config[$reference] ) )
{
if ( ($reference == 'fieldsClassBlacklist' || $reference == 'fieldsClassBlacklist') && !is_array($value) )
{
$value = array($value);
}
$this->$config[$reference] = $value;
}
}
/**
* Returns one $config parameter of the full $config
*
* @param string $reference $congif parameter to return
* @return mixed
*/
function getConfig ( $reference = false )
{
if ( $reference ) return $this->config[$reference];
else return $this->config;
}
/**
* Add a field to the editable fields blacklist
*
* @param string $fieldName
* @return boolean
*/
function addFieldNameToBlacklist ( $fieldName )
{
return array_push( $this->config['fieldsNameBlacklist'], $fieldName);
}
/**
* Add a class to the editable fields blacklist
*
* @param string $className
* @return boolean
*/
function addClassToBlacklist ( $className )
{
return array_push( $this->config['fieldsClassBlacklist'], $className);
}
/**
* Remove a field to the editable fields blacklist
*
* @param string $fieldName
* @return boolean
*/
function removeFieldNameFromBlacklist ( $fieldName )
{
if (key_exists($fieldName, $this->config['fieldsNameBlacklist'])) {
return delete( $this->config['fieldsNameBlacklist'][$fieldName] );
}else{
return false;
}
}
/**
* Remove a class to the editable fields blacklist
*
* @param string $className
* @return boolean
*/
function removeClassFromBlacklist ( $className )
{
if (key_exists($className, $this->config['fieldsNameBlacklist'])) {
return delete( $this->config['fieldsNameBlacklist'][$className] );
}else{
return false;
}
}
/**
*
* @param string $field
*/
function setRecordImageField($field)
{
$this->recordImageFieldName = $field;
}
/**
*
* @param array $fields
*/
function setRecordEditableFields($fields)
{
$this->recordEditableFields = $fields;
}
/**
*
* @return string
*/
public function getRecordImageField()
{
return $this->recordImageFieldName;
}
/**
*
* @return string
*/
public function getRecordEditableFields()
{
return $this->recordEditableFields;
}
/**
*
* @param GridField $gridField
* @return array
*/
public function getHTMLFragments($gridField) {
$data = new ArrayData(array(
'NewLink' => $gridField->Link('bulkimageupload'),
'ButtonName' => 'Bulk Upload'
));
return array(
'toolbar-header-right' => $data->renderWith('GridFieldAddNewbutton')
);
}
/**
*
* @param GridField $gridField
* @return array
*/
public function getURLHandlers($gridField) {
return array(
'bulkimageupload' => 'handleBulkUpload'
);
}
/**
* Pass control over to the RequestHandler
*
* @param GridField $gridField
* @param SS_HTTPRequest $request
* @return mixed
*/
public function handleBulkUpload($gridField, $request)
{
$controller = $gridField->getForm()->Controller();
$handler = new GridFieldBulkImageUpload_Request($gridField, $this, $controller);
return $handler->handleRequest($request, DataModel::inst());
}
}