silverstripe-framework/tests/forms/gridfield/GridField_URLHandlerTest.php

<?php

use SilverStripe\ORM\ArrayList;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Dev\TestOnly;
use SilverStripe\Control\Controller;
use SilverStripe\Control\RequestHandler;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_URLHandler;
use SilverStripe\View\SSViewer;


/**
 * Test the API for creating GridField_URLHandler compeonnts
 */
class GridField_URLHandlerTest extends FunctionalTest {
	public function testFormSubmission() {
		$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/showform");
		$formResult = $this->submitForm('Form_Form', 'action_doAction', array('Test' => 'foo bar') );
		$this->assertEquals("Submitted foo bar to component", $formResult->getBody());
	}

	public function testNestedRequestHandlerFormSubmission() {
		$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/item/3/showform");
		$formResult = $this->submitForm('Form_Form', 'action_doAction', array('Test' => 'foo bar') );
		$this->assertEquals("Submitted foo bar to item #3", $formResult->getBody());
	}

	public function testURL() {
		$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/testpage");
		$this->assertEquals("Test page for component", $result->getBody());
	}

	public function testNestedRequestHandlerURL() {
		$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/item/5/testpage");
		$this->assertEquals("Test page for item #5", $result->getBody());
	}


}

class GridField_URLHandlerTest_Controller extends Controller implements TestOnly {

	private static $allowed_actions = array('Form');

	public function Form() {
		$gridConfig = GridFieldConfig::create();
		$gridConfig->addComponent(new GridField_URLHandlerTest_Component());

		$gridData = new ArrayList();
		$gridField = new GridField('Grid', 'My grid', $gridData, $gridConfig);

		/** @skipUpgrade */
		return new Form($this, 'Form', new FieldList(
			$gridField
		), new FieldList());
	}
}


/**
 * Test URLHandler with a nested request handler
 */
class GridField_URLHandlerTest_Component extends RequestHandler implements GridField_URLHandler {

	private static $allowed_actions = array('Form', 'showform', 'testpage', 'handleItem');

	protected $gridField;

	public function getURLHandlers($gridField) {
		/** @skipUpgrade */
		return array(
			'showform' => 'showform',
			'testpage' => 'testpage',
			'Form' => 'Form',
			'item/$ID' => 'handleItem',
		);
	}

	public function handleItem($gridField, $request) {
		$id = $request->param("ID");
		return new GridField_URLHandlerTest_Component_ItemRequest(
				$gridField, $id,
				Controller::join_links($gridField->Link(), 'item/' . $id));
	}

	public function Link() {
		return $this->gridField->Link();
	}

	public function showform($gridField, $request) {
		return "<head>" .  SSViewer::get_base_tag("") . "</head>" . $this->Form($gridField, $request)->forTemplate();
	}

	public function Form($gridField, $request) {
		$this->gridField = $gridField;
		/** @skipUpgrade */
		return new Form($this, 'Form', new FieldList(
			new TextField("Test")
		), new FieldList(
			new FormAction('doAction', 'Go')
		));
	}

	public function doAction($data, $form) {
		return "Submitted " . $data['Test'] . " to component";
	}

	public function testpage($gridField, $request) {
		return "Test page for component";
	}
}

class GridField_URLHandlerTest_Component_ItemRequest extends RequestHandler {

	private static $allowed_actions = array('Form', 'showform', 'testpage');

	protected $gridField;

	protected $link;

	protected $id;

	public function __construct($gridField, $id, $link) {
		$this->gridField = $gridField;
		$this->id = $id;
		$this->link = $link;
		parent::__construct();
	}

	public function Link() {
		return $this->link;
	}

	public function showform() {
		return "<head>" .  SSViewer::get_base_tag("") . "</head>" . $this->Form()->forTemplate();
	}

	public function Form() {
		/** @skipUpgrade */
		return new Form($this, 'Form', new FieldList(
			new TextField("Test")
		), new FieldList(
			new FormAction('doAction', 'Go')
		));
	}

	public function doAction($data, $form) {
		return "Submitted " . $data['Test'] . " to item #" . $this->id;
	}

