|
Perforce Chronicle 2012.2/486814
API Documentation
|
Manages user-interactions with widgets. More...
Public Member Functions | |
| addAction () | |
| Add the posted widget to the posted region. | |
| configureAction () | |
| Get the config form for the given widget. | |
| deleteAction () | |
| Delete the posted widget. | |
| formAction () | |
| Renders the config form for the requested widget. | |
| indexAction () | |
| Render the specified widget id. | |
| init () | |
| Prepare the widget view with context data. | |
| resetAction () | |
| Restore the default widgets. | |
Public Attributes | |
| $contexts | |
Protected Member Functions | |
| _getConfigForm ($widget) | |
| Get the general widget config form with this widget's sub-form added in if one is provided. | |
Manages user-interactions with widgets.
| Widget_IndexController::_getConfigForm | ( | $ | widget | ) | [protected] |
Get the general widget config form with this widget's sub-form added in if one is provided.
| P4Cms_Widget | $widget | the widget model being configured |
{
$form = new Widget_Form_Config;
// try to get custom sub-form for this widget.
try {
$type = $widget->getType();
$subForm = call_user_func(
array($type->getControllerClassName(), "getConfigSubForm"),
$widget,
$this->getRequest()
);
// ensure sub-form is valid.
if ($subForm instanceof Zend_Form_SubForm) {
$subForm->setLegend($type->label . ' Options');
$subForm->addDecorator('Fieldset')->addDecorator('DtDdWrapper');
$form->addSubForm($subForm, 'config', 2);
} else if ($subForm !== null) {
P4Cms_Log::log(
"Widget (" . $type->getId() . ") produced an invalid config sub-form.",
P4Cms_Log::ERR
);
}
} catch (Exception $e) {
P4Cms_Log::logException(
"Failed to get widget config sub-form from '" . $type->getControllerClassName() . "'.",
$e
);
}
// prep form
$form->setAttrib('id', 'form');
$form->setIdPrefix('widget-' . $widget->id . '-config-');
return $form;
}
| Widget_IndexController::addAction | ( | ) |
Add the posted widget to the posted region.
Responds with the id of the newly added widget.
{
// enforce permissions.
$this->acl->check('widgets', 'manage');
// if request was posted, perform add.
// otherwise, present list of widgets to add.
$request = $this->getRequest();
if ($request->isPost()) {
// enforce json context
$this->contextSwitch->initContext('json');
$widget = P4Cms_Widget::factory($request->type);
$widget->setValue('region', $request->region)
->save();
// clear any cached entries related to this region
P4Cms_Cache::clean(
Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG,
array('p4cms_region', 'p4cms_region_' . bin2hex($request->region))
);
$this->view->widget = $widget;
} else {
// enforce partial context
$this->contextSwitch->initContext('partial');
$this->view->types = P4Cms_Widget_Type::fetchAll();
}
}
| Widget_IndexController::configureAction | ( | ) |
Get the config form for the given widget.
{
// default to partial context.
if (!$this->contextSwitch->getCurrentContext()) {
$this->contextSwitch->initContext('partial');
}
// enforce permissions.
$this->acl->check('widgets', 'manage');
// get the widget to be configured and its config form.
$request = $this->getRequest();
$widget = P4Cms_Widget::fetch($request->widget);
$type = $widget->getType();
$form = $this->_getConfigForm($widget);
// setup view
$this->view->form = $form;
// populate form from request if posted, otherwise from storage.
if ($request->isPost()) {
$form->populate($request->getPost());
} else {
$values = $widget->toArray();
$values['widget'] = $widget->id;
if (isset($values['config']) && $values['config'] instanceof Zend_Config) {
$values['config'] = $values['config']->toArray();
}
$form->populate($values);
}
// if form has been posted and is valid, save form values to widget.
// otherwise, populate form from widget and render form.
if ($request->isPost() && $form->isValid($request->getPost())) {
// call the widgets controller to do any final touchups and save.
call_user_func(
array($type->getControllerClassName(), 'saveConfigForm'),
$form,
$widget
);
// clear any cached entries related to this region or widget
P4Cms_Cache::clean(
Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG,
array(
'p4cms_region',
'p4cms_region_' . bin2hex($widget->getValue('region')),
'p4cms_widget_' . bin2hex($widget->getId())
)
);
}
}
| Widget_IndexController::deleteAction | ( | ) |
Delete the posted widget.
{
// enforce permissions.
$this->acl->check('widgets', 'manage');
// disable rendering for this action.
$this->_helper->viewRenderer->setNoRender();
$this->_helper->layout->disableLayout();
// only respond to post requests.
$request = $this->getRequest();
if (!$request->isPost()) {
throw new P4Cms_Widget_Exception(
'Cannot delete widget. Request was not a valid HTTP POST.'
);
}
// do the delete.
$widget = P4Cms_Widget::fetch($request->widget);
$region = $widget->getValue('region');
$widget->delete("Deleted widget");
// clear any cached entries related to this region
P4Cms_Cache::clean(
Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG,
array(
'p4cms_region',
'p4cms_region_' . bin2hex($region),
'p4cms_widget_' . bin2hex($widget->getId())
)
);
}
| Widget_IndexController::formAction | ( | ) |
Renders the config form for the requested widget.
Forces the 'partial' request context. Though the form is populated it is not validated.
Intended for refreshing the form to update fields that depend on user supplied values.
{
// explicitly set partial context for all requests.
$this->contextSwitch->initContext('partial');
// enforce permissions.
$this->acl->check('widgets', 'manage');
// get the widget to be configured and its config form.
$request = $this->getRequest();
$widget = P4Cms_Widget::fetch($request->widget);
$type = $widget->getType();
$form = $this->_getConfigForm($widget);
// populate the form
$form->populate($request->getParams());
// setup view
$this->view->form = $form;
}
| Widget_IndexController::indexAction | ( | ) |
Render the specified widget id.
{
// force partial context.
$this->contextSwitch->initContext('partial');
// fetch requested widget and render.
$request = $this->getRequest();
$widget = P4Cms_Widget::fetch($request->widget);
$this->view->widget = $widget;
}
| Widget_IndexController::init | ( | ) |
Prepare the widget view with context data.
{
parent::init();
// handle any provided widgetContext
$this->widgetContext->setEncodedValues($this->getRequest()->getParam('widgetContext'));
// make the widget context available to the view
$this->view->widgetContext = $this->widgetContext->getEncodedValues();
$this->getHelper('audit')->addLoggedParams(array('widget', 'region', 'type'));
}
| Widget_IndexController::resetAction | ( | ) |
Restore the default widgets.
{
// enforce permissions.
$this->acl->check('widgets', 'manage');
// clean out existing widgets
P4Cms_Widget::fetchAll()->invoke('delete');
// re-install default types
P4Cms_Widget::installDefaults();
P4Cms_Notifications::add(
'Widgets Reset',
P4Cms_Notifications::SEVERITY_SUCCESS
);
$this->redirector->gotoUrl($this->getRequest()->getBaseUrl());
}
| Widget_IndexController::$contexts |
array(
'index' => array('partial'),
'add' => array('partial', 'json'),
'configure' => array('partial', 'dojoio'),
'form' => array('partial')
)