aboutsummaryrefslogtreecommitdiff
path: root/engine/lib
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-19 02:12:32 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-19 02:12:32 +0000
commit373ff03a2b6315eea13a97065774972ad3713ab6 (patch)
treedf051d2a4c1d150fd75b2f3db2d4647a5e1ebda9 /engine/lib
parent06f0e7b1aa5f6fd393d9a0b580f94709e29e10df (diff)
downloadelgg-373ff03a2b6315eea13a97065774972ad3713ab6.tar.gz
elgg-373ff03a2b6315eea13a97065774972ad3713ab6.tar.bz2
Fixes #2753: Default widgets merged into core as extensible admin section and updated to work with new widgets. Will need an upgrade for users running the old default widgets in 1.7.
git-svn-id: http://code.elgg.org/elgg/trunk@8302 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib')
-rw-r--r--engine/lib/views.php28
-rw-r--r--engine/lib/widgets.php100
2 files changed, 107 insertions, 21 deletions
diff --git a/engine/lib/views.php b/engine/lib/views.php
index 918ca6446..c26e96dd5 100644
--- a/engine/lib/views.php
+++ b/engine/lib/views.php
@@ -393,7 +393,7 @@ function elgg_view($view, $vars = array(), $bypass = false, $debug = false, $vie
if (!isset($vars['url'])) {
$vars['url'] = elgg_get_site_url();
}
-
+
// internalname => name (1.8)
if (isset($vars['internalname'])) {
elgg_deprecated_notice('You should pass $vars[\'name\'] now instead of $vars[\'internalname\']', 1.8);
@@ -401,7 +401,7 @@ function elgg_view($view, $vars = array(), $bypass = false, $debug = false, $vie
} elseif (isset($vars['name'])) {
$vars['internalname'] = $vars['name'];
}
-
+
// internalid => id (1.8)
if (isset($vars['internalid'])) {
elgg_deprecated_notice('You should pass $vars[\'id\'] now instead of $vars[\'internalid\']', 1.8);
@@ -637,8 +637,8 @@ function elgg_view_page($title, $body, $page_shell = 'default', $vars = array())
* filter_context => string (selected content filter)
* See the content layout view for more parameters
*
- * @param string $layout The name of the view in page/layouts/.
- * @param array $vars Associative array of parameters for the layout view
+ * @param string $layout_name The name of the view in page/layouts/.
+ * @param array $vars Associative array of parameters for the layout view
*
* @return string The layout
*/
@@ -667,11 +667,11 @@ function elgg_view_layout($layout_name, $vars = array()) {
* Render a menu
*
* @param string $menu_name The name of the menu
- * @param array $vars An associative array of display options for the menu.
- * Options include:
- * sort_by => string or php callback
- * string options: 'name', 'title' (default), 'order' (registration order)
- * php callback: a compare function for usort
+ * @param array $vars An associative array of display options for the menu.
+ * Options include:
+ * sort_by => string or php callback
+ * string options: 'name', 'title' (default), 'order' (registration order)
+ * php callback: a compare function for usort
*
* @return string
* @since 1.8.0
@@ -797,7 +797,7 @@ function elgg_view_entity(ElggEntity $entity, $full = false, $bypass = true, $de
* the icon/$type/default view.
*
* @param ElggEntity $entity The entity to display
- * @param string $string The size: tiny, small, medium, large
+ * @param string $size The size: tiny, small, medium, large
* @param array $vars An array of variables to pass to the view
*
* @return string HTML to display or false
@@ -1148,9 +1148,9 @@ function elgg_view_likes($entity) {
*
* This is a shortcut for {@elgg_view page/components/image_block}.
*
- * @param string $image The icon and other information
- * @param string $body Description content
- * @param string $vars Additional parameters for the view
+ * @param string $image The icon and other information
+ * @param string $body Description content
+ * @param string $vars Additional parameters for the view
*
* @return string
* @since 1.8.0
@@ -1452,6 +1452,8 @@ function autoregister_views($view_base, $folder, $base_location_path, $viewtype)
/**
* Add the core Elgg head elements that could be cached
+ *
+ * @return void
*/
function elgg_views_register_core_head_elements() {
$url = elgg_get_simplecache_url('js', 'elgg');
diff --git a/engine/lib/widgets.php b/engine/lib/widgets.php
index 8310e83cc..6cca2a18d 100644
--- a/engine/lib/widgets.php
+++ b/engine/lib/widgets.php
@@ -16,7 +16,7 @@
*
* @param int $user_guid The owner user GUID
* @param string $context The context (profile, dashboard, etc)
- *
+ *
* @return array An 2D array of ElggWidget objects
* @since 1.8.0
*/
@@ -26,7 +26,8 @@ function elgg_get_widgets($user_guid, $context) {
'subtype' => 'widget',
'owner_guid' => $user_guid,
'private_setting_name' => 'context',
- 'private_setting_value' => $context
+ 'private_setting_value' => $context,
+ 'limit' => 0
);
$widgets = elgg_get_entities_from_private_settings($options);
if (!$widgets) {
@@ -54,7 +55,7 @@ function elgg_get_widgets($user_guid, $context) {
* @param int $entity_guid GUID of entity that owns this widget
* @param string $handler The handler for this widget
* @param int $access_id If not specified, it is set to the default access level
- *
+ *
* @return int|false Widget GUID or false on failure
* @since 1.8.0
*/
@@ -134,7 +135,7 @@ function elgg_can_edit_widget_layout($context, $user_guid = 0) {
* widget is allowed (default: 'all')
* @param bool $multiple Whether or not multiple instances of this widget
* are allowed in a single layout (default: false)
- *
+ *
* @return bool
* @since 1.8.0
*/
@@ -168,7 +169,7 @@ function elgg_register_widget_type($handler, $name, $description, $context = "al
* Remove a widget type
*
* @param string $handler The identifier for the widget
- *
+ *
* @return void
* @since 1.8.0
*/
@@ -192,7 +193,7 @@ function elgg_unregister_widget_type($handler) {
* Has a widget type with the specified handler been registered
*
* @param string $handler The widget handler identifying string
- *
+ *
* @return bool Whether or not that widget type exists
* @since 1.8.0
*/
@@ -217,7 +218,7 @@ function elgg_is_widget_type($handler) {
*
* @param string $context The widget context or empty string for current context
* @param bool $exact Only return widgets registered for this context (false)
- *
+ *
* @return array
* @since 1.8.0
*/
@@ -274,4 +275,87 @@ function elgg_widgets_init() {
run_function_once("elgg_widget_run_once");
}
-elgg_register_event_handler('init', 'system', 'elgg_widgets_init'); \ No newline at end of file
+/**
+ * Gets a list of events to create default widgets for and
+ * register menu items for default widgets with the admin section.
+ *
+ * @return void
+ */
+function elgg_default_widgets_init() {
+ global $CONFIG;
+ $default_widgets = elgg_trigger_plugin_hook('get_list', 'default_widgets', null, array());
+
+ $CONFIG->default_widget_info = $default_widgets;
+
+ if ($default_widgets) {
+ elgg_add_admin_menu_item('default_widgets', elgg_echo('admin:appearance:default_widgets'), 'appearance', 30);
+
+ foreach ($default_widgets as $info) {
+ elgg_register_event_handler($info['event'], $info['entity_type'], 'elgg_default_widgets_hook');
+ }
+ }
+}
+
+/**
+ * Checks for plugins who have registered default widgets and
+ * hooks into events to save.
+ *
+ * @param string $event The event
+ * @param string $type The type of object
+ * @param object $object The object
+ * @return null
+ */
+function elgg_default_widgets_hook($event, $type, $object) {
+ $default_widget_info = elgg_get_config('default_widget_info');
+
+ if (!$default_widget_info) {
+ return null;
+ }
+
+ $subtype = $object->getSubtype();
+
+ // event is already guaranteed by the hook registration.
+ // need to check subtype and type.
+ foreach ($default_widget_info as $temp) {
+ if ($temp['entity_type'] == $type && $temp['entity_subtype'] == $subtype) {
+ $info = $temp;
+ break;
+ }
+ }
+
+ // pull in by widget context with widget owners as the site
+ // not using elgg_get_widgets() because it sorts by columns and we don't care right now.
+ $options = array(
+ 'type' => 'object',
+ 'subtype' => 'widget',
+ 'owner_guid' => elgg_get_site_entity()->guid,
+ 'private_setting_name' => 'context',
+ 'private_setting_value' => $info['context'],
+ 'limit' => 0
+ );
+
+ $widgets = elgg_get_entities_from_private_settings($options);
+
+ foreach ($widgets as $widget) {
+ // change the container and owner
+ $new_widget = clone $widget;
+ $new_widget->container_guid = $object->guid;
+ $new_widget->owner_guid = $object->guid;
+
+ // pull in settings
+ $settings = get_all_private_settings($widget->guid);
+
+ foreach ($settings as $name => $value) {
+ $new_widget->$name = $value;
+ }
+
+ $new_widget->save();
+ }
+
+ // failure here shouldn't stop the event.
+ return null;
+}
+
+elgg_register_event_handler('init', 'system', 'elgg_widgets_init');
+// register default widget hooks from plugins
+elgg_register_event_handler('ready', 'system', 'elgg_default_widgets_init'); \ No newline at end of file