	public function testpage() {
		return "Test page for item #" . $this->id;
	}
}
MINOR: Tests for add and edit forms of GridField 2012-03-06 22:48:09 +01:00			`<?php`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00
API Apply Framework\ORM Namespace to model 2016-06-15 06:03:16 +02:00			`use SilverStripe\ORM\ArrayList;`
API Namespace all classes Namespace all templates Move difflib and BBCodeParser2 to thirdparty Remove deprecated API marked for removal in 4.0 2016-08-19 00:51:35 +02:00			`use SilverStripe\Dev\FunctionalTest;`
			`use SilverStripe\Dev\TestOnly;`
			`use SilverStripe\Control\Controller;`
			`use SilverStripe\Control\RequestHandler;`
			`use SilverStripe\Forms\FieldList;`
			`use SilverStripe\Forms\Form;`
			`use SilverStripe\Forms\TextField;`
			`use SilverStripe\Forms\FormAction;`
			`use SilverStripe\Forms\GridField\GridFieldConfig;`
			`use SilverStripe\Forms\GridField\GridField;`
			`use SilverStripe\Forms\GridField\GridField_URLHandler;`
			`use SilverStripe\View\SSViewer;`





API Apply Framework\ORM Namespace to model 2016-06-15 06:03:16 +02:00
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`/**`
			`* Test the API for creating GridField_URLHandler compeonnts`
			`*/`
			`class GridField_URLHandlerTest extends FunctionalTest {`
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function testFormSubmission() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/showform");`
			`$formResult = $this->submitForm('Form_Form', 'action_doAction', array('Test' => 'foo bar') );`
			`$this->assertEquals("Submitted foo bar to component", $formResult->getBody());`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function testNestedRequestHandlerFormSubmission() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/item/3/showform");`
			`$formResult = $this->submitForm('Form_Form', 'action_doAction', array('Test' => 'foo bar') );`
			`$this->assertEquals("Submitted foo bar to item #3", $formResult->getBody());`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function testURL() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/testpage");`
			`$this->assertEquals("Test page for component", $result->getBody());`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function testNestedRequestHandlerURL() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$result = $this->get("GridField_URLHandlerTest_Controller/Form/field/Grid/item/5/testpage");`
			`$this->assertEquals("Test page for item #5", $result->getBody());`
			`}`


			`}`

			`class GridField_URLHandlerTest_Controller extends Controller implements TestOnly {`
API Enforce $allowed_actions in RequestHandler->checkAccessAction() See discussion at https://groups.google.com/forum/?fromgroups#!topic/silverstripe-dev/Dodomh9QZjk Fixes an access issue where all public methods on FormField were allowed, and not checked for $allowed_actions. Before this patch you could e.g. call FormField->Value() on the first field by using action_Value. Removes the following assertion because it only worked due to RequestHandlingTest_AllowedControllerExtension not having $allowed_extensions declared: "Actions on magic methods are only accessible if explicitly allowed on the controller." 2013-06-20 11:40:55 +02:00
			`private static $allowed_actions = array('Form');`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function Form() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$gridConfig = GridFieldConfig::create();`
			`$gridConfig->addComponent(new GridField_URLHandlerTest_Component());`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$gridData = new ArrayList();`
			`$gridField = new GridField('Grid', 'My grid', $gridData, $gridConfig);`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
API Namespace all classes Namespace all templates Move difflib and BBCodeParser2 to thirdparty Remove deprecated API marked for removal in 4.0 2016-08-19 00:51:35 +02:00			`/** @skipUpgrade */`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return new Form($this, 'Form', new FieldList(`
			`$gridField`
			`), new FieldList());`
			`}`
			`}`


			`/**`
			`* Test URLHandler with a nested request handler`
			`*/`
			`class GridField_URLHandlerTest_Component extends RequestHandler implements GridField_URLHandler {`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
API Enforce $allowed_actions in RequestHandler->checkAccessAction() See discussion at https://groups.google.com/forum/?fromgroups#!topic/silverstripe-dev/Dodomh9QZjk Fixes an access issue where all public methods on FormField were allowed, and not checked for $allowed_actions. Before this patch you could e.g. call FormField->Value() on the first field by using action_Value. Removes the following assertion because it only worked due to RequestHandlingTest_AllowedControllerExtension not having $allowed_extensions declared: "Actions on magic methods are only accessible if explicitly allowed on the controller." 2013-06-20 11:40:55 +02:00			`private static $allowed_actions = array('Form', 'showform', 'testpage', 'handleItem');`

MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`protected $gridField;`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function getURLHandlers($gridField) {`
API Namespace all classes Namespace all templates Move difflib and BBCodeParser2 to thirdparty Remove deprecated API marked for removal in 4.0 2016-08-19 00:51:35 +02:00			`/** @skipUpgrade */`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return array(`
			`'showform' => 'showform',`
			`'testpage' => 'testpage',`
			`'Form' => 'Form',`
			`'item/$ID' => 'handleItem',`
			`);`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function handleItem($gridField, $request) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$id = $request->param("ID");`
			`return new GridField_URLHandlerTest_Component_ItemRequest(`
			`$gridField, $id,`
			`Controller::join_links($gridField->Link(), 'item/' . $id));`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function Link() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return $this->gridField->Link();`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function showform($gridField, $request) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return "<head>" . SSViewer::get_base_tag("") . "</head>" . $this->Form($gridField, $request)->forTemplate();`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function Form($gridField, $request) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$this->gridField = $gridField;`
API Namespace all classes Namespace all templates Move difflib and BBCodeParser2 to thirdparty Remove deprecated API marked for removal in 4.0 2016-08-19 00:51:35 +02:00			`/** @skipUpgrade */`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return new Form($this, 'Form', new FieldList(`
			`new TextField("Test")`
			`), new FieldList(`
			`new FormAction('doAction', 'Go')`
			`));`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function doAction($data, $form) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return "Submitted " . $data['Test'] . " to component";`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function testpage($gridField, $request) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return "Test page for component";`
			`}`
			`}`

			`class GridField_URLHandlerTest_Component_ItemRequest extends RequestHandler {`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
API Enforce $allowed_actions in RequestHandler->checkAccessAction() See discussion at https://groups.google.com/forum/?fromgroups#!topic/silverstripe-dev/Dodomh9QZjk Fixes an access issue where all public methods on FormField were allowed, and not checked for $allowed_actions. Before this patch you could e.g. call FormField->Value() on the first field by using action_Value. Removes the following assertion because it only worked due to RequestHandlingTest_AllowedControllerExtension not having $allowed_extensions declared: "Actions on magic methods are only accessible if explicitly allowed on the controller." 2013-06-20 11:40:55 +02:00			`private static $allowed_actions = array('Form', 'showform', 'testpage');`

MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`protected $gridField;`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`protected $link;`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`protected $id;`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function __construct($gridField, $id, $link) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`$this->gridField = $gridField;`
			`$this->id = $id;`
			`$this->link = $link;`
			`parent::__construct();`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function Link() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return $this->link;`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function showform() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return "<head>" . SSViewer::get_base_tag("") . "</head>" . $this->Form()->forTemplate();`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function Form() {`
API Namespace all classes Namespace all templates Move difflib and BBCodeParser2 to thirdparty Remove deprecated API marked for removal in 4.0 2016-08-19 00:51:35 +02:00			`/** @skipUpgrade */`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return new Form($this, 'Form', new FieldList(`
			`new TextField("Test")`
			`), new FieldList(`
			`new FormAction('doAction', 'Go')`
			`));`
			`}`
Remove all redundant whitespace 2014-08-15 08:53:05 +02:00
Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function doAction($data, $form) {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return "Submitted " . $data['Test'] . " to item #" . $this->id;`
			`}`

Method visibility according to coding conventions 2012-09-19 12:07:39 +02:00			`public function testpage() {`
MINOR: Added a test for GridField_URLHandler components. 2012-01-09 23:10:03 +01:00			`return "Test page for item #" . $this->id;`
			`}`
MINOR Add newline to end of files without one 2012-03-24 04:04:52 +01:00			`}`