Converted to PSR-2

This commit is contained in:
helpfulrobot 2015-11-18 17:08:21 +13:00
parent d66a641934
commit 130e9d06a1
9 changed files with 1233 additions and 1177 deletions

View File

@ -4,8 +4,8 @@
*
* @package widgets
*/
class WidgetContentControllerExtension extends Extension {
class WidgetContentControllerExtension extends Extension
{
/**
*
* @var array
@ -25,9 +25,12 @@ class WidgetContentControllerExtension extends Extension {
*
* @return RequestHandler
*/
public function handleWidget() {
public function handleWidget()
{
$SQL_id = $this->owner->getRequest()->param('ID');
if(!$SQL_id) return false;
if (!$SQL_id) {
return false;
}
// find WidgetArea relations
$widgetAreaRelations = array();

View File

@ -18,8 +18,8 @@
*
* @package widgets
*/
class WidgetController extends Controller {
class WidgetController extends Controller
{
/**
* @var Widget
*/
@ -35,7 +35,8 @@ class WidgetController extends Controller {
/**
* @param Widget $widget
*/
public function __construct($widget = null) {
public function __construct($widget = null)
{
if ($widget) {
$this->widget = $widget;
$this->failover = $widget;
@ -48,7 +49,8 @@ class WidgetController extends Controller {
* @param string $action
* @return string
*/
public function Link($action = null) {
public function Link($action = null)
{
$id = ($this->widget) ? $this->widget->ID : null;
$segment = Controller::join_links('widget', $id, $action);
@ -62,7 +64,8 @@ class WidgetController extends Controller {
/**
* @return Widget
*/
public function getWidget() {
public function getWidget()
{
return $this->widget;
}
@ -72,7 +75,8 @@ class WidgetController extends Controller {
*
* @return string HTML
*/
public function Content() {
public function Content()
{
return $this->renderWith(array_reverse(ClassInfo::ancestry($this->widget->class)));
}
@ -82,7 +86,8 @@ class WidgetController extends Controller {
*
* @return string HTML
*/
public function WidgetHolder() {
public function WidgetHolder()
{
return $this->renderWith("WidgetHolder");
}
@ -94,7 +99,8 @@ class WidgetController extends Controller {
*
* @return string HTML
*/
public function editablesegment() {
public function editablesegment()
{
$className = $this->urlParams['ID'];
if (class_exists('Translatable') && Member::currentUserID()) {
// set current locale based on logged in user's locale
@ -115,6 +121,6 @@ class WidgetController extends Controller {
* @deprecated Use WidgetController
* @package widgets
*/
class Widget_Controller extends WidgetController {
class Widget_Controller extends WidgetController
{
}

View File

@ -8,8 +8,8 @@
* feel free to create your own relationships, naming conventions, etc.
* without using this class.
*/
class WidgetPageExtension extends DataExtension {
class WidgetPageExtension extends DataExtension
{
private static $db = array(
'InheritSideBar' => 'Boolean',
);
@ -22,7 +22,8 @@ class WidgetPageExtension extends DataExtension {
'SideBar' => 'WidgetArea'
);
public function updateCMSFields(FieldList $fields) {
public function updateCMSFields(FieldList $fields)
{
$fields->addFieldToTab(
"Root.Widgets",
new CheckboxField("InheritSideBar", 'Inherit Sidebar From Parent')
@ -36,7 +37,8 @@ class WidgetPageExtension extends DataExtension {
/**
* @return WidgetArea
*/
public function SideBarView() {
public function SideBarView()
{
if (
$this->owner->InheritSideBar
&& ($parent = $this->owner->getParent())
@ -48,7 +50,8 @@ class WidgetPageExtension extends DataExtension {
}
}
public function onBeforeDuplicate($duplicatePage) {
public function onBeforeDuplicate($duplicatePage)
{
if ($this->owner->hasField('SideBarID')) {
$sideBar = $this->owner->getComponent('SideBar');
$duplicateWidgetArea = $sideBar->duplicate();
@ -60,7 +63,6 @@ class WidgetPageExtension extends DataExtension {
}
$duplicatePage->SideBarID = $duplicateWidgetArea->ID;
}
return $duplicatePage;
@ -69,9 +71,9 @@ class WidgetPageExtension extends DataExtension {
/**
* Support Translatable so that we don't link WidgetAreas across translations
*/
public function onTranslatableCreate() {
public function onTranslatableCreate()
{
//reset the sidebar ID
$this->owner->SideBarID = 0;
}
}

View File

@ -5,14 +5,15 @@
*
* @package widgets
*/
class WidgetAreaEditor extends FormField {
class WidgetAreaEditor extends FormField
{
/**
* @param string $name
* @param array $widgetClasses
* @param int $maxWidgets
*/
public function __construct($name, $widgetClasses = array('Widget'), $maxWidgets = 0) {
public function __construct($name, $widgetClasses = array('Widget'), $maxWidgets = 0)
{
$this->MaxWidgets = $maxWidgets;
$this->widgetClasses = $widgetClasses;
@ -24,7 +25,8 @@ class WidgetAreaEditor extends FormField {
*
* @return string - HTML
*/
public function FieldHolder($properties = array()) {
public function FieldHolder($properties = array())
{
Requirements::css('widgets/css/WidgetAreaEditor.css');
Requirements::javascript('widgets/javascript/WidgetAreaEditor.js');
@ -35,7 +37,8 @@ class WidgetAreaEditor extends FormField {
*
* @return ArrayList
*/
public function AvailableWidgets() {
public function AvailableWidgets()
{
$widgets= new ArrayList();
foreach ($this->widgetClasses as $widgetClass) {
@ -43,13 +46,11 @@ class WidgetAreaEditor extends FormField {
if (isset($classes['Widget'])) {
unset($classes['Widget']);
}
else if (isset($classes[0]) && $classes[0] == 'Widget') {
} elseif (isset($classes[0]) && $classes[0] == 'Widget') {
unset($classes[0]);
}
foreach ($classes as $class) {
$available = Config::inst()->get($class, 'only_available_in');
if (!empty($available) && is_array($available)) {
@ -68,7 +69,8 @@ class WidgetAreaEditor extends FormField {
/**
* @return HasManyList
*/
public function UsedWidgets() {
public function UsedWidgets()
{
// Call class_exists() to load Widget.php earlier and avoid a segfault
class_exists('Widget');
@ -81,7 +83,8 @@ class WidgetAreaEditor extends FormField {
/**
* @return string
*/
public function IdxField() {
public function IdxField()
{
return $this->id() . 'ID';
}
@ -89,7 +92,8 @@ class WidgetAreaEditor extends FormField {
*
* @return int
*/
public function Value() {
public function Value()
{
$relationName = $this->name;
return $this->form->getRecord()->getComponent($relationName)->ID;
@ -98,7 +102,8 @@ class WidgetAreaEditor extends FormField {
/**
* @param DataObjectInterface $record
*/
public function saveInto(DataObjectInterface $record) {
public function saveInto(DataObjectInterface $record)
{
$name = $this->name;
$idName = $name . "ID";
@ -119,7 +124,9 @@ class WidgetAreaEditor extends FormField {
}
}
if(!$this->getForm()) throw new Exception("no form");
if (!$this->getForm()) {
throw new Exception("no form");
}
$widgetData = $this->getForm()->getRequest()->requestVar('Widget');
if ($widgetData && isset($widgetData[$this->getName()])) {

View File

@ -10,8 +10,8 @@
*
* @package widgets
*/
class Widget extends DataObject {
class Widget extends DataObject
{
/**
* @var array
*/
@ -77,7 +77,8 @@ class Widget extends DataObject {
*/
protected $controller;
public function populateDefaults() {
public function populateDefaults()
{
parent::populateDefaults();
$this->setField('Title', $this->getTitle());
}
@ -87,7 +88,8 @@ class Widget extends DataObject {
*
* @return string HTML
*/
public function WidgetHolder() {
public function WidgetHolder()
{
return $this->renderWith("WidgetHolder");
}
@ -95,7 +97,8 @@ class Widget extends DataObject {
* Default way to render widget in templates.
* @return string HTML
*/
public function forTemplate($holder = true){
public function forTemplate($holder = true)
{
if ($holder) {
return $this->WidgetHolder();
}
@ -113,7 +116,8 @@ class Widget extends DataObject {
*
* @return string HTML
*/
public function Content() {
public function Content()
{
return $this->renderWith(array_reverse(ClassInfo::ancestry($this->class)));
}
@ -121,7 +125,8 @@ class Widget extends DataObject {
* @return string
* @deprecated
*/
public function Title() {
public function Title()
{
return $this->getTitle();
}
@ -130,7 +135,8 @@ class Widget extends DataObject {
*
* @return string
*/
public function getTitle() {
public function getTitle()
{
return $this->getField('Title')
?: _t($this->class.'.TITLE', $this->config()->title);
}
@ -139,14 +145,16 @@ class Widget extends DataObject {
* @return string
* @deprecated
*/
public function CMSTitle() {
public function CMSTitle()
{
return $this->getCMSTitle();
}
/**
* @return string
*/
public function getCMSTitle() {
public function getCMSTitle()
{
return _t($this->class.'.CMSTITLE', $this->config()->cmsTitle);
}
@ -154,21 +162,24 @@ class Widget extends DataObject {
* @return string
* @deprecated
*/
public function Description() {
public function Description()
{
return $this->getDescription();
}
/**
* @return string
*/
public function getDescription() {
public function getDescription()
{
return _t($this->class.'.DESCRIPTION', $this->config()->description);
}
/**
* @return string - HTML
*/
public function DescriptionSegment() {
public function DescriptionSegment()
{
return $this->renderWith('WidgetDescription');
}
@ -177,14 +188,16 @@ class Widget extends DataObject {
*
* @return string - HTML
*/
public function EditableSegment() {
public function EditableSegment()
{
return $this->renderWith('WidgetEditor');
}
/**
* @return FieldList
*/
public function getCMSFields() {
public function getCMSFields()
{
$fields = new FieldList(
new TextField('Title', $this->fieldLabel('Title'), null, 255),
new CheckboxField('Enabled', $this->fieldLabel('Enabled'))
@ -196,7 +209,8 @@ class Widget extends DataObject {
/**
* @return FieldList
*/
public function CMSEditor() {
public function CMSEditor()
{
$fields = $this->getCMSFields();
$outputFields = new FieldList();
@ -217,14 +231,16 @@ class Widget extends DataObject {
/**
* @return string
*/
public function ClassName() {
public function ClassName()
{
return $this->class;
}
/**
* @return string
*/
public function Name() {
public function Name()
{
return "Widget[".$this->ID."]";
}
@ -233,7 +249,8 @@ class Widget extends DataObject {
*
* @return WidgetController
*/
public function getController() {
public function getController()
{
if ($this->controller) {
return $this->controller;
}
@ -264,15 +281,15 @@ class Widget extends DataObject {
/**
* @param array $data
*/
public function populateFromPostData($data) {
public function populateFromPostData($data)
{
$fields = $this->getCMSFields();
foreach ($data as $name => $value) {
if ($name != "Type") {
if ($field = $fields->dataFieldByName($name)) {
$field->setValue($value);
$field->saveInto($this);
}
else {
} else {
$this->setField($name, $value);
}
}
@ -293,4 +310,3 @@ class Widget extends DataObject {
$this->write();
}
}

View File

@ -5,8 +5,8 @@
*
* @package widgets
*/
class WidgetArea extends DataObject {
class WidgetArea extends DataObject
{
/**
* @var array
*/
@ -27,7 +27,8 @@ class WidgetArea extends DataObject {
*
* @return SS_List - Collection of {@link WidgetController} instances.
*/
public function WidgetControllers() {
public function WidgetControllers()
{
$controllers = new ArrayList();
foreach ($this->ItemsToRender() as $widget) {
@ -43,14 +44,16 @@ class WidgetArea extends DataObject {
/**
* @return HasManyList
*/
public function Items() {
public function Items()
{
return $this->getComponents('Widgets');
}
/**
* @return HasManyList
*/
public function ItemsToRender() {
public function ItemsToRender()
{
return $this->getComponents('Widgets')
->filter("Enabled", 1);
}
@ -58,7 +61,8 @@ class WidgetArea extends DataObject {
/**
* @return string - HTML
*/
public function forTemplate() {
public function forTemplate()
{
return $this->renderWith($this->template);
}
@ -66,18 +70,19 @@ class WidgetArea extends DataObject {
*
* @param string $template
*/
public function setTemplate($template) {
public function setTemplate($template)
{
$this->template = $template;
}
/**
* Delete all connected Widgets when this WidgetArea gets deleted
*/
public function onBeforeDelete() {
public function onBeforeDelete()
{
parent::onBeforeDelete();
foreach ($this->Widgets() as $widget) {
$widget->delete();
}
}
}

View File

@ -3,7 +3,8 @@
* @package cms
* @subpackage tests
*/
class WidgetAreaEditorTest extends SapphireTest {
class WidgetAreaEditorTest extends SapphireTest
{
/**
* This is the widget you want to use for your unit tests.
*/
@ -22,7 +23,8 @@ class WidgetAreaEditorTest extends SapphireTest {
)
);
function testFillingOneArea() {
public function testFillingOneArea()
{
$data = array(
'Widget' => array(
'BottomBar' => array(
@ -53,7 +55,8 @@ class WidgetAreaEditorTest extends SapphireTest {
$this->assertEquals($page->SideBar()->Widgets()->Count(), 0);
}
function testFillingTwoAreas() {
public function testFillingTwoAreas()
{
$data = array(
'Widget' => array(
'SideBar' => array(
@ -96,7 +99,8 @@ class WidgetAreaEditorTest extends SapphireTest {
$this->assertEquals($bottWidgets[0]->Title(), 'MyTestWidgetBottom');
}
function testDeletingOneWidgetFromOneArea() {
public function testDeletingOneWidgetFromOneArea()
{
// First get some widgets in there
$data = array(
'Widget' => array(
@ -162,7 +166,8 @@ class WidgetAreaEditorTest extends SapphireTest {
$this->assertEquals($page->SideBar()->Widgets()->Count(), 0);
}
function testDeletingAWidgetFromEachArea() {
public function testDeletingAWidgetFromEachArea()
{
// First get some widgets in there
$data = array(
'Widget' => array(
@ -222,7 +227,8 @@ class WidgetAreaEditorTest extends SapphireTest {
$this->assertEquals($page->SideBar()->Widgets()->Count(), 0);
}
function testEditingOneWidget() {
public function testEditingOneWidget()
{
// First get some widgets in there
$data = array(
'Widget' => array(
@ -294,7 +300,8 @@ class WidgetAreaEditorTest extends SapphireTest {
$this->assertEquals($sideWidgets[0]->Title(), 'MyTestWidgetSide-edited');
}
function testEditingAWidgetFromEachArea() {
public function testEditingAWidgetFromEachArea()
{
// First get some widgets in there
$data = array(
'Widget' => array(
@ -366,7 +373,8 @@ class WidgetAreaEditorTest extends SapphireTest {
$this->assertEquals($sideWidgets[0]->Title(), 'MyTestWidgetSide-edited');
}
function testEditAWidgetFromOneAreaAndDeleteAWidgetFromAnotherArea() {
public function testEditAWidgetFromOneAreaAndDeleteAWidgetFromAnotherArea()
{
// First get some widgets in there
$data = array(
'Widget' => array(
@ -434,13 +442,15 @@ class WidgetAreaEditorTest extends SapphireTest {
}
}
class WidgetAreaEditorTest_FakePage extends Page implements TestOnly {
class WidgetAreaEditorTest_FakePage extends Page implements TestOnly
{
private static $has_one = array(
"BottomBar" => "WidgetArea",
);
}
class WidgetAreaEditorTest_TestWidget extends Widget implements TestOnly {
class WidgetAreaEditorTest_TestWidget extends Widget implements TestOnly
{
private static $cmsTitle = "Test widget";
private static $title = "Test widget";
private static $description = "Test widget";

View File

@ -3,8 +3,8 @@
* @package widgets
* @subpackage tests
*/
class WidgetControllerTest extends FunctionalTest {
class WidgetControllerTest extends FunctionalTest
{
protected static $fixture_file = 'WidgetControllerTest.yml';
protected $extraDataObjects = array(
@ -12,7 +12,8 @@ class WidgetControllerTest extends FunctionalTest {
'WidgetControllerTest_Widget',
);
function testWidgetFormRendering() {
public function testWidgetFormRendering()
{
$page = $this->objFromFixture('WidgetControllerTestPage', 'page1');
$page->publish('Stage', 'Live');
@ -28,7 +29,8 @@ class WidgetControllerTest extends FunctionalTest {
);
}
function testWidgetFormSubmission() {
public function testWidgetFormSubmission()
{
$page = $this->objFromFixture('WidgetControllerTestPage', 'page1');
$page->publish('Stage', 'Live');
@ -54,7 +56,8 @@ class WidgetControllerTest extends FunctionalTest {
* @package widgets
* @subpackage tests
*/
class WidgetControllerTest_Widget extends Widget implements TestOnly {
class WidgetControllerTest_Widget extends Widget implements TestOnly
{
private static $db = array(
'TestValue' => 'Text'
);
@ -64,13 +67,14 @@ class WidgetControllerTest_Widget extends Widget implements TestOnly {
* @package widgets
* @subpackage tests
*/
class WidgetControllerTest_WidgetController extends WidgetController implements TestOnly {
class WidgetControllerTest_WidgetController extends WidgetController implements TestOnly
{
private static $allowed_actions = array(
'Form'
);
function Form() {
public function Form()
{
$widgetform = new Form(
$this,
'Form',
@ -85,7 +89,8 @@ class WidgetControllerTest_WidgetController extends WidgetController implements
return $widgetform;
}
function doAction($data, $form) {
public function doAction($data, $form)
{
return sprintf('TestValue: %s\nWidget ID: %d',
$data['TestValue'],
$this->widget->ID

View File

@ -3,7 +3,8 @@
* @package cms
* @subpackage tests
*/
class WidgetControllerTestPage extends Page implements TestOnly {
class WidgetControllerTestPage extends Page implements TestOnly
{
private static $has_one = array(
'WidgetControllerTestSidebar' => 'WidgetArea'
);
@ -13,13 +14,14 @@ class WidgetControllerTestPage extends Page implements TestOnly {
* @package cms
* @subpackage tests
*/
class WidgetControllerTestPage_Controller extends Page_Controller implements TestOnly {
class WidgetControllerTestPage_Controller extends Page_Controller implements TestOnly
{
/**
* Template selection doesnt work in test folders,
* so we enforce a template name.
*/
function getViewer($action) {
public function getViewer($action)
{
$templates = array('WidgetControllerTestPage');
return new SSViewer($templates);