tonyair/GridFieldBulkEditingTools
1
0
Fork 0
mirror of https://github.com/colymba/GridFieldBulkEditingTools.git synced 2024-10-22 11:05:57 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #114 from spekulatius/moving-to-PSR-2

Browse Source 
Converting to PSR-2
This commit is contained in:
Thierry François 2015-12-21 09:36:00 +01:00
commit ef0f9fbcb8
10 changed files with 1580 additions and 1654 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
_config.php
View File

@ -1,9 +1,8 @@
<?php
//define global path to Components' root folder
if(!defined('BULKEDITTOOLS_PATH'))
{
if (!defined('BULKEDITTOOLS_PATH')) {
$folder = rtrim(basename(dirname(__FILE__)));
define('BULKEDITTOOLS_PATH', $folder);
define('BULKEDITTOOLS_UPLOAD_PATH', $folder . '/bulkUpload');
define('BULKEDITTOOLS_MANAGER_PATH', $folder . '/bulkManager');
define('BULKEDITTOOLS_UPLOAD_PATH', $folder.'/bulkUpload');
define('BULKEDITTOOLS_MANAGER_PATH', $folder.'/bulkManager');
}

21
bulkManager/code/GridFieldBulkActionDeleteHandler.php
View File

@ -3,48 +3,47 @@
* Bulk action handler for deleting records.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkManager
*/
class GridFieldBulkActionDeleteHandler extends GridFieldBulkActionHandler
{
/**
* RequestHandler allowed actions
* RequestHandler allowed actions.
*
* @var array
*/
private static $allowed_actions = array('delete');
/**
* RequestHandler url => action map
* RequestHandler url => action map.
*
* @var array
*/
private static $url_handlers = array(
'delete' => 'delete'
'delete' => 'delete',
);
/**
* Delete the selected records passed from the delete bulk action
* Delete the selected records passed from the delete bulk action.
*
* @param SS_HTTPRequest $request
*
* @return SS_HTTPResponse List of deleted records ID
*/
public function delete(SS_HTTPRequest $request)
{
$ids = array();
foreach ( $this->getRecords() as $record )
{
foreach ($this->getRecords() as $record) {
array_push($ids, $record->ID);
$record->delete();
}
$response = new SS_HTTPResponse(Convert::raw2json(array(
'done' => true,
'records' => $ids
'records' => $ids,
)));
$response->addHeader('Content-Type', 'text/json');
return $response;
}
}

142
bulkManager/code/GridFieldBulkActionEditHandler.php
View File

@ -3,36 +3,36 @@
* Bulk action handler for editing records.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkManager
*/
class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
{
/**
* RequestHandler allowed actions
* RequestHandler allowed actions.
*
* @var array
*/
private static $allowed_actions = array(
'index',
'bulkEditForm',
'recordEditForm'
'recordEditForm',
);
/**
* RequestHandler url => action map
* RequestHandler url => action map.
*
* @var array
*/
private static $url_handlers = array(
'bulkEdit/bulkEditForm' => 'bulkEditForm',
'bulkEdit/recordEditForm' => 'recordEditForm',
'bulkEdit' => 'index'
'bulkEdit' => 'index',
);
/**
* Return URL to this RequestHandler
* Return URL to this RequestHandler.
*
* @param string $action Action to append to URL
*
* @return string URL
*/
public function Link($action = null)
@ -40,7 +40,6 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
return Controller::join_links(parent::Link(), 'bulkEdit', $action);
}
/**
* Return a form for all the selected DataObjects
* with their respective editable fields.
@ -50,9 +49,8 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
public function bulkEditForm()
{
$crumbs = $this->Breadcrumbs();
if($crumbs && $crumbs->count()>=2)
{
$one_level_up = $crumbs->offsetGet($crumbs->count()-2);
if ($crumbs && $crumbs->count() >= 2) {
$one_level_up = $crumbs->offsetGet($crumbs->count() - 2);
}
$actions = new FieldList();
@ -89,22 +87,20 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
'Editing {count} {class}',
array(
'count' => $editingCount,
'class' => $titleModelClass
'class' => $titleModelClass,
)
);
$header = LiteralField::create(
'bulkEditHeader',
'<h1 id="bulkEditHeader">' . $headerText . '</h1>'
'<h1 id="bulkEditHeader">'.$headerText.'</h1>'
);
$recordsFieldList->push($header);
$toggle = LiteralField::create('bulkEditToggle', '<span id="bulkEditToggle">' . _t('GRIDFIELD_BULKMANAGER_EDIT_HANDLER.TOGGLE_ALL_LINK', 'Show/Hide all') . '</span>');
$toggle = LiteralField::create('bulkEditToggle', '<span id="bulkEditToggle">'._t('GRIDFIELD_BULKMANAGER_EDIT_HANDLER.TOGGLE_ALL_LINK', 'Show/Hide all').'</span>');
$recordsFieldList->push($toggle);
//fetch fields for each record and push to fieldList
foreach ( $recordList as $id )
{
foreach ($recordList as $id) {
$record = DataObject::get_by_id($modelClass, $id);
$recordEditingFields = $this->getRecordEditingFields($record);
@ -127,7 +123,7 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
$actions
);
if($crumbs && $crumbs->count()>=2){
if ($crumbs && $crumbs->count() >= 2) {
$bulkEditForm->Backlink = $one_level_up->Link;
}
@ -141,10 +137,9 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
return $bulkEditForm;
}
/**
* Return's a form with only one record's fields
* Used for bulkEditForm subForm requests via ajax
* Used for bulkEditForm subForm requests via ajax.
*
* @return Form Currently being edited form
*/
@ -155,24 +150,20 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
$recordInfo = $request->shift();
//shift request till we find the requested field
while ($recordInfo)
{
if ( $unescapedRecordInfo = $this->unEscapeFieldName($recordInfo) )
{
while ($recordInfo) {
if ($unescapedRecordInfo = $this->unEscapeFieldName($recordInfo)) {
$id = $unescapedRecordInfo['id'];
$fieldName = $unescapedRecordInfo['name'];
$action = $request->shift();
break;
}
else{
} else {
$recordInfo = $request->shift();
}
}
//generate a form with only that requested record's fields
if ( $id )
{
if ($id) {
$modelClass = $this->gridField->getModelClass();
$record = DataObject::get_by_id($modelClass, $id);
@ -188,20 +179,20 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
}
}
/**
* Returns a record's populated form fields
* with all filtering done ready to be included in the main form
* with all filtering done ready to be included in the main form.
*
* @uses DataObject::getCMSFields()
*
* @param DataObject $record The record to get the fields from
*
* @return array The record's editable fields
*/
private function getRecordEditingFields(DataObject $record)
{
$tempForm = Form::create(
$this, "TempEditForm",
$this, 'TempEditForm',
$record->getCMSFields(),
FieldList::create()
);
@ -214,7 +205,6 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
return $fields;
}
/**
* Filters a records editable fields
* based on component's config
@ -223,7 +213,8 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
* See {@link GridFieldBulkManager} component for filtering config.
*
* @param FieldList $fields Record's CMS Fields
* @param integer $id Record's ID, used fir unique name
* @param int $id Record's ID, used fir unique name
*
* @return array Filtered record's fields
*/
private function filterRecordEditingFields(FieldList $fields, $id)
@ -232,22 +223,18 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
$editableFields = $config['editableFields'];
// get all dataFields or just the ones allowed in config
if ( $editableFields )
{
if ($editableFields) {
$dataFields = array();
foreach ($editableFields as $fieldName)
{
foreach ($editableFields as $fieldName) {
$dataFields[$fieldName] = $fields->dataFieldByName($fieldName);
}
}
else{
} else {
$dataFields = $fields->dataFields();
}
// escape field names with unique prefix
foreach ( $dataFields as $name => $field )
{
foreach ($dataFields as $name => $field) {
$field->Name = $this->escapeFieldName($id, $name);
$dataFields[$name] = $field;
}
@ -255,24 +242,24 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
return $dataFields;
}
/**
* Escape a fieldName with a unique prefix
* Escape a fieldName with a unique prefix.
*
* @param integer $recordID Record id from who the field belongs
* @param int $recordID Record id from who the field belongs
* @param string $name Field name
*
* @return string Escaped field name
*/
protected function escapeFieldName($recordID, $name)
{
return 'record_' . $recordID . '_' . $name;
return 'record_'.$recordID.'_'.$name;
}
/**
* Un-escape a previously escaped field name
* Un-escape a previously escaped field name.
*
* @param string $fieldName Escaped field name
*
* @return array|false Fasle if the fieldName was not escaped. Or Array map with record 'id' and field 'name'
*/
protected function unEscapeFieldName($fieldName)
@ -280,11 +267,9 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
$parts = array();
$match = preg_match('/record_(\d+)_(\w+)/i', $fieldName, $parts);
if ( !$match )
{
if (!$match) {
return false;
}
else{
} else {
return array(
'id' => $parts[1],
'name' => $parts[2],
@ -292,9 +277,8 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
}
}
/**
* Creates and return the bulk editing interface
* Creates and return the bulk editing interface.
*
* @return string Form's HTML
*/
@ -305,30 +289,29 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
$form->addExtraClass('center cms-content');
$form->setAttribute('data-pjax-fragment', 'CurrentForm Content');
Requirements::javascript(BULKEDITTOOLS_MANAGER_PATH . '/javascript/GridFieldBulkEditingForm.js');
Requirements::css(BULKEDITTOOLS_MANAGER_PATH . '/css/GridFieldBulkEditingForm.css');
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH . '/lang/js');
Requirements::javascript(BULKEDITTOOLS_MANAGER_PATH.'/javascript/GridFieldBulkEditingForm.js');
Requirements::css(BULKEDITTOOLS_MANAGER_PATH.'/css/GridFieldBulkEditingForm.css');
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH.'/lang/js');
if($this->request->isAjax())
{
if ($this->request->isAjax()) {
$response = new SS_HTTPResponse(
Convert::raw2json(array( 'Content' => $form->forAjaxTemplate()->getValue() ))
Convert::raw2json(array('Content' => $form->forAjaxTemplate()->getValue()))
);
$response->addHeader('X-Pjax', 'Content');
$response->addHeader('Content-Type', 'text/json');
$response->addHeader('X-Title', 'SilverStripe - Bulk '.$this->gridField->list->dataClass.' Editing');
return $response;
}
else {
$controller = $this->getToplevelController();
return $controller->customise(array( 'Content' => $form ));
}
}
return $response;
} else {
$controller = $this->getToplevelController();
return $controller->customise(array('Content' => $form));
}
}
/**
* Handles bulkEditForm submission
* and parses and saves each records data
* and parses and saves each records data.
*
* @param array $data Sumitted form data
* @param Form $form Form
@ -343,12 +326,9 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
$done = 0;
//unescape and sort form data per record ID
foreach ($data as $fieldName => $value)
{
if ( $fieldInfo = $this->unEscapeFieldName($fieldName) )
{
if ( !isset($formsData[$fieldInfo['id']]) )
{
foreach ($data as $fieldName => $value) {
if ($fieldInfo = $this->unEscapeFieldName($fieldName)) {
if (!isset($formsData[$fieldInfo['id']])) {
$formsData[$fieldInfo['id']] = array();
}
@ -357,11 +337,10 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
}
//process each record's form data and save
foreach ($formsData as $recordID => $recordData)
{
foreach ($formsData as $recordID => $recordData) {
$record = DataObject::get_by_id($className, $recordID);
$recordForm = Form::create(
$this, "RecordForm",
$this, 'RecordForm',
$record->getCMSFields(),
FieldList::create()
);
@ -372,9 +351,8 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
array_push($ids, $record->ID);
if ( $id )
{
$done++;
if ($id) {
++$done;
}
}
@ -384,7 +362,7 @@ class GridFieldBulkActionEditHandler extends GridFieldBulkActionHandler
'{count} {class} saved successfully.',
array(
'count' => $done,
'class' => $messageModelClass
'class' => $messageModelClass,
)
);
$form->sessionMessage($message, 'good');

58
bulkManager/code/GridFieldBulkActionHandler.php
View File

@ -2,37 +2,34 @@
/**
* Base class to extend for all custom bulk action handlers
* Gives access to the GridField, Component and Controller
* and implements useful functions like {@link getRecordIDList()} and {@link getRecords()}
* and implements useful functions like {@link getRecordIDList()} and {@link getRecords()}.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkManager
*/
class GridFieldBulkActionHandler extends RequestHandler
{
/**
* Related GridField instance
* Related GridField instance.
*
* @var GridField
*/
protected $gridField;
/**
* GridFieldBulkManager instance
* GridFieldBulkManager instance.
*
* @var GridFieldBulkManager
*/
protected $component;
/**
* Current controller instance
* Current controller instance.
*
* @var Controller
*/
protected $controller;
/**
*
* @param GridFIeld $gridField
* @param GridField_URLHandler $component
* @param Controller $controller
@ -45,13 +42,15 @@ class GridFieldBulkActionHandler extends RequestHandler
parent::__construct();
}
/**
* Returns the URL for this RequestHandler
* Returns the URL for this RequestHandler.
*
* @author SilverStripe
*
* @see GridFieldDetailForm_ItemRequest
*
* @param string $action
*
* @return string
*/
public function Link($action = null)
@ -59,7 +58,6 @@ class GridFieldBulkActionHandler extends RequestHandler
return Controller::join_links($this->gridField->Link(), 'bulkAction', $action);
}
/**
* Traverse up nested requests until we reach the first that's not a GridFieldDetailForm or GridFieldDetailForm_ItemRequest.
* The opposite of {@link Controller::curr()}, required because
@ -70,53 +68,58 @@ class GridFieldBulkActionHandler extends RequestHandler
protected function getToplevelController()
{
$c = $this->controller;
while($c && ($c instanceof GridFieldDetailForm_ItemRequest || $c instanceof GridFieldDetailForm)) {
while ($c && ($c instanceof GridFieldDetailForm_ItemRequest || $c instanceof GridFieldDetailForm)) {
$c = $c->getController();
}
return $c;
}
/**
* Edited version of the GridFieldEditForm function
* adds the 'Bulk Upload' at the end of the crums
* adds the 'Bulk Upload' at the end of the crums.
*
* CMS-specific functionality: Passes through navigation breadcrumbs
* to the template, and includes the currently edited record (if any).
* see {@link LeftAndMain->Breadcrumbs()} for details.
*
* @author SilverStripe original Breadcrumbs() method
*
* @see GridFieldDetailForm_ItemRequest
* @param boolean $unlinked
*
* @param bool $unlinked
*
* @return ArrayData
*/
public function Breadcrumbs($unlinked = false)
{
if(!$this->controller->hasMethod('Breadcrumbs')) return;
if (!$this->controller->hasMethod('Breadcrumbs')) {
return;
}
$items = $this->controller->Breadcrumbs($unlinked);
$items->push(new ArrayData(array(
'Title' => 'Bulk Editing',
'Link' => false
'Link' => false,
)));
return $items;
}
/**
* Returns the list of record IDs selected in the front-end
* Returns the list of record IDs selected in the front-end.
*
* @return array List of IDs
*/
public function getRecordIDList()
{
$vars = $this->request->requestVars();
return $vars['records'];
}
/**
* Returns a DataList of the records selected in the front-end
* Returns a DataList of the records selected in the front-end.
*
* @return DataList List of records
*/
@ -124,12 +127,11 @@ class GridFieldBulkActionHandler extends RequestHandler
{
$ids = $this->getRecordIDList();
if ( $ids )
{
if ($ids) {
$class = $this->gridField->list->dataClass;
return DataList::create($class)->byIDs( $ids );
}
else{
return DataList::create($class)->byIDs($ids);
} else {
return false;
}
}

20
bulkManager/code/GridFieldBulkActionUnlinkHandler.php
View File

@ -3,31 +3,30 @@
* Bulk action handler for unlinking records.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkManager
*/
class GridFieldBulkActionUnLinkHandler extends GridFieldBulkActionHandler
class GridFieldBulkActionUnlinkHandler extends GridFieldBulkActionHandler
{
/**
* RequestHandler allowed actions
* RequestHandler allowed actions.
*
* @var array
*/
private static $allowed_actions = array('unLink');
/**
* RequestHandler url => action map
* RequestHandler url => action map.
*
* @var array
*/
private static $url_handlers = array(
'unLink' => 'unLink'
'unLink' => 'unLink',
);
/**
* Unlink the selected records passed from the unlink bulk action
* Unlink the selected records passed from the unlink bulk action.
*
* @param SS_HTTPRequest $request
*
* @return SS_HTTPResponse List of affected records ID
*/
public function unLink(SS_HTTPRequest $request)
@ -37,9 +36,10 @@ class GridFieldBulkActionUnLinkHandler extends GridFieldBulkActionHandler
$response = new SS_HTTPResponse(Convert::raw2json(array(
'done' => true,
'records' => $ids
'records' => $ids,
)));
$response->addHeader('Content-Type', 'text/json');
return $response;
}
}

196
bulkManager/code/GridFieldBulkManager.php
View File

@ -1,15 +1,13 @@
<?php
/**
* GridField component for editing attached models in bulk
* GridField component for editing attached models in bulk.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkManager
*/
class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnProvider, GridField_URLHandler
{
/**
* component configuration
* component configuration.
*
* 'editableFields' => fields editable on the Model
* 'actions' => maps of action name and configuration
@ -18,22 +16,22 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
*/
protected $config = array(
'editableFields' => null,
'actions' => array()
'actions' => array(),
);
/**
* GridFieldBulkManager component constructor
* GridFieldBulkManager component constructor.
*
* @param array $editableFields List of editable fields
* @param boolean $defaultActions Use default actions list. False to start fresh.
* @param bool $defaultActions Use default actions list. False to start fresh.
*/
public function __construct($editableFields = null, $defaultActions = true)
{
if ( $editableFields != null ) $this->setConfig ( 'editableFields', $editableFields );
if ($editableFields != null) {
$this->setConfig('editableFields', $editableFields);
}
if ( $defaultActions )
{
if ($defaultActions) {
$this->config['actions'] = array(
'bulkEdit' => array(
'label' => _t('GRIDFIELD_BULK_MANAGER.EDIT_SELECT_LABEL', 'Edit'),
@ -41,8 +39,8 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
'config' => array(
'isAjax' => false,
'icon' => 'pencil',
'isDestructive' => false
)
'isDestructive' => false,
),
),
'unLink' => array(
'label' => _t('GRIDFIELD_BULK_MANAGER.UNLINK_SELECT_LABEL', 'UnLink'),
@ -50,8 +48,8 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
'config' => array(
'isAjax' => true,
'icon' => 'chain--minus',
'isDestructive' => false
)
'isDestructive' => false,
),
),
'delete' => array(
'label' => _t('GRIDFIELD_BULK_MANAGER.DELETE_SELECT_LABEL', 'Delete'),
@ -59,39 +57,34 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
'config' => array(
'isAjax' => true,
'icon' => 'decline',
'isDestructive' => true
)
)
'isDestructive' => true,
),
),
);
}
}
/* **********************************************************************
* Components settings and custom methodes
* */
/**
* Sets the component configuration parameter
* Sets the component configuration parameter.
*
* @param string $reference
* @param mixed $value
*/
function setConfig($reference, $value)
{
if (!array_key_exists($reference, $this->config) )
public function setConfig($reference, $value)
{
if (!array_key_exists($reference, $this->config)) {
user_error("Unknown option reference: $reference", E_USER_ERROR);
}
if ( $reference == 'actions' )
{
user_error("Bulk actions must be edited via addBulkAction() and removeBulkAction()", E_USER_ERROR);
if ($reference == 'actions') {
user_error('Bulk actions must be edited via addBulkAction() and removeBulkAction()', E_USER_ERROR);
}
if ( ($reference == 'editableFields') && !is_array($value) )
{
if (($reference == 'editableFields') && !is_array($value)) {
$value = array($value);
}
@ -100,22 +93,24 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
return $this;
}
/**
* Returns one $config parameter of the full $config
* Returns one $config parameter of the full $config.
*
* @param string $reference $congif parameter to return
*
* @return mixed
*/
function getConfig ( $reference = false )
public function getConfig($reference = false)
{
if ( $reference ) return $this->config[$reference];
else return $this->config;
if ($reference) {
return $this->config[$reference];
} else {
return $this->config;
}
}
/**
* Lets you add custom bulk actions to the bulk manager interface
* Lets you add custom bulk actions to the bulk manager interface.
*
* @todo add config options for front-end: isAjax, icon
*
@ -123,172 +118,163 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
* @param string $label Dropdown menu action's label. Default to ucfirst($name).
* @param string $handler RequestHandler class name for this action. Default to 'GridFieldBulkAction'.ucfirst($name).'Handler'
* @param array $config Front-end configuration array( 'isAjax' => true, 'icon' => 'accept', 'isDestructive' => false )
*
* @return GridFieldBulkManager Current GridFieldBulkManager instance
*/
function addBulkAction($name, $label = null, $handler = null, $config = null)
{
if ( array_key_exists($name, $this->config['actions']) )
public function addBulkAction($name, $label = null, $handler = null, $config = null)
{
if (array_key_exists($name, $this->config['actions'])) {
user_error("Bulk action '$name' already exists.", E_USER_ERROR);
}
if ( !$label )
{
if (!$label) {
$label = ucfirst($name);
}
if ( !$handler )
{
if (!$handler) {
$handler = 'GridFieldBulkAction'.ucfirst($name).'Handler';
}
if ( !ClassInfo::exists( $handler ) )
{
if (!ClassInfo::exists($handler)) {
user_error("Bulk action handler for $name not found: $handler", E_USER_ERROR);
}
if ( $config && !is_array($config) )
{
user_error("Bulk action front-end config should be an array of key => value pairs.", E_USER_ERROR);
}
else{
if ($config && !is_array($config)) {
user_error('Bulk action front-end config should be an array of key => value pairs.', E_USER_ERROR);
} else {
$config = array(
'isAjax' => isset($config['isAjax']) ? $config['isAjax'] : true,
'icon' => isset($config['icon']) ? $config['icon'] : 'accept',
'isDestructive' => isset($config['isDestructive']) ? $config['isDestructive'] : false
'isDestructive' => isset($config['isDestructive']) ? $config['isDestructive'] : false,
);
}
$this->config['actions'][$name] = array(
'label' => $label,
'handler' => $handler,
'config' => $config
'config' => $config,
);
return $this;
}
/**
* Removes a bulk actions from the bulk manager interface
* Removes a bulk actions from the bulk manager interface.
*
* @param string $name Bulk action's name
*
* @return GridFieldBulkManager Current GridFieldBulkManager instance
*/
function removeBulkAction($name)
{
if ( !array_key_exists($name, $this->config['actions']) )
public function removeBulkAction($name)
{
if (!array_key_exists($name, $this->config['actions'])) {
user_error("Bulk action '$name' doesn't exists.", E_USER_ERROR);
}
unset( $this->config['actions'][$name] );
unset($this->config['actions'][$name]);
return $this;
}
/* **********************************************************************
* GridField_ColumnProvider
* */
/**
* Add bulk select column
* Add bulk select column.
*
* @param GridField $gridField Current GridField instance
* @param array $columns Columns list
*/
function augmentColumns($gridField, &$columns)
public function augmentColumns($gridField, &$columns)
{
if(!in_array('BulkSelect', $columns)) $columns[] = 'BulkSelect';
if (!in_array('BulkSelect', $columns)) {
$columns[] = 'BulkSelect';
}
}
/**
* Which columns are handled by the component
* Which columns are handled by the component.
*
* @param GridField $gridField Current GridField instance
*
* @return array List of handled column names
*/
function getColumnsHandled($gridField)
public function getColumnsHandled($gridField)
{
return array('BulkSelect');
}
/**
* Sets the column's content
* Sets the column's content.
*
* @param GridField $gridField Current GridField instance
* @param DataObject $record Record intance for this row
* @param string $columnName Column's name for which we need content
*
* @return mixed Column's field content
*/
function getColumnContent($gridField, $record, $columnName)
public function getColumnContent($gridField, $record, $columnName)
{
$cb = CheckboxField::create('bulkSelect_'.$record->ID)
->addExtraClass('bulkSelect no-change-track')
->setAttribute('data-record', $record->ID);
return $cb->Field();
}
/**
* Set the column's HTML attributes
* Set the column's HTML attributes.
*
* @param GridField $gridField Current GridField instance
* @param DataObject $record Record intance for this row
* @param string $columnName Column's name for which we need attributes
*
* @return array List of HTML attributes
*/
function getColumnAttributes($gridField, $record, $columnName)
public function getColumnAttributes($gridField, $record, $columnName)
{
return array('class' => 'col-bulkSelect');
}
/**
* Set the column's meta data
* Set the column's meta data.
*
* @param GridField $gridField Current GridField instance
* @param string $columnName Column's name for which we need meta data
*
* @return array List of meta data
*/
function getColumnMetadata($gridField, $columnName)
public function getColumnMetadata($gridField, $columnName)
{
if($columnName == 'BulkSelect') {
if ($columnName == 'BulkSelect') {
return array('title' => 'Select');
}
}
/* **********************************************************************
* GridField_HTMLProvider
* */
/**
*
* @param GridField $gridField
*
* @return array
*/
public function getHTMLFragments($gridField)
{
Requirements::css(BULKEDITTOOLS_MANAGER_PATH . '/css/GridFieldBulkManager.css');
Requirements::javascript(BULKEDITTOOLS_MANAGER_PATH . '/javascript/GridFieldBulkManager.js');
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH . '/lang/js');
Requirements::css(BULKEDITTOOLS_MANAGER_PATH.'/css/GridFieldBulkManager.css');
Requirements::javascript(BULKEDITTOOLS_MANAGER_PATH.'/javascript/GridFieldBulkManager.js');
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH.'/lang/js');
if ( !count($this->config['actions']) )
{
user_error("Trying to use GridFieldBulkManager without any bulk action.", E_USER_ERROR);
if (!count($this->config['actions'])) {
user_error('Trying to use GridFieldBulkManager without any bulk action.', E_USER_ERROR);
}
$actionsListSource = array();
$actionsConfig = array();
foreach ($this->config['actions'] as $action => $actionData)
{
foreach ($this->config['actions'] as $action => $actionData) {
$actionsListSource[$action] = $actionData['label'];
$actionsConfig[$action] = $actionData['config'];
}
@ -297,7 +283,7 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
$firstAction = key($this->config['actions']);
$dropDownActionsList = DropdownField::create('bulkActionName', '')
->setSource( $actionsListSource )
->setSource($actionsListSource)
->setAttribute('class', 'bulkActionName no-change-track')
->setAttribute('id', '');
@ -307,40 +293,39 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
'Label' => _t('GRIDFIELD_BULK_MANAGER.ACTION_BTN_LABEL', 'Go'),
'DataURL' => $gridField->Link('bulkAction'),
'Icon' => $this->config['actions'][$firstAction]['config']['icon'],
'DataConfig' => htmlspecialchars(json_encode($actionsConfig), ENT_QUOTES, 'UTF-8')
'DataConfig' => htmlspecialchars(json_encode($actionsConfig), ENT_QUOTES, 'UTF-8'),
),
'Select' => array(
'Label' => _t('GRIDFIELD_BULK_MANAGER.SELECT_ALL_LABEL', 'Select all')
'Label' => _t('GRIDFIELD_BULK_MANAGER.SELECT_ALL_LABEL', 'Select all'),
),
'Colspan' => (count($gridField->getColumns()) - 1)
'Colspan' => (count($gridField->getColumns()) - 1),
);
$templateData = new ArrayData($templateData);
return array(
'header' => $templateData->renderWith('BulkManagerButtons')
'header' => $templateData->renderWith('BulkManagerButtons'),
);
}
/* **********************************************************************
* GridField_URLHandler
* */
/**
* Returns an action => handler list
* Returns an action => handler list.
*
* @param GridField $gridField
*
* @return array
*/
public function getURLHandlers($gridField) {
public function getURLHandlers($gridField)
{
return array(
'bulkAction' => 'handleBulkAction'
'bulkAction' => 'handleBulkAction',
);
}
/**
* Pass control over to the RequestHandler
* loop through the handlers provided in config['actions']
@ -351,28 +336,29 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr
*
* @param GridField $gridField
* @param SS_HTTPRequest $request
*
* @return mixed
*/
public function handleBulkAction($gridField, $request)
{
$controller = $gridField->getForm()->Controller();
foreach ($this->config['actions'] as $name => $data)
{
foreach ($this->config['actions'] as $name => $data) {
$handlerClass = $data['handler'];
$urlHandlers = Config::inst()->get($handlerClass, 'url_handlers', Config::UNINHERITED);
if($urlHandlers) foreach($urlHandlers as $rule => $action)
{
if($request->match($rule, false))
{
if ($urlHandlers) {
foreach ($urlHandlers as $rule => $action) {
if ($request->match($rule, false)) {
//print_r('matched ' . $handlerClass . ' to ' . $rule);
$handler = Injector::inst()->create($handlerClass, $gridField, $this, $controller);
return $handler->handleRequest($request, DataModel::inst());
}
}
}
}
user_error("Unable to find matching bulk action handler for ".$request->remaining().'.', E_USER_ERROR);
user_error('Unable to find matching bulk action handler for '.$request->remaining().'.', E_USER_ERROR);
}
}

7
bulkUpload/code/GridFieldBulkImageUpload.php
View File

@ -1,17 +1,15 @@
<?php
/**
* Legacy GridFieldBulkImageUpload component
* Legacy GridFieldBulkImageUpload component.
*
* @deprecated 2.0 "GridFieldBulkImageUpload" is deprecated, use {@link GridFieldBulkUpload} class instead.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkUpload
*/
class GridFieldBulkImageUpload extends GridFieldBulkUpload
{
/**
* Component constructor
* Component constructor.
*
* @deprecated 2.0 "GridFieldBulkImageUpload" is deprecated, use {@link GridFieldBulkUpload} class instead.
*
@ -20,6 +18,7 @@ class GridFieldBulkImageUpload extends GridFieldBulkUpload
public function __construct($fileRelationName = null)
{
Deprecation::notice('2.0', '"GridFieldBulkImageUpload" is deprecated, use "GridFieldBulkUpload" class instead.');
return new GridFieldBulkUpload($fileRelationName);
}
}

198
bulkUpload/code/GridFieldBulkUpload.php
View File

@ -1,28 +1,26 @@
<?php
/**
* GridField component for uploading images in bulk
* GridField component for uploading images in bulk.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkUpload
*/
class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandler
{
/**
* component configuration
* component configuration.
*
* 'fileRelationName' => field name of the $has_one File/Image relation
*
* @var array
*/
protected $config = array(
'fileRelationName' => null
'fileRelationName' => null,
);
/**
* UploadField configuration.
* These options are passed on directly to the UploadField
* via {@link UploadField::setConfig()} api
* via {@link UploadField::setConfig()} api.
*
* Defaults are: *
* 'sequentialUploads' => false : process uploads 1 after the other rather than all at once
@ -34,13 +32,12 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
protected $ufConfig = array(
'sequentialUploads' => false,
'canAttachExisting' => true,
'canPreviewFolder' => true
'canPreviewFolder' => true,
);
/**
* UploadField setup function calls.
* List of setup functions to call on {@link UploadField} with the value to pass
* 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')
@ -48,13 +45,12 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
* @var array
*/
protected $ufSetup = array(
'setFolderName' => 'bulkUpload'
'setFolderName' => 'bulkUpload',
);
/**
* UploadField Validator setup function calls.
* List of setup functions to call on {@link Upload::validator} with the value to pass
* 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)
@ -62,153 +58,158 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
* @var array
*/
protected $ufValidatorSetup = array(
'setAllowedMaxFileSize' => null
'setAllowedMaxFileSize' => null,
);
/**
* Component constructor
* Component constructor.
*
* @param string $fileRelationName
*/
public function __construct($fileRelationName = null)
{
if ( $fileRelationName != null ) $this->setConfig ( 'fileRelationName', $fileRelationName );
if ($fileRelationName != null) {
$this->setConfig('fileRelationName', $fileRelationName);
}
}
/* **********************************************************************
* Components settings and custom methodes
* */
/**
* Set a component configuration parameter
* Set a component configuration parameter.
*
* @param string $reference
* @param mixed $value
*/
function setConfig ( $reference, $value )
{
if ( in_array($reference, array('folderName', 'maxFileSize', 'sequentialUploads', 'canAttachExisting', 'canPreviewFolder')) )
public function setConfig($reference, $value)
{
if (in_array($reference, array('folderName', 'maxFileSize', 'sequentialUploads', 'canAttachExisting', 'canPreviewFolder'))) {
Deprecation::notice('2.1.0', "GridFieldBulkUpload 'setConfig()' doesn't support '$reference' anymore. Please use 'setUfConfig()', 'setUfSetup()' or 'setUfValidatorSetup()' instead.");
if ( $reference === 'folderName' )
{
if ($reference === 'folderName') {
$this->setUfSetup('setFolderName', $value);
}
else if ( $reference === 'maxFileSize' )
{
} elseif ($reference === 'maxFileSize') {
$this->setUfValidatorSetup('setAllowedMaxFileSize', $value);
}
else{
} else {
$this->setUfConfig($reference, $value);
}
}
else if (!array_key_exists($reference, $this->config) ) {
} elseif (!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
* Set an UploadField configuration parameter.
*
* @param string $reference
* @param mixed $value
*/
function setUfConfig ( $reference, $value )
public function setUfConfig($reference, $value)
{
$this->ufConfig[$reference] = $value;
return $this;
}
/**
* Set an UploadField setup function call
* Set an UploadField setup function call.
*
* @param string $function
* @param mixed $param
*/
function setUfSetup ( $function, $param )
public function setUfSetup($function, $param)
{
$this->ufSetup[$function] = $param;
return $this;
}
/**
* Set an UploadField Validator setup function call
* Set an UploadField Validator setup function call.
*
* @param string $function
* @param mixed $param
*/
function setUfValidatorSetup ( $function, $param )
public function setUfValidatorSetup($function, $param)
{
$this->ufValidatorSetup[$function] = $param;
return $this;
}
/**
* Returns one $config reference or the full $config
* Returns one $config reference or the full $config.
*
* @param string $reference $congif parameter to return
*
* @return mixed
*/
function getConfig ( $reference = false )
public function getConfig($reference = false)
{
if ( $reference ) return $this->config[$reference];
else return $this->config;
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
*/
function getUfConfig ( $reference = false )
public function getUfConfig($reference = false)
{
if ( $reference ) return $this->ufConfig[$reference];
else return $this->ufConfig;
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
*/
function getUfSetup ( $reference = false )
public function getUfSetup($reference = false)
{
if ( $reference ) return $this->ufSetup[$reference];
else return $this->ufSetup;
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
*/
function getUfValidatorSetup ( $reference = false )
public function getUfValidatorSetup($reference = false)
{
if ( $reference ) return $this->ufValidatorSetup[$reference];
else return $this->ufValidatorSetup;
if ($reference) {
return $this->ufValidatorSetup[$reference];
} else {
return $this->ufValidatorSetup;
}
}
/**
* Get the first has_one Image/File relation from the GridField managed DataObject
* i.e. 'MyImage' => 'Image' will return 'MyImage'
* i.e. 'MyImage' => 'Image' will return 'MyImage'.
*
* @return string Name of the $has_one relation
*/
@ -218,10 +219,8 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
$hasOneFields = Config::inst()->get($recordClass, 'has_one', Config::INHERITED);
$imageField = null;
foreach( $hasOneFields as $field => $type )
{
if( $type === 'Image' || $type === 'File' || is_subclass_of($type, 'File') )
{
foreach ($hasOneFields as $field => $type) {
if ($type === 'Image' || $type === 'File' || is_subclass_of($type, 'File')) {
$imageField = $field;
break;
}
@ -230,24 +229,23 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
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
* Either as set in the component config or the default one.
*
* @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'
* i.e. 'MyImage' => 'File' will return 'File'.
*
* @return string file relation className
*/
@ -257,20 +255,19 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
$hasOneFields = Config::inst()->get($recordClass, 'has_one', Config::INHERITED);
$fieldName = $this->getFileRelationName($gridField);
if($fieldName)
{
if ($fieldName) {
return $hasOneFields[$fieldName];
}
else{
} else {
return 'File';
}
}
/**
* Returned a configured UploadField instance
* embedded in the gridfield heard
* embedded in the gridfield heard.
*
* @param GridField $gridField Current GridField
*
* @return UploadField Configured UploadField instance
*/
public function bulkUploadField($gridField)
@ -295,43 +292,38 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
;
//set UploadField config
foreach ($this->ufConfig as $key => $val)
{
foreach ($this->ufConfig as $key => $val) {
$uploadField->setConfig($key, $val);
}
//UploadField setup
foreach ($this->ufSetup as $fn => $param)
{
foreach ($this->ufSetup as $fn => $param) {
$uploadField->{$fn}($param);
}
//UploadField Validator setup
foreach ($this->ufValidatorSetup as $fn => $param)
{
foreach ($this->ufValidatorSetup as $fn => $param) {
$uploadField->getValidator()->{$fn}($param);
}
return $uploadField;
}
/* **********************************************************************
* GridField_HTMLProvider
* */
/**
* HTML to be embedded into the GridField
* HTML to be embedded into the GridField.
*
* @param GridField $gridField
*
* @return array
*/
public function getHTMLFragments($gridField)
{
// permission check
if( !singleton($gridField->getModelClass())->canEdit() )
{
if (!singleton($gridField->getModelClass())->canEdit()) {
return array();
}
@ -349,8 +341,7 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
->setAttribute('data-icon', 'arrow-circle-double')
->setUseButtonTag(true);
if ( count($bulkManager) )
{
if (count($bulkManager)) {
$cancelButton = FormAction::create('Cancel', _t('GRIDFIELD_BULK_UPLOAD.CANCEL_BTN_LABEL', 'Cancel'))
->addExtraClass('bulkUploadCancelButton ss-ui-action-destructive')
->setAttribute('data-icon', 'decline')
@ -359,17 +350,16 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
$bulkManager_config = $bulkManager->first()->getConfig();
$bulkManager_actions = $bulkManager_config['actions'];
if(array_key_exists('bulkedit' , $bulkManager_actions)){
if (array_key_exists('bulkedit', $bulkManager_actions)) {
$editAllButton = FormAction::create('EditAll', _t('GRIDFIELD_BULK_UPLOAD.EDIT_ALL_BTN_LABEL', 'Edit all'))
->addExtraClass('bulkUploadEditButton')
->setAttribute('data-icon', 'pencil')
->setAttribute('data-url', $gridField->Link('bulkupload/edit'))
->setUseButtonTag(true);
}else{
} else {
$editAllButton = '';
}
}
else{
} else {
$cancelButton = '';
$editAllButton = '';
}
@ -383,43 +373,43 @@ class GridFieldBulkUpload implements GridField_HTMLProvider, GridField_URLHandle
$data = ArrayData::create(array(
'Colspan' => count($gridField->getColumns()),
'UploadField' => $uploadField->Field() // call ->Field() to get requirements in right order
'UploadField' => $uploadField->Field(), // call ->Field() to get requirements in right order
));
Requirements::css(BULKEDITTOOLS_UPLOAD_PATH . '/css/GridFieldBulkUpload.css');
Requirements::javascript(BULKEDITTOOLS_UPLOAD_PATH . '/javascript/GridFieldBulkUpload.js');
Requirements::javascript(BULKEDITTOOLS_UPLOAD_PATH . '/javascript/GridFieldBulkUpload_downloadtemplate.js');
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH . '/lang/js');
Requirements::css(BULKEDITTOOLS_UPLOAD_PATH.'/css/GridFieldBulkUpload.css');
Requirements::javascript(BULKEDITTOOLS_UPLOAD_PATH.'/javascript/GridFieldBulkUpload.js');
Requirements::javascript(BULKEDITTOOLS_UPLOAD_PATH.'/javascript/GridFieldBulkUpload_downloadtemplate.js');
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH.'/lang/js');
return array(
'header' => $data->renderWith('GridFieldBulkUpload')
'header' => $data->renderWith('GridFieldBulkUpload'),
);
}
/* **********************************************************************
* GridField_URLHandler
* */
/**
* Component URL handlers
* Component URL handlers.
*
* @param GridField $gridField
*
* @return array
*/
public function getURLHandlers($gridField) {
public function getURLHandlers($gridField)
{
return array(
'bulkupload' => 'handleBulkUpload'
'bulkupload' => 'handleBulkUpload',
);
}
/**
* Pass control over to the RequestHandler
* Pass control over to the RequestHandler.
*
* @param GridField $gridField
* @param SS_HTTPRequest $request
*
* @return mixed
*/
public function handleBulkUpload($gridField, $request)

116
bulkUpload/code/GridFieldBulkUpload_Request.php
View File

@ -1,54 +1,52 @@
<?php
/**
* Handles request from the GridFieldBulkUpload component
* Handles request from the GridFieldBulkUpload component.
*
* @author colymba
* @package GridFieldBulkEditingTools
* @subpackage BulkUpload
*/
class GridFieldBulkUpload_Request extends RequestHandler
{
/**
* Gridfield instance
* Gridfield instance.
*
* @var GridField
*/
protected $gridField;
/**
* Bulk upload component
* Bulk upload component.
*
* @var GridFieldBulkUpload
*/
protected $component;
/**
* Gridfield Form controller
* Gridfield Form controller.
*
* @var Controller
*/
protected $controller;
/**
* RequestHandler allowed actions
* RequestHandler allowed actions.
*
* @var array
*/
private static $allowed_actions = array(
'upload', 'select', 'attach', 'fileexists'
'upload', 'select', 'attach', 'fileexists',
);
/**
* RequestHandler url => action map
* RequestHandler url => action map.
*
* @var array
*/
private static $url_handlers = array(
'$Action!' => '$Action'
'$Action!' => '$Action',
);
/**
* Handler's constructor
* Handler's constructor.
*
* @param GridFIeld $gridField
* @param GridField_URLHandler $component
@ -62,9 +60,8 @@ class GridFieldBulkUpload_Request extends RequestHandler
parent::__construct();
}
/**
* Return the original component's UploadField
* Return the original component's UploadField.
*
* @return UploadField UploadField instance as defined in the component
*/
@ -73,14 +70,14 @@ class GridFieldBulkUpload_Request extends RequestHandler
return $this->component->bulkUploadField($this->gridField);
}
/**
* Process upload through UploadField,
* creates new record and link newly uploaded file
* adds record to GrifField relation list
* and return image/file data and record edit form
* and return image/file data and record edit form.
*
* @param SS_HTTPRequest $request
*
* @return string json
*/
public function upload(SS_HTTPRequest $request)
@ -91,11 +88,10 @@ class GridFieldBulkUpload_Request extends RequestHandler
$record->write();
// passes the current gridfield-instance to a call-back method on the new object
$record->extend("onBulkUpload", $this->gridField);
if ( $record->hasMethod('onBulkImageUpload') )
{
$record->extend('onBulkUpload', $this->gridField);
if ($record->hasMethod('onBulkImageUpload')) {
Deprecation::notice('2.0', '"onBulkImageUpload" callback is deprecated, use "onBulkUpload" instead.');
$record->extend("onBulkImageUpload", $this->gridField);
$record->extend('onBulkImageUpload', $this->gridField);
}
//get uploadField and process upload
@ -106,8 +102,8 @@ class GridFieldBulkUpload_Request extends RequestHandler
$uploadResponse = $uploadField->upload($request);
//get uploaded File response datas
$uploadResponse = Convert::json2array( $uploadResponse->getBody() );
$uploadResponse = array_shift( $uploadResponse );
$uploadResponse = Convert::json2array($uploadResponse->getBody());
$uploadResponse = array_shift($uploadResponse);
// Attach the file to record.
$record->{"{$fileRelationName}ID"} = $uploadResponse['id'];
@ -125,44 +121,38 @@ class GridFieldBulkUpload_Request extends RequestHandler
return $response;
}
/**
* Updates the Upload/Attach response from the UploadField
* with the new DataObject records for the JS template
* with the new DataObject records for the JS template.
*
* @param DataObject $record Newly create DataObject record
* @param array $uploadResponse Upload or Attach response from UploadField
*
* @return array Updated $uploadResponse with $record data
*/
protected function newRecordJSTemplateData(DataObject &$record, &$uploadResponse)
{
// fetch uploadedFile record and sort out previewURL
// update $uploadResponse datas in case changes happened onAfterWrite()
$uploadedFile = DataObject::get_by_id( $this->component->getFileRelationClassName($this->gridField), $uploadResponse['id'] );
$uploadedFile = DataObject::get_by_id($this->component->getFileRelationClassName($this->gridField), $uploadResponse['id']);
if ( $uploadedFile )
{
if ($uploadedFile) {
$uploadResponse['name'] = $uploadedFile->Name;
$uploadResponse['url'] = $uploadedFile->getURL();
if ( $uploadedFile instanceof Image )
{
$uploadResponse['thumbnail_url'] = $uploadedFile->CroppedImage(30,30)->getURL();
}
else{
if ($uploadedFile instanceof Image) {
$uploadResponse['thumbnail_url'] = $uploadedFile->CroppedImage(30, 30)->getURL();
} else {
$uploadResponse['thumbnail_url'] = $uploadedFile->Icon();
}
// check if our new record has a Title, if not create one automatically
$title = $record->getTitle();
if ( !$title || $title === $record->ID )
{
if ( $record->hasDatabaseField('Title') )
{
if (!$title || $title === $record->ID) {
if ($record->hasDatabaseField('Title')) {
$record->Title = $uploadedFile->Title;
$record->write();
}
else if ($record->hasDatabaseField('Name')){
} elseif ($record->hasDatabaseField('Name')) {
$record->Name = $uploadedFile->Title;
$record->write();
}
@ -172,16 +162,15 @@ class GridFieldBulkUpload_Request extends RequestHandler
// Collect all data for JS template
$return = array_merge($uploadResponse, array(
'record' => array(
'id' => $record->ID
)
'id' => $record->ID,
),
));
return $return;
}
/**
* Pass select request to UploadField
* Pass select request to UploadField.
*
* @link UploadField->select()
*/
@ -192,41 +181,42 @@ class GridFieldBulkUpload_Request extends RequestHandler
return $uploadField->handleSelect($request);
*/
$uploadField = $this->getUploadField();
return UploadField_SelectHandler::create($this, $uploadField->getFolderName());
}
/**
* Pass getRelationAutosetClass request to UploadField
* Used by select dialog
* Used by select dialog.
*
* @link UploadField->getRelationAutosetClass()
*/
public function getRelationAutosetClass($default = 'File')
{
$uploadField = $this->getUploadField();
return $uploadField->getRelationAutosetClass($default);
}
/**
* Pass getAllowedMaxFileNumber request to UploadField
* Used by select dialog
* Used by select dialog.
*
* @link UploadField->getAllowedMaxFileNumber()
*/
public function getAllowedMaxFileNumber()
{
$uploadField = $this->getUploadField();
return $uploadField->getAllowedMaxFileNumber();
}
/**
* Retrieve Files to be attached
* and generated DataObjects for each one
* and generated DataObjects for each one.
*
* @param SS_HTTPRequest $request
*
* @return SS_HTTPResponse
*/
public function attach(SS_HTTPRequest $request)
@ -239,12 +229,11 @@ class GridFieldBulkUpload_Request extends RequestHandler
$recordClass = $this->gridField->list->dataClass;
$return = array();
foreach ($attachResponses as $attachResponse)
{
foreach ($attachResponses as $attachResponse) {
// create record
$record = Object::create($recordClass);
$record->write();
$record->extend("onBulkUpload", $this->gridField);
$record->extend('onBulkUpload', $this->gridField);
// attach file
$record->{"{$fileRelationName}ID"} = $attachResponse['id'];
@ -266,39 +255,40 @@ class GridFieldBulkUpload_Request extends RequestHandler
return $response;
}
/**
* Pass fileexists request to UploadField
* Pass fileexists request to UploadField.
*
* @link UploadField->fileexists()
*/
public function fileexists(SS_HTTPRequest $request)
{
$uploadField = $this->getUploadField();
return $uploadField->fileexists($request);
}
/**
* @param string $action
*
* @return string
*/
public function Link($action = null) {
public function Link($action = null)
{
return Controller::join_links($this->gridField->Link(), '/bulkupload/', $action);
}
/**
* Sets response 'Content-Type' depending on browser capabilities
* e.g. IE needs text/plain for iframe transport
* https://github.com/blueimp/jQuery-File-Upload/issues/1795
* https://github.com/blueimp/jQuery-File-Upload/issues/1795.
*
* @param SS_HTTPResponse $response HTTP Response to set content-type on
*/
protected function contentTypeNegotiation(&$response)
{
if (isset($_SERVER['HTTP_ACCEPT']) && ((strpos($_SERVER['HTTP_ACCEPT'], 'application/json') !== false) || $_SERVER['HTTP_ACCEPT'] === '*/*' ))
{
if (isset($_SERVER['HTTP_ACCEPT']) && ((strpos($_SERVER['HTTP_ACCEPT'], 'application/json') !== false) || $_SERVER['HTTP_ACCEPT'] === '*/*')) {
$response->addHeader('Content-Type', 'application/json');
}else{
} else {
$response->addHeader('Content-Type', 'text/plain');
}
}

141
tasks/BuildTransifexTranslations.php
View File

@ -4,15 +4,16 @@
* from Transifex data. This tasks assumes that:
* - Javascript translations are from the Transifex resource called 'js'
* - YML translations are from the Transifex resource called 'yml'
* - Transifex AUTH credentials to be saved in $txAuthFile with content {"username": "user", "password": "pwd"}
* - Transifex AUTH credentials to be saved in $txAuthFile with content {"username": "user", "password": "pwd"}.
*
* This is inspired by SilverStripe build tools. Thanks
*
* @see https://github.com/silverstripe/silverstripe-buildtools/blob/master/src/GenerateJavascriptI18nTask.php
*/
include_once "phing/Task.php";
include_once 'phing/Task.php';
// Ignore this file if phing is not installed
if(!class_exists('Task')) {
if (!class_exists('Task')) {
return;
}
@ -38,32 +39,28 @@ class BuildTransifexTranslations extends Task
}
/**
* Task init
* Task init.
*/
public function init()
{
$root = realpath(__DIR__ . DIRECTORY_SEPARATOR . '..');
$authFile = $root . DIRECTORY_SEPARATOR . $this->txAuthFile;
$root = realpath(__DIR__.DIRECTORY_SEPARATOR.'..');
$authFile = $root.DIRECTORY_SEPARATOR.$this->txAuthFile;
if ( file_exists($authFile) )
{
if (file_exists($authFile)) {
$txAuthData = file_get_contents($authFile);
$txAuthData = json_decode($txAuthData);
if ( $txAuthData->username && $txAuthData->password )
{
if ($txAuthData->username && $txAuthData->password) {
$this->txAuth = $txAuthData;
}
else{
} else {
throw new BuildException("Transifex credentials malformat. Check your $authFile for 'username' and 'password' keys.");
}
}
else{
} else {
throw new BuildException("Transifex credentials not found. $authFile missing.");
}
$this->root = $root;
$this->jsDir = $root . $this->jsDir;
$this->ymlDir = $root . $this->ymlDir;
$this->jsDir = $root.$this->jsDir;
$this->ymlDir = $root.$this->ymlDir;
}
/**
@ -75,18 +72,16 @@ class BuildTransifexTranslations extends Task
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, $this->txAuth->username . ":" . $this->txAuth->password);
curl_setopt($ch, CURLOPT_USERPWD, $this->txAuth->username.':'.$this->txAuth->password);
// get resources
$url = $this->txapi.'/project/'.$this->txproject.'/resources/';
curl_setopt($ch, CURLOPT_URL, $url);
$resources = curl_exec($ch);
if ( !$resources )
{
throw new BuildException("Cannot fetch resources");
}
else{
if (!$resources) {
throw new BuildException('Cannot fetch resources');
} else {
$resources = json_decode($resources);
}
@ -95,11 +90,9 @@ class BuildTransifexTranslations extends Task
curl_setopt($ch, CURLOPT_URL, $url);
$languages = curl_exec($ch);
if ( !$languages )
{
throw new BuildException("Cannot fetch languages");
}
else{
if (!$languages) {
throw new BuildException('Cannot fetch languages');
} else {
$languages = json_decode($languages);
}
@ -108,13 +101,11 @@ class BuildTransifexTranslations extends Task
// add source_language_code to languages list
$sourceLangs = array();
foreach ($resources as $resource)
{
foreach ($resources as $resource) {
$lang = new StdClass();
$locale = $resource->source_language_code;
$lang->language_code = $locale;
if ( !array_key_exists($locale, $sourceLangs) )
{
if (!array_key_exists($locale, $sourceLangs)) {
$sourceLangs[$locale] = $lang;
}
}
@ -122,15 +113,12 @@ class BuildTransifexTranslations extends Task
$languages = array_merge($languages, $sourceLangs);
// get each resource translations
foreach ($resources as $resource)
{
foreach ($languages as $language)
{
foreach ($resources as $resource) {
foreach ($languages as $language) {
$url = $this->txapi.'/project/'.$this->txproject.'/resource/'.$resource->slug.'/translation/'.$language->language_code;
curl_setopt($ch, CURLOPT_URL, $url);
$data = curl_exec($ch);
if ( $data )
{
if ($data) {
$this->saveTranslation($resource->slug, $language->language_code, $data);
}
}
@ -141,44 +129,36 @@ class BuildTransifexTranslations extends Task
/**
* Clear any existing translation files
* and create directory structure if needed
* and create directory structure if needed.
*/
private function resetTranslations()
{
if ( file_exists($this->jsDir) )
{
if (file_exists($this->jsDir)) {
echo "Clearing js translations...\n";
$iterator = new GlobIterator($this->jsDir . DIRECTORY_SEPARATOR . '*.js');
foreach ($iterator as $fileInfo)
{
if ( $fileInfo->isFile() )
{
$iterator = new GlobIterator($this->jsDir.DIRECTORY_SEPARATOR.'*.js');
foreach ($iterator as $fileInfo) {
if ($fileInfo->isFile()) {
$del = unlink($fileInfo->getRealPath());
}
}
}
if ( file_exists($this->ymlDir) )
{
if (file_exists($this->ymlDir)) {
echo "Clearing yml translations...\n";
$iterator = new GlobIterator($this->ymlDir . DIRECTORY_SEPARATOR . '*.yml');
foreach ($iterator as $fileInfo)
{
if ( $fileInfo->isFile() )
{
$iterator = new GlobIterator($this->ymlDir.DIRECTORY_SEPARATOR.'*.yml');
foreach ($iterator as $fileInfo) {
if ($fileInfo->isFile()) {
$del = unlink($fileInfo->getRealPath());
}
}
}
if ( !file_exists($this->jsDir) )
{
if (!file_exists($this->jsDir)) {
echo "Creating js folders...\n";
mkdir($this->jsDir);
}
if ( !file_exists($this->ymlDir) )
{
if (!file_exists($this->ymlDir)) {
echo "Creating yml folders...\n";
mkdir($this->ymlDir);
}
@ -186,23 +166,22 @@ class BuildTransifexTranslations extends Task
/**
* Hook that detect the translation type via resource slug
* and call corect saving function with data
* and call corect saving function with data.
*
* @param string $resource Transifex resrouce slug
* @param string $locale Transifex locale
* @param string $data Raw Transifex translation data
*/
private function saveTranslation($resource, $locale, $data)
{
if ( !$resource || !$locale || !$data )
{
if (!$resource || !$locale || !$data) {
return;
}
$data = json_decode($data);
$translation = rtrim($data->content);
switch ($resource)
{
switch ($resource) {
case 'js':
$this->saveJSTranslation($locale, $translation);
break;
@ -215,7 +194,8 @@ class BuildTransifexTranslations extends Task
/**
* Save a JS translation file
* Uses JSTemplate to fit with SilverStripe requirements
* Uses JSTemplate to fit with SilverStripe requirements.
*
* @param string $locale Locale code
* @param string $json JSON translation key:value
*/
@ -223,16 +203,16 @@ class BuildTransifexTranslations extends Task
{
echo "Saving $locale.js\n";
file_put_contents(
$this->jsDir . DIRECTORY_SEPARATOR . $locale . '.js',
$this->getBanner('js') .
$this->jsDir.DIRECTORY_SEPARATOR.$locale.'.js',
$this->getBanner('js').
str_replace(
array(
'%TRANSLATIONS%',
'%LOCALE%'
'%LOCALE%',
),
array(
$json,
$locale
$locale,
),
$this->getJSTemplate()
)
@ -240,7 +220,8 @@ class BuildTransifexTranslations extends Task
}
/**
* Save a YML translation file
* Save a YML translation file.
*
* @param string $locale Locale code
* @param string $yml YML translation
*/
@ -248,35 +229,34 @@ class BuildTransifexTranslations extends Task
{
echo "Saving $locale.yml\n";
if ($locale !== 'en')
{
$content = $this->getBanner('yml') . $yml;
}
else{
if ($locale !== 'en') {
$content = $this->getBanner('yml').$yml;
} else {
$content = $yml;
}
file_put_contents(
$this->ymlDir . DIRECTORY_SEPARATOR . $locale . '.yml',
$this->ymlDir.DIRECTORY_SEPARATOR.$locale.'.yml',
$content
);
}
/**
* Return the commented file banner
* Return the commented file banner.
*
* @param string $type File type e.g js
*
* @return string The commented file banner
*/
private function getBanner($type)
{
switch ( strtolower($type) )
{
switch (strtolower($type)) {
case 'yml':
$comment = "#";
$comment = '#';
break;
default:
$comment = "//";
$comment = '//';
break;
}
@ -285,11 +265,13 @@ $comment DO NOT MODIFY. Generated by build task.
$comment Contribute here: https://www.transifex.com/projects/p/gridfieldbulkeditingtools/
TMPL;
return $banner;
}
/**
* Return the SilverStripe JS lang file template
* Return the SilverStripe JS lang file template.
*
* @return string The JS file template
*/
private function getJSTemplate()
@ -301,6 +283,7 @@ if(typeof(ss) == 'undefined' || typeof(ss.i18n) == 'undefined') {
ss.i18n.addDictionary('%LOCALE%', %TRANSLATIONS%);
}
TMPL;
return $tmpl;
}
}