mirror of
https://github.com/colymba/GridFieldBulkEditingTools.git
synced 2024-10-22 11:05:57 +02:00
API: defined components set's HTML fragment
All bulk edit tools will now use "bulk-edit-tools" HTML fragment, defined in base component GridFieldBulkEditingTools. Previous "GridFieldBulkEditingTools" is now GridFieldBulkEditingHelper.
This commit is contained in:
colymba
parent
65d1e7c5cb
commit
a141aba650
130
code/GridFieldBulkEditingHelper.php
Normal file
130
code/GridFieldBulkEditingHelper.php
Normal file
@ -0,0 +1,130 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic helper class for the various bulk editing component
|
||||
* contains common functions
|
||||
*
|
||||
* @author colymba
|
||||
* @package GridFieldBulkEditingTools
|
||||
*/
|
||||
class GridFieldBulkEditingHelper {
|
||||
//put your code here
|
||||
|
||||
public static function getModelCMSDataFields ( $config, $modelClass )
|
||||
{
|
||||
$cmsFields = singleton($modelClass)->getCMSFields();
|
||||
$cmsDataFields = $cmsFields->dataFields();
|
||||
$cmsDataFields = GridFieldBulkEditingHelper::filterNonEditableRecordsFields($config, $cmsDataFields);
|
||||
|
||||
return $cmsDataFields;
|
||||
}
|
||||
|
||||
|
||||
public static function filterNonEditableRecordsFields ( $config, $dataFields )
|
||||
{
|
||||
if ( isset($config['editableFields']) )
|
||||
{
|
||||
if ( $config['editableFields'] != null )
|
||||
{
|
||||
foreach ($dataFields as $name => $field)
|
||||
{
|
||||
if ( !in_array($name, $config['editableFields']) )
|
||||
{
|
||||
unset( $dataFields[$name] );
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $dataFields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters out all unwanted fields from the config settings
|
||||
*
|
||||
* @param array $config
|
||||
* @param array $dataFields
|
||||
* @return array
|
||||
*/
|
||||
public static function getModelFilteredDataFields ( $config, $dataFields )
|
||||
{
|
||||
//remove the image field - for bulk image upload
|
||||
if ( isset($config['imageFieldName']) )
|
||||
{
|
||||
if ( $config['imageFieldName'] != null )
|
||||
{
|
||||
//@TODO: this wont work if the fieldname has ID in it: i.e. TheIDImageID -> remove last 2 char only
|
||||
unset( $dataFields[str_ireplace('ID', '', $config['imageFieldName']) ] );
|
||||
}
|
||||
}
|
||||
|
||||
//if class blacklist filter
|
||||
if ( count($config['fieldsClassBlacklist']) > 0 )
|
||||
{
|
||||
foreach ($dataFields as $fieldName => $field)
|
||||
{
|
||||
//@TODO find PHP function that return the classname
|
||||
if ( in_array($field->ClassName, $config['fieldsClassBlacklist']) )
|
||||
{
|
||||
array_push($config['fieldsNameBlacklist'], $fieldName);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//if name blacklist filter
|
||||
if ( count($config['fieldsNameBlacklist']) > 0 )
|
||||
{
|
||||
foreach ( $config['fieldsNameBlacklist'] as $badFieldName )
|
||||
{
|
||||
unset( $dataFields[ $badFieldName ] );
|
||||
}
|
||||
}
|
||||
|
||||
return $dataFields;
|
||||
}
|
||||
|
||||
public static function filterDatafieldsByClass ( $config, $dataFields )
|
||||
{
|
||||
//@todo
|
||||
}
|
||||
|
||||
public static function filterDataFieldsByName ( $config, $dataFields )
|
||||
{
|
||||
//@todo
|
||||
}
|
||||
|
||||
public static function dataFieldsToHTML ( $dataFields )
|
||||
{
|
||||
$fieldsHTML = array();
|
||||
|
||||
foreach ( $dataFields as $key => $field )
|
||||
{
|
||||
//@TODO: FieldHolder() does not seem to exist on UploadField
|
||||
$fieldsHTML[$key] = $field->FieldHolder();
|
||||
}
|
||||
|
||||
return $fieldsHTML;
|
||||
}
|
||||
|
||||
public static function escapeFormFieldsHTML ( $formFieldsHTML, $unique )
|
||||
{
|
||||
$prefix = 'record_'.$unique.'_';
|
||||
|
||||
foreach ( $formFieldsHTML as $name => $html )
|
||||
{
|
||||
$formFieldsHTML[$name] = str_ireplace ( array('id="', 'for="', 'name="'),
|
||||
array('id="'.$prefix, 'for="'.$prefix, 'name="'.$prefix),
|
||||
$html);
|
||||
}
|
||||
|
||||
return $formFieldsHTML;
|
||||
}
|
||||
|
||||
public static function unescapeFormFieldsPOSTData ( $requestVars )
|
||||
{
|
||||
//@todo
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
@ -1,130 +1,19 @@
|
||||
<?php
|
||||
/**
|
||||
* Generic helper class for the various bulk editing component
|
||||
* contains common functions
|
||||
*
|
||||
*
|
||||
* @author colymba
|
||||
* @package GridFieldBulkEditingTools
|
||||
*/
|
||||
class GridFieldBulkEditingTools {
|
||||
//put your code here
|
||||
|
||||
public static function getModelCMSDataFields ( $config, $modelClass )
|
||||
{
|
||||
$cmsFields = singleton($modelClass)->getCMSFields();
|
||||
$cmsDataFields = $cmsFields->dataFields();
|
||||
$cmsDataFields = GridFieldBulkEditingTools::filterNonEditableRecordsFields($config, $cmsDataFields);
|
||||
|
||||
return $cmsDataFields;
|
||||
}
|
||||
|
||||
|
||||
public static function filterNonEditableRecordsFields ( $config, $dataFields )
|
||||
{
|
||||
if ( isset($config['editableFields']) )
|
||||
{
|
||||
if ( $config['editableFields'] != null )
|
||||
{
|
||||
foreach ($dataFields as $name => $field)
|
||||
{
|
||||
if ( !in_array($name, $config['editableFields']) )
|
||||
{
|
||||
unset( $dataFields[$name] );
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $dataFields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters out all unwanted fields from the config settings
|
||||
*
|
||||
* @param array $config
|
||||
* @param array $dataFields
|
||||
* @return array
|
||||
*/
|
||||
public static function getModelFilteredDataFields ( $config, $dataFields )
|
||||
{
|
||||
//remove the image field - for bulk image upload
|
||||
if ( isset($config['imageFieldName']) )
|
||||
{
|
||||
if ( $config['imageFieldName'] != null )
|
||||
{
|
||||
//@TODO: this wont work if the fieldname has ID in it: i.e. TheIDImageID -> remove last 2 char only
|
||||
unset( $dataFields[str_ireplace('ID', '', $config['imageFieldName']) ] );
|
||||
}
|
||||
}
|
||||
|
||||
//if class blacklist filter
|
||||
if ( count($config['fieldsClassBlacklist']) > 0 )
|
||||
{
|
||||
foreach ($dataFields as $fieldName => $field)
|
||||
{
|
||||
//@TODO find PHP function that return the classname
|
||||
if ( in_array($field->ClassName, $config['fieldsClassBlacklist']) )
|
||||
{
|
||||
array_push($config['fieldsNameBlacklist'], $fieldName);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//if name blacklist filter
|
||||
if ( count($config['fieldsNameBlacklist']) > 0 )
|
||||
{
|
||||
foreach ( $config['fieldsNameBlacklist'] as $badFieldName )
|
||||
{
|
||||
unset( $dataFields[ $badFieldName ] );
|
||||
}
|
||||
}
|
||||
|
||||
return $dataFields;
|
||||
}
|
||||
|
||||
public static function filterDatafieldsByClass ( $config, $dataFields )
|
||||
{
|
||||
//@todo
|
||||
}
|
||||
|
||||
public static function filterDataFieldsByName ( $config, $dataFields )
|
||||
{
|
||||
//@todo
|
||||
}
|
||||
|
||||
public static function dataFieldsToHTML ( $dataFields )
|
||||
{
|
||||
$fieldsHTML = array();
|
||||
|
||||
foreach ( $dataFields as $key => $field )
|
||||
{
|
||||
//@TODO: FieldHolder() does not seem to exist on UploadField
|
||||
$fieldsHTML[$key] = $field->FieldHolder();
|
||||
}
|
||||
|
||||
return $fieldsHTML;
|
||||
}
|
||||
|
||||
public static function escapeFormFieldsHTML ( $formFieldsHTML, $unique )
|
||||
{
|
||||
$prefix = 'record_'.$unique.'_';
|
||||
|
||||
foreach ( $formFieldsHTML as $name => $html )
|
||||
{
|
||||
$formFieldsHTML[$name] = str_ireplace ( array('id="', 'for="', 'name="'),
|
||||
array('id="'.$prefix, 'for="'.$prefix, 'name="'.$prefix),
|
||||
$html);
|
||||
}
|
||||
|
||||
return $formFieldsHTML;
|
||||
}
|
||||
|
||||
public static function unescapeFormFieldsPOSTData ( $requestVars )
|
||||
{
|
||||
//@todo
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
class GridFieldBulkEditingTools implements GridField_HTMLProvider
|
||||
{
|
||||
public function getHTMLFragments($gridField)
|
||||
{
|
||||
Requirements::css('GridFieldBulkImageUpload/css/GridFieldBulkEditingTools.css');
|
||||
|
||||
return array(
|
||||
//"footer" => '<tr><td colspan="'.$columnsCount.'">\$DefineFragment(bulk-edit-tools)</td></tr>'
|
||||
"after" => "<div id=\"bulkEditTools\">\$DefineFragment(bulk-edit-tools)</div>"
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -1,6 +1,9 @@
|
||||
<?php
|
||||
/**
|
||||
* GridField component for uploading images in bulk
|
||||
* GridField component for uploading images in bulk
|
||||
*
|
||||
* @author colymba
|
||||
* @package GridFieldBulkEditingTools
|
||||
*/
|
||||
class GridFieldBulkImageUpload implements GridField_HTMLProvider, GridField_URLHandler {
|
||||
|
||||
@ -28,7 +31,7 @@ class GridFieldBulkImageUpload implements GridField_HTMLProvider, GridField_URLH
|
||||
* @param string/array $editableFields
|
||||
*/
|
||||
public function __construct($imageField = null, $editableFields = null)
|
||||
{
|
||||
{
|
||||
if ( $imageField != null ) $this->setConfig ( 'imageFieldName', $imageField );
|
||||
if ( $editableFields != null ) $this->setConfig ( 'editableFields', $editableFields );
|
||||
}
|
||||
@ -121,14 +124,13 @@ class GridFieldBulkImageUpload implements GridField_HTMLProvider, GridField_URLH
|
||||
* @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')
|
||||
'bulk-edit-tools' => $data->renderWith('GridFieldAddNewbutton')
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@ -6,6 +6,9 @@
|
||||
* * Form creation
|
||||
* * file upload
|
||||
* * editing and cancelling records
|
||||
*
|
||||
* @author colymba
|
||||
* @package GridFieldBulkEditingTools
|
||||
*/
|
||||
class GridFieldBulkImageUpload_Request extends RequestHandler {
|
||||
|
||||
@ -168,19 +171,19 @@ class GridFieldBulkImageUpload_Request extends RequestHandler {
|
||||
function getRecordHTMLFormFields( $recordID = 0 )
|
||||
{
|
||||
$config = $this->component->getConfig();
|
||||
$recordCMSDataFields = GridFieldBulkEditingTools::getModelCMSDataFields( $config, $this->gridField->list->dataClass );
|
||||
$recordCMSDataFields = GridFieldBulkEditingHelper::getModelCMSDataFields( $config, $this->gridField->list->dataClass );
|
||||
|
||||
//@TODO: if editableFields given use them with filterNonEditableRecordsFields()
|
||||
// otherwise go through getModelFilteredDataFields
|
||||
|
||||
|
||||
$recordCMSDataFields = GridFieldBulkEditingTools::filterNonEditableRecordsFields($config, $recordCMSDataFields);
|
||||
$recordCMSDataFields = GridFieldBulkEditingHelper::filterNonEditableRecordsFields($config, $recordCMSDataFields);
|
||||
|
||||
if ( $config['imageFieldName'] == null ) $config['imageFieldName'] = $this->getDefaultRecordImageField();
|
||||
|
||||
$recordCMSDataFields = GridFieldBulkEditingTools::getModelFilteredDataFields($config, $recordCMSDataFields);
|
||||
$formFieldsHTML = GridFieldBulkEditingTools::dataFieldsToHTML($recordCMSDataFields);
|
||||
$formFieldsHTML = GridFieldBulkEditingTools::escapeFormFieldsHTML($formFieldsHTML, $recordID);
|
||||
$recordCMSDataFields = GridFieldBulkEditingHelper::getModelFilteredDataFields($config, $recordCMSDataFields);
|
||||
$formFieldsHTML = GridFieldBulkEditingHelper::dataFieldsToHTML($recordCMSDataFields);
|
||||
$formFieldsHTML = GridFieldBulkEditingHelper::escapeFormFieldsHTML($formFieldsHTML, $recordID);
|
||||
|
||||
return $formFieldsHTML;
|
||||
}
|
||||
|
||||
5
css/GridFieldBulkEditingTools.css
Normal file
5
css/GridFieldBulkEditingTools.css
Normal file
@ -0,0 +1,5 @@
|
||||
div#bulkEditTools
|
||||
{
|
||||
margin: 0;
|
||||
text-align: right;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user