Elgg  Version 1.10
views.php
Go to the documentation of this file.
1 <?php
57 
70 function elgg_set_viewtype($viewtype = "") {
72 
73  $CURRENT_SYSTEM_VIEWTYPE = $viewtype;
74 
75  return true;
76 }
77 
91 function elgg_get_viewtype() {
93 
94  if ($CURRENT_SYSTEM_VIEWTYPE != "") {
96  }
97 
98  $viewtype = get_input('view', '', false);
100  return $viewtype;
101  }
102 
103  if (isset($CONFIG->view) && _elgg_is_valid_viewtype($CONFIG->view)) {
104  return $CONFIG->view;
105  }
106 
107  return 'default';
108 }
109 
117  global $CONFIG;
118 
119  if (!isset($CONFIG->view_types) || !is_array($CONFIG->view_types)) {
120  $CONFIG->view_types = array();
121  }
122 
123  if (!in_array($viewtype, $CONFIG->view_types)) {
124  $CONFIG->view_types[] = $viewtype;
125  }
126 
127  return true;
128 }
129 
139  global $CONFIG;
140 
141  if (!isset($CONFIG->view_types) || !is_array($CONFIG->view_types)) {
142  return false;
143  }
144 
145  return in_array($viewtype, $CONFIG->view_types);
146 }
147 
148 
159  if (!is_string($viewtype) || $viewtype === '') {
160  return false;
161  }
162 
163  if (preg_match('/\W/', $viewtype)) {
164  return false;
165  }
166 
167  return true;
168 }
169 
182  _elgg_services()->views->registerViewtypeFallback($viewtype);
183 }
184 
194  return _elgg_services()->views->doesViewtypeFallback($viewtype);
195 }
196 
210 }
211 
221 }
222 
231 function elgg_register_external_view($view, $cacheable = false) {
232  global $CONFIG;
233 
234  if (!isset($CONFIG->allowed_ajax_views)) {
235  $CONFIG->allowed_ajax_views = array();
236  }
237 
238  $CONFIG->allowed_ajax_views[$view] = true;
239 
240  if ($cacheable) {
241  _elgg_services()->views->registerCacheableView($view);
242  }
243 }
244 
254  return _elgg_services()->views->isCacheableView($view);
255 }
256 
265  global $CONFIG;
266 
267  if (isset($CONFIG->allowed_ajax_views[$view])) {
268  unset($CONFIG->allowed_ajax_views[$view]);
269  }
270 }
271 
284  return _elgg_services()->views->getViewLocation($view, $viewtype);
285 }
286 
303 function elgg_set_view_location($view, $location, $viewtype = '') {
304  _elgg_services()->views->setViewLocation($view, $location, $viewtype);
305 }
306 
318 function elgg_view_exists($view, $viewtype = '', $recurse = true) {
319  return _elgg_services()->views->viewExists($view, $viewtype, $recurse);
320 }
321 
354 function elgg_view($view, $vars = array(), $bypass = false, $ignored = false, $viewtype = '') {
355  return _elgg_services()->views->renderView($view, $vars, $bypass, $viewtype);
356 }
357 
371 function elgg_view_deprecated($view, array $vars, $suggestion, $version) {
372  return _elgg_services()->views->renderDeprecatedView($view, $vars, $suggestion, $version);
373 }
374 
401 function elgg_extend_view($view, $view_extension, $priority = 501, $viewtype = '') {
402  _elgg_services()->views->extendView($view, $view_extension, $priority, $viewtype);
403 }
404 
414 function elgg_unextend_view($view, $view_extension) {
415  return _elgg_services()->views->unextendView($view, $view_extension);
416 }
417 
437 function elgg_view_page($title, $body, $page_shell = 'default', $vars = array()) {
438 
439  $params = array();
440  $params['identifier'] = _elgg_services()->request->getFirstUrlSegment();
441  $params['segments'] = _elgg_services()->request->getUrlSegments();
442  array_shift($params['segments']);
443  $page_shell = elgg_trigger_plugin_hook('shell', 'page', $params, $page_shell);
444 
445  $messages = null;
446  if (count_messages()) {
447  // get messages - try for errors first
448  $messages = system_messages(null, "error");
449  if (count($messages["error"]) == 0) {
450  // no errors so grab rest of messages
451  $messages = system_messages(null, "");
452  } else {
453  // we have errors - clear out remaining messages
454  system_messages(null, "");
455  }
456  }
457 
458  $vars['title'] = $title;
459  $vars['body'] = $body;
460  $vars['sysmessages'] = $messages;
461 
462  // head has keys 'title', 'metas', 'links'
463  $head_params = _elgg_views_prepare_head($title);
464 
465  $vars['head'] = elgg_trigger_plugin_hook('head', 'page', $vars, $head_params);
466 
467  $vars = elgg_trigger_plugin_hook('output:before', 'page', null, $vars);
468 
469  // check for deprecated view
470  if ($page_shell == 'default' && elgg_view_exists('pageshells/pageshell')) {
471  elgg_deprecated_notice("pageshells/pageshell is deprecated by page/$page_shell", 1.8);
472  $output = elgg_view('pageshells/pageshell', $vars);
473  } else {
474  $output = elgg_view("page/$page_shell", $vars);
475  }
476 
477  $vars['page_shell'] = $page_shell;
478 
479  // Allow plugins to modify the output
480  return elgg_trigger_plugin_hook('output', 'page', $vars, $output);
481 }
482 
491  $params = array(
492  'links' => array(),
493  'metas' => array(),
494  );
495 
496  if (empty($title)) {
497  $params['title'] = elgg_get_config('sitename');
498  } else {
499  $params['title'] = $title . ' : ' . elgg_get_config('sitename');
500  }
501 
502  $params['metas']['content-type'] = array(
503  'http-equiv' => 'Content-Type',
504  'content' => 'text/html; charset=utf-8',
505  );
506 
507  $params['metas']['description'] = array(
508  'name' => 'description',
509  'content' => elgg_get_config('sitedescription')
510  );
511 
512  // https://developer.chrome.com/multidevice/android/installtohomescreen
513  $params['metas']['viewport'] = array(
514  'name' => 'viewport',
515  'content' => 'width=device-width',
516  );
517  $params['metas']['mobile-web-app-capable'] = array(
518  'name' => 'mobile-web-app-capable',
519  'content' => 'yes',
520  );
521  $params['metas']['apple-mobile-web-app-capable'] = array(
522  'name' => 'apple-mobile-web-app-capable',
523  'content' => 'yes',
524  );
525  $params['links']['apple-touch-icon'] = array(
526  'rel' => 'apple-touch-icon',
527  'href' => elgg_normalize_url('_graphics/favicon-128.png'),
528  );
529 
530  // favicons
531  $params['links']['icon-ico'] = array(
532  'rel' => 'icon',
533  'href' => elgg_normalize_url('_graphics/favicon.ico'),
534  );
535  $params['links']['icon-vector'] = array(
536  'rel' => 'icon',
537  'sizes' => '16x16 32x32 48x48 64x64 128x128',
538  'type' => 'image/svg+xml',
539  'href' => elgg_normalize_url('_graphics/favicon.svg'),
540  );
541  $params['links']['icon-16'] = array(
542  'rel' => 'icon',
543  'sizes' => '16x16',
544  'type' => 'image/png',
545  'href' => elgg_normalize_url('_graphics/favicon-16.png'),
546  );
547  $params['links']['icon-32'] = array(
548  'rel' => 'icon',
549  'sizes' => '32x32',
550  'type' => 'image/png',
551  'href' => elgg_normalize_url('_graphics/favicon-32.png'),
552  );
553  $params['links']['icon-64'] = array(
554  'rel' => 'icon',
555  'sizes' => '64x64',
556  'type' => 'image/png',
557  'href' => elgg_normalize_url('_graphics/favicon-64.png'),
558  );
559  $params['links']['icon-128'] = array(
560  'rel' => 'icon',
561  'sizes' => '128x128',
562  'type' => 'image/png',
563  'href' => elgg_normalize_url('_graphics/favicon-128.png'),
564  );
565 
566  // RSS feed link
567  global $autofeed;
568  if (isset($autofeed) && $autofeed == true) {
570  if (substr_count($url,'?')) {
571  $url .= "&view=rss";
572  } else {
573  $url .= "?view=rss";
574  }
575  $params['links']['rss'] = array(
576  'rel' => 'alternative',
577  'type' => 'application/rss+xml',
578  'title' => 'RSS',
579  'href' => elgg_format_url($url),
580  );
581  }
582 
583  return $params;
584 }
585 
618 function elgg_view_layout($layout_name, $vars = array()) {
619 
620  $params = array();
621  $params['identifier'] = _elgg_services()->request->getFirstUrlSegment();
622  $params['segments'] = _elgg_services()->request->getUrlSegments();
623  array_shift($params['segments']);
624  $layout_name = elgg_trigger_plugin_hook('layout', 'page', $params, $layout_name);
625 
626  if (is_string($vars) || $vars === null) {
627  elgg_deprecated_notice("The use of unlimited optional string arguments in elgg_view_layout() was deprecated in favor of an options array", 1.8);
628  $arg = 1;
629  $param_array = array();
630  while ($arg < func_num_args()) {
631  $param_array['area' . $arg] = func_get_arg($arg);
632  $arg++;
633  }
634  } else {
635  $param_array = $vars;
636  }
637  $param_array['layout'] = $layout_name;
638 
639  $params = elgg_trigger_plugin_hook('output:before', 'layout', null, $param_array);
640 
641  // check deprecated location
642  if (elgg_view_exists("canvas/layouts/$layout_name")) {
643  elgg_deprecated_notice("canvas/layouts/$layout_name is deprecated by page/layouts/$layout_name", 1.8);
644  $output = elgg_view("canvas/layouts/$layout_name", $params);
645  } elseif (elgg_view_exists("page/layouts/$layout_name")) {
646  $output = elgg_view("page/layouts/$layout_name", $params);
647  } else {
648  $output = elgg_view("page/layouts/default", $params);
649  }
650 
651  return elgg_trigger_plugin_hook('output:after', 'layout', $params, $output);
652 }
653 
688 function elgg_view_menu($menu_name, array $vars = array()) {
689  global $CONFIG;
690 
691  $vars['name'] = $menu_name;
692 
693  $sort_by = elgg_extract('sort_by', $vars, 'text');
694 
695  if (isset($CONFIG->menus[$menu_name])) {
696  $menu = $CONFIG->menus[$menu_name];
697  } else {
698  $menu = array();
699  }
700 
701  // Give plugins a chance to add menu items just before creation.
702  // This supports dynamic menus (example: user_hover).
703  $menu = elgg_trigger_plugin_hook('register', "menu:$menu_name", $vars, $menu);
704 
705  $builder = new \ElggMenuBuilder($menu);
706  $vars['menu'] = $builder->getMenu($sort_by);
707  $vars['selected_item'] = $builder->getSelected();
708 
709  // Let plugins modify the menu
710  $vars['menu'] = elgg_trigger_plugin_hook('prepare', "menu:$menu_name", $vars, $vars['menu']);
711 
712  if (elgg_view_exists("navigation/menu/$menu_name")) {
713  return elgg_view("navigation/menu/$menu_name", $vars);
714  } else {
715  return elgg_view("navigation/menu/default", $vars);
716  }
717 }
718 
727 function elgg_view_menu_item(\ElggMenuItem $item, array $vars = array()) {
728  if (!isset($vars['class'])) {
729  $vars['class'] = 'elgg-menu-content';
730  }
731 
732  $vars = array_merge($item->getValues(), $vars);
733 
734  if ($item->getLinkClass()) {
735  $vars['class'] .= ' ' . $item->getLinkClass();
736  }
737 
738  if ($item->getHref() === false || $item->getHref() === null) {
739  $text = $item->getText();
740 
741  // if contains elements, don't wrap
742  if (preg_match('~<[a-z]~', $text)) {
743  return $text;
744  } else {
745  return elgg_format_element('span', array('class' => 'elgg-non-link'), $text);
746  }
747  }
748 
749  if (!isset($vars['rel']) && !isset($vars['is_trusted'])) {
750  $vars['is_trusted'] = true;
751  }
752 
753  if ($item->getConfirmText()) {
754  $vars['confirm'] = $item->getConfirmText();
755  }
756 
757  return elgg_view('output/url', $vars);
758 }
759 
788 function elgg_view_entity(\ElggEntity $entity, $vars = array(), $bypass = false, $debug = false) {
789 
790  // No point continuing if entity is null
791  if (!$entity || !($entity instanceof \ElggEntity)) {
792  return false;
793  }
794 
795  global $autofeed;
796  $autofeed = true;
797 
798  $defaults = array(
799  'full_view' => true,
800  );
801 
802  if (is_array($vars)) {
803  $vars = array_merge($defaults, $vars);
804  } else {
805  elgg_deprecated_notice("Update your use of elgg_view_entity()", 1.8);
806  $vars = array(
807  'full_view' => $vars,
808  );
809  }
810 
811  $vars['entity'] = $entity;
812 
813 
814  // if this entity has a view defined, use it
815  $view = $entity->view;
816  if (is_string($view)) {
817  return elgg_view($view, $vars, $bypass, $debug);
818  }
819 
820  $entity_type = $entity->getType();
821 
822  $subtype = $entity->getSubtype();
823  if (empty($subtype)) {
824  $subtype = 'default';
825  }
826 
827  $contents = '';
828  if (elgg_view_exists("$entity_type/$subtype")) {
829  $contents = elgg_view("$entity_type/$subtype", $vars, $bypass, $debug);
830  } else {
831  $contents = elgg_view("$entity_type/default", $vars, $bypass, $debug);
832  }
833 
834  // Marcus Povey 20090616 : Speculative and low impact approach for fixing #964
835  if ($vars['full_view']) {
836  $annotations = elgg_view_entity_annotations($entity, $vars['full_view']);
837 
838  if ($annotations) {
840  }
841  }
842  return $contents;
843 }
844 
860 function elgg_view_entity_icon(\ElggEntity $entity, $size = 'medium', $vars = array()) {
861 
862  // No point continuing if entity is null
863  if (!$entity || !($entity instanceof \ElggEntity)) {
864  return false;
865  }
866 
867  $vars['entity'] = $entity;
868  $vars['size'] = $size;
869 
870  $entity_type = $entity->getType();
871 
872  $subtype = $entity->getSubtype();
873  if (empty($subtype)) {
874  $subtype = 'default';
875  }
876 
877  $contents = '';
878  if (elgg_view_exists("icon/$entity_type/$subtype")) {
879  $contents = elgg_view("icon/$entity_type/$subtype", $vars);
880  }
881  if (empty($contents)) {
882  $contents = elgg_view("icon/$entity_type/default", $vars);
883  }
884  if (empty($contents)) {
885  $contents = elgg_view("icon/default", $vars);
886  }
887 
888  return $contents;
889 }
890 
911 function elgg_view_annotation(\ElggAnnotation $annotation, array $vars = array(), $bypass = false, $debug = false) {
912  global $autofeed;
913  $autofeed = true;
914 
915  $defaults = array(
916  'full_view' => true,
917  );
918 
919  $vars = array_merge($defaults, $vars);
920  $vars['annotation'] = $annotation;
921 
922  // @todo setting the view on an annotation is not advertised anywhere
923  // do we want to keep this?
924  $view = $annotation->view;
925  if (is_string($view)) {
926  return elgg_view($view, $vars, $bypass, $debug);
927  }
928 
929  $name = $annotation->name;
930  if (empty($name)) {
931  return false;
932  }
933 
934  if (elgg_view_exists("annotation/$name")) {
935  return elgg_view("annotation/$name", $vars, $bypass, $debug);
936  } else {
937  return elgg_view("annotation/default", $vars, $bypass, $debug);
938  }
939 }
940 
967 function elgg_view_entity_list($entities, $vars = array(), $offset = 0, $limit = null, $full_view = true,
968 $list_type_toggle = true, $pagination = true) {
969 
970  if (!is_int($offset)) {
971  $offset = (int)get_input('offset', 0);
972  }
973 
974  // list type can be passed as request parameter
975  $list_type = get_input('list_type', 'list');
976  if (get_input('listtype')) {
977  elgg_deprecated_notice("'listtype' has been deprecated by 'list_type' for lists", 1.8);
978  $list_type = get_input('listtype');
979  }
980 
981  if (is_array($vars)) {
982  // new function
983  $defaults = array(
984  'items' => $entities,
985  'list_class' => 'elgg-list-entity',
986  'full_view' => true,
987  'pagination' => true,
988  'list_type' => $list_type,
989  'list_type_toggle' => false,
990  'offset' => $offset,
991  'limit' => null,
992  );
993 
994  $vars = array_merge($defaults, $vars);
995 
996  } else {
997  // old function parameters
998  elgg_deprecated_notice("Please update your use of elgg_view_entity_list()", 1.8);
999 
1000  if ($limit === null) {
1001  $limit = elgg_get_config('default_limit');
1002  }
1003 
1004  $vars = array(
1005  'items' => $entities,
1006  'count' => (int) $vars, // the old count parameter
1007  'offset' => $offset,
1008  'limit' => (int) $limit,
1009  'full_view' => $full_view,
1010  'pagination' => $pagination,
1011  'list_type' => $list_type,
1012  'list_type_toggle' => $list_type_toggle,
1013  'list_class' => 'elgg-list-entity',
1014  );
1015  }
1016 
1017  if (!$vars["limit"] && !$vars["offset"]) {
1018  // no need for pagination if listing is unlimited
1019  $vars["pagination"] = false;
1020  }
1021 
1022  if ($vars['list_type'] != 'list') {
1023  return elgg_view('page/components/gallery', $vars);
1024  } else {
1025  return elgg_view('page/components/list', $vars);
1026  }
1027 }
1028 
1046 function elgg_view_annotation_list($annotations, array $vars = array()) {
1047  $defaults = array(
1048  'items' => $annotations,
1049  'offset' => null,
1050  'limit' => null,
1051  'list_class' => 'elgg-list-annotation elgg-annotation-list', // @todo remove elgg-annotation-list in Elgg 1.9
1052  'full_view' => true,
1053  'offset_key' => 'annoff',
1054  );
1055 
1056  $vars = array_merge($defaults, $vars);
1057 
1058  if (!$vars["limit"] && !$vars["offset"]) {
1059  // no need for pagination if listing is unlimited
1060  $vars["pagination"] = false;
1061  }
1062 
1063  return elgg_view('page/components/list', $vars);
1064 }
1065 
1081  if (!($entity instanceof \ElggEntity)) {
1082  return false;
1083  }
1084 
1085  $entity_type = $entity->getType();
1086 
1087  $annotations = elgg_trigger_plugin_hook('entity:annotate', $entity_type,
1088  array(
1089  'entity' => $entity,
1090  'full_view' => $full_view,
1091  )
1092  );
1093 
1094  return $annotations;
1095 }
1096 
1107 function elgg_view_title($title, $vars = array()) {
1108  if (!is_array($vars)) {
1109  elgg_deprecated_notice('setting $submenu in elgg_view_title() is deprecated', 1.8);
1110  $vars = array('submenu' => $vars);
1111  }
1112 
1113  $vars['title'] = $title;
1114 
1115  return elgg_view('page/elements/title', $vars);
1116 }
1117 
1128 function elgg_view_friendly_time($time) {
1129  return elgg_view('output/friendlytime', array('time' => $time));
1130 }
1131 
1132 
1146 function elgg_view_comments($entity, $add_comment = true, array $vars = array()) {
1147  if (!($entity instanceof \ElggEntity)) {
1148  return false;
1149  }
1150 
1151  $vars['entity'] = $entity;
1152  $vars['show_add_form'] = $add_comment;
1153  $vars['class'] = elgg_extract('class', $vars, "{$entity->getSubtype()}-comments");
1154 
1155  $output = elgg_trigger_plugin_hook('comments', $entity->getType(), $vars, false);
1156  if ($output) {
1157  return $output;
1158  } else {
1159  return elgg_view('page/elements/comments', $vars);
1160  }
1161 }
1162 
1178 function elgg_view_image_block($image, $body, $vars = array()) {
1179  $vars['image'] = $image;
1180  $vars['body'] = $body;
1181  return elgg_view('page/components/image_block', $vars);
1182 }
1183 
1199 function elgg_view_module($type, $title, $body, array $vars = array()) {
1200  $vars['type'] = $type;
1201  $vars['class'] = elgg_extract('class', $vars, '');
1202  $vars['title'] = $title;
1203  $vars['body'] = $body;
1204  return elgg_view('page/components/module', $vars);
1205 }
1206 
1215 function elgg_view_river_item($item, array $vars = array()) {
1216  if (!($item instanceof \ElggRiverItem)) {
1217  return '';
1218  }
1219  // checking default viewtype since some viewtypes do not have unique views per item (rss)
1220  $view = $item->getView();
1221  if (!$view || !elgg_view_exists($view, 'default')) {
1222  return '';
1223  }
1224 
1225  $subject = $item->getSubjectEntity();
1226  $object = $item->getObjectEntity();
1227  if (!$subject || !$object) {
1228  // subject is disabled or subject/object deleted
1229  return '';
1230  }
1231 
1232  // @todo this needs to be cleaned up
1233  // Don't hide objects in closed groups that a user can see.
1234  // see https://github.com/elgg/elgg/issues/4789
1235  // else {
1236  // // hide based on object's container
1237  // $visibility = \Elgg\GroupItemVisibility::factory($object->container_guid);
1238  // if ($visibility->shouldHideItems) {
1239  // return '';
1240  // }
1241  // }
1242 
1243  $vars['item'] = $item;
1244 
1245  return elgg_view('river/item', $vars);
1246 }
1247 
1282 function elgg_view_form($action, $form_vars = array(), $body_vars = array()) {
1283  global $CONFIG;
1284 
1285  $defaults = array(
1286  'action' => $CONFIG->wwwroot . "action/$action",
1287  'body' => elgg_view("forms/$action", $body_vars)
1288  );
1289 
1290  $form_class = 'elgg-form-' . preg_replace('/[^a-z0-9]/i', '-', $action);
1291 
1292  // append elgg-form class to any class options set
1293  if (isset($form_vars['class'])) {
1294  $form_vars['class'] = $form_vars['class'] . " $form_class";
1295  } else {
1296  $form_vars['class'] = $form_class;
1297  }
1298 
1299  $form_vars = array_merge($defaults, $form_vars);
1300  $form_vars['action_name'] = $action;
1301 
1302  return elgg_view('input/form', $form_vars);
1303 }
1304 
1319 function elgg_view_tagcloud(array $options = array()) {
1320 
1321  $type = $subtype = '';
1322  if (isset($options['type'])) {
1323  $type = $options['type'];
1324  }
1325  if (isset($options['subtype'])) {
1326  $subtype = $options['subtype'];
1327  }
1328 
1329  $tag_data = elgg_get_tags($options);
1330  return elgg_view("output/tagcloud", array(
1331  'value' => $tag_data,
1332  'type' => $type,
1333  'subtype' => $subtype,
1334  ));
1335 }
1336 
1347 function elgg_view_list_item($item, array $vars = array()) {
1348  global $CONFIG;
1349 
1350  $type = $item->getType();
1351  if (in_array($type, $CONFIG->entity_types)) {
1352  return elgg_view_entity($item, $vars);
1353  } else if ($type == 'annotation') {
1354  return elgg_view_annotation($item, $vars);
1355  } else if ($type == 'river') {
1356  return elgg_view_river_item($item, $vars);
1357  }
1358 
1359  return '';
1360 }
1361 
1372 function elgg_view_icon($name, $class = '') {
1373  if ($class === true) {
1374  elgg_deprecated_notice("Using a boolean to float the icon is deprecated. Use the class float.", 1.9);
1375  $class = 'float';
1376  }
1377 
1378  $icon_class = array("elgg-icon-$name" , $class);
1379 
1380  return elgg_view("output/icon", array("class" => $icon_class));
1381 }
1382 
1393  if ($collections = get_user_access_collections($owner_guid)) {
1395  if ($user) {
1396  $entities = $user->getFriends(array('limit' => 0));
1397  } else {
1398  $entities = array();
1399  }
1400 
1401  foreach ($collections as $key => $collection) {
1402  $collections[$key]->members = get_members_of_access_collection($collection->id, true);
1403  $collections[$key]->entities = $entities;
1404  }
1405  }
1406 
1407  return elgg_view('core/friends/collections', array('collections' => $collections));
1408 }
1409 
1430 function set_template_handler($function_name) {
1431  global $CONFIG;
1432 
1433  if (is_callable($function_name)) {
1434  $CONFIG->template_handler = $function_name;
1435  return true;
1436  }
1437  return false;
1438 }
1439 
1457 function autoregister_views($view_base, $folder, $base_location_path, $viewtype) {
1458  return _elgg_services()->views->autoregisterViews($view_base, $folder, $base_location_path, $viewtype);
1459 }
1460 
1473  if (preg_match('~[\.-]min\.~', $params['view'])) {
1474  // bypass minification
1475  return;
1476  }
1477 
1478  if ($type == 'js') {
1479  if (elgg_get_config('simplecache_minify_js')) {
1480  return JSMin::minify($content);
1481  }
1482  } elseif ($type == 'css') {
1483  if (elgg_get_config('simplecache_minify_css')) {
1484  $cssmin = new CSSmin();
1485  return $cssmin->run($content);
1486  }
1487  }
1488 }
1489 
1490 
1503  $filter = new \Elgg\Amd\ViewFilter();
1504  return $filter->filter($params['view'], $content);
1505 }
1506 
1514  global $autofeed;
1515  if (isset($autofeed) && $autofeed == true) {
1516  $url = current_page_url();
1517  if (substr_count($url, '?')) {
1518  $url .= "&view=rss";
1519  } else {
1520  $url .= "?view=rss";
1521  }
1522 
1524  elgg_register_menu_item('extras', array(
1525  'name' => 'rss',
1526  'text' => elgg_view_icon('rss'),
1527  'href' => $url,
1528  'title' => elgg_echo('feed:rss'),
1529  ));
1530  }
1531 }
1532 
1539  header('X-Frame-Options: SAMEORIGIN');
1540 }
1541 
1548  $removed_views = array(
1549  "1.10" => array(
1550  'core/settings/tools',
1551  ),
1552  );
1553 
1554  $views_svc = _elgg_services()->views;
1555  foreach ($removed_views as $version => $names) {
1556  foreach ($names as $name) {
1557  if ($views_svc->viewExists($name)) {
1558  elgg_deprecated_notice("The view $name is no longer used and should not be provided or extended.", $version);
1559  }
1560  }
1561  }
1562 }
1563 
1571  $location = elgg_get_view_location('page_elements/contentwrapper');
1572  if ($location === "/var/www/views/") {
1573  elgg_extend_view('page_elements/contentwrapper', 'page/elements/wrapper');
1574  }
1575 }
1576 
1585 function elgg_views_boot() {
1586  global $CONFIG;
1587 
1589 
1590  elgg_register_simplecache_view('js/text.js');
1591 
1592  elgg_register_js('elgg.require_config', elgg_get_simplecache_url('js', 'elgg/require_config'), 'head');
1593  elgg_register_js('require', '/vendors/requirejs/require-2.1.10.min.js', 'head');
1594  elgg_register_js('jquery', '/vendors/jquery/jquery-1.11.0.min.js', 'head');
1595  elgg_register_js('jquery-migrate', '/vendors/jquery/jquery-migrate-1.2.1.min.js', 'head');
1596  elgg_register_js('jquery-ui', '/vendors/jquery/jquery-ui-1.10.4.min.js', 'head');
1597 
1598  // this is the only lib that isn't required to be loaded sync in head
1599  elgg_define_js('jquery.form', array(
1600  'src' => '/vendors/jquery/jquery.form.min.js',
1601  'deps' => array('jquery'),
1602  'exports' => 'jQuery.fn.ajaxForm',
1603  ));
1604 
1605  $elgg_js_url = elgg_get_simplecache_url('js', 'elgg');
1606  elgg_register_js('elgg', $elgg_js_url, 'head');
1607 
1608  elgg_load_js('elgg.require_config');
1609  elgg_load_js('require');
1610  elgg_load_js('jquery');
1611  elgg_load_js('jquery-migrate');
1612  elgg_load_js('jquery-ui');
1613  elgg_load_js('elgg');
1614 
1615  $lightbox_js_url = elgg_get_simplecache_url('js', 'lightbox');
1616  elgg_register_js('lightbox', $lightbox_js_url);
1617 
1618  elgg_register_css('lightbox', 'vendors/jquery/colorbox/theme/colorbox.css');
1619 
1620  $elgg_css_url = elgg_get_simplecache_url('css', 'elgg');
1621  elgg_register_css('elgg', $elgg_css_url);
1622 
1623  elgg_load_css('elgg');
1624 
1625  elgg_register_ajax_view('js/languages');
1626 
1627  elgg_register_plugin_hook_handler('simplecache:generate', 'js', '_elgg_views_amd');
1628  elgg_register_plugin_hook_handler('simplecache:generate', 'css', '_elgg_views_minify');
1629  elgg_register_plugin_hook_handler('simplecache:generate', 'js', '_elgg_views_minify');
1630 
1631  elgg_register_plugin_hook_handler('output:before', 'layout', 'elgg_views_add_rss_link');
1632  elgg_register_plugin_hook_handler('output:before', 'page', '_elgg_views_send_header_x_frame_options');
1633 
1634  // discover the core viewtypes
1635  // @todo the cache is loaded in load_plugins() but we need to know viewtypes earlier
1636  $view_path = $CONFIG->viewpath;
1637  $viewtype_dirs = scandir($view_path);
1638  foreach ($viewtype_dirs as $viewtype) {
1639  if (_elgg_is_valid_viewtype($viewtype) && is_dir($view_path . $viewtype)) {
1640  elgg_register_viewtype($viewtype);
1641  }
1642  }
1643 
1644  // set default icon sizes - can be overridden in settings.php or with plugin
1645  if (!isset($CONFIG->icon_sizes)) {
1646  $icon_sizes = array(
1647  'topbar' => array('w' => 16, 'h' => 16, 'square' => true, 'upscale' => true),
1648  'tiny' => array('w' => 25, 'h' => 25, 'square' => true, 'upscale' => true),
1649  'small' => array('w' => 40, 'h' => 40, 'square' => true, 'upscale' => true),
1650  'medium' => array('w' => 100, 'h' => 100, 'square' => true, 'upscale' => true),
1651  'large' => array('w' => 200, 'h' => 200, 'square' => false, 'upscale' => false),
1652  'master' => array('w' => 550, 'h' => 550, 'square' => false, 'upscale' => false),
1653  );
1654  elgg_set_config('icon_sizes', $icon_sizes);
1655  }
1656 }
1657 
1658 elgg_register_event_handler('boot', 'system', 'elgg_views_boot');
1659 elgg_register_event_handler('init', 'system', 'elgg_views_handle_deprecated_views');
1660 elgg_register_event_handler('ready', 'system', '_elgg_views_deprecate_removed_views');
$messages
Definition: admin.php:27
elgg_get_config($name, $site_guid=0)
Get an Elgg configuration value.
$view
Definition: crop.php:68
getSubtype()
Get the entity subtype.
elgg_is_registered_viewtype($viewtype)
Checks if $viewtype is registered.
Definition: views.php:138
get_input($variable, $default=null, $filter_result=true)
Get some input from variables passed submitted through GET or POST.
Definition: input.php:27
elgg_view_icon($name, $class= '')
View one of the elgg sprite icons.
Definition: views.php:1372
elgg_get_tags(array $options=array())
Get popular tags and their frequencies.
Definition: tags.php:71
$subject
Definition: exceptions.php:25
_elgg_is_valid_viewtype($viewtype)
Checks if $viewtype is a string suitable for use as a viewtype name.
Definition: views.php:158
elgg_view_module($type, $title, $body, array $vars=array())
Wrapper function for the module display pattern.
Definition: views.php:1199
$annotation
Elgg default annotation view.
Definition: default.php:10
elgg_normalize_url($url)
Definition: output.php:311
if($guid==elgg_get_logged_in_user_guid()) $name
Definition: delete.php:21
elgg_define_js($name, $config)
Defines a JS lib as an AMD module.
Definition: elgglib.php:152
if($footer) $contents
Definition: module.php:48
current_page_url()
Returns the current page&#39;s complete URL.
Definition: input.php:65
$size
Definition: view.php:10
set_template_handler($function_name)
Registers a function to handle templates.
Definition: views.php:1430
$object
Definition: upgrade.php:12
elgg_view_entity_annotations(\ElggEntity $entity, $full_view=true)
Display a plugin-specified rendered list of annotations for an entity.
Definition: views.php:1080
elgg_view_tagcloud(array $options=array())
Create a tagcloud for viewing.
Definition: views.php:1319
if(elgg_in_context('widget')) $offset
Definition: pagination.php:20
elgg_register_simplecache_view($view_name)
Registers a view to simple cache.
Definition: cache.php:98
$full_view
Elgg comment view.
Definition: comment.php:9
getLinkClass()
Get the anchor classes as text.
elgg_register_external_view($view, $cacheable=false)
Registers a view as being available externally (i.e.
Definition: views.php:231
Elgg Annotations.
elgg_view_exists($view, $viewtype= '', $recurse=true)
Returns whether the specified view exists.
Definition: views.php:318
elgg_register_css($name, $url, $priority=null)
Register a CSS file for inclusion in the HTML head.
Definition: elgglib.php:228
if(!$autoload_available) _elgg_services()
Definition: autoloader.php:20
_elgg_views_amd($hook, $type, $content, $params)
Inserts module names into anonymous modules by handling the "simplecache:generate" hook...
Definition: views.php:1502
$pagination
Definition: gallery.php:24
elgg_view_annotation_list($annotations, array $vars=array())
Returns a rendered list of annotations, plus pagination.
Definition: views.php:1046
elgg_register_viewtype_fallback($viewtype)
Register a viewtype to fall back to a default view if a view isn&#39;t found for that viewtype...
Definition: views.php:181
$collection
elgg_extract($key, array $array, $default=null, $strict=true)
Checks for $array[$key] and returns its value if it exists, else returns $default.
Definition: elgglib.php:1349
elgg_register_plugin_hook_handler($hook, $type, $callback, $priority=500)
Register a callback as a plugin hook handler.
Definition: elgglib.php:737
elgg_get_view_location($view, $viewtype= '')
Returns the file location for a view.
Definition: views.php:283
if(isset($vars['id'])) $class
Definition: ajax_loader.php:19
$url
Definition: exceptions.php:24
elgg_views_handle_deprecated_views()
Registers deprecated views to avoid making some pages from older plugins completely empty...
Definition: views.php:1570
elgg_unregister_external_view($view)
Unregister a view for ajax calls.
Definition: views.php:264
$title
Definition: save.php:24
$action
elgg_format_element($tag_name, array $attributes=array(), $text= '', array $options=array())
Format an HTML element.
Definition: output.php:215
autoregister_views($view_base, $folder, $base_location_path, $viewtype)
Auto-registers views from a location.
Definition: views.php:1457
_elgg_views_deprecate_removed_views()
Checks for usage of core views that have been removed.
Definition: views.php:1547
$params
Definition: login.php:72
elgg_view_list_item($item, array $vars=array())
View an item in a list.
Definition: views.php:1347
$options
Definition: index.php:14
$text
Definition: default.php:25
_elgg_views_minify($hook, $type, $content, $params)
Minifies simplecache CSS and JS views by handling the "simplecache:generate" hook.
Definition: views.php:1472
elgg_view_menu($menu_name, array $vars=array())
Render a menu.
Definition: views.php:688
$owner_guid
getConfirmText()
Get the confirm text.
get_user_access_collections($owner_guid, $site_guid=0)
Returns an array of database row objects of the access collections owned by $owner_guid.
Definition: access.php:402
elgg_unregister_ajax_view($view)
Unregister a view for ajax calls.
Definition: views.php:219
elgg_load_css($name)
Load a CSS file for this page.
Definition: elgglib.php:255
$limit
Definition: userpicker.php:33
elgg_register_js($name, $url, $location= 'head', $priority=null)
Register a JavaScript file for inclusion.
Definition: elgglib.php:127
elgg_set_viewtype($viewtype="")
Manually set the viewtype.
Definition: views.php:70
elgg_get_viewtype()
Return the current view type.
Definition: views.php:91
elgg_views_add_rss_link()
Add the rss link to the extras when if needed.
Definition: views.php:1513
elgg_view_annotation(\ElggAnnotation $annotation, array $vars=array(), $bypass=false, $debug=false)
Returns a string of a rendered annotation.
Definition: views.php:911
elgg_echo($message_key, $args=array(), $language="")
Given a message key, returns an appropriately translated full-text string.
Definition: languages.php:21
elgg_get_simplecache_url($type, $view)
Definition: cache.php:117
elgg_view_friendly_time($time)
Displays a UNIX timestamp in a friendly way.
Definition: views.php:1128
$key
Definition: summary.php:34
get_user($guid)
Get a user object from a GUID.
Definition: users.php:87
elgg_set_view_location($view, $location, $viewtype= '')
Set an alternative base location for a view.
Definition: views.php:303
elgg_unextend_view($view, $view_extension)
Unextends a view.
Definition: views.php:414
get_members_of_access_collection($collection, $idonly=false)
Get all of members of an access collection.
Definition: access.php:415
elgg_view_image_block($image, $body, $vars=array())
Wrapper function for the image block display pattern.
Definition: views.php:1178
elgg_set_config($name, $value)
Set an Elgg configuration value.
$item
Definition: item.php:12
global $CURRENT_SYSTEM_VIEWTYPE
Elgg&#39;s view system.
Definition: views.php:55
elgg_does_viewtype_fallback($viewtype)
Checks if a viewtype falls back to default.
Definition: views.php:193
global $CONFIG
_elgg_is_view_cacheable($view)
Check whether a view is registered as cacheable.
Definition: views.php:253
if(!file_exists($filename)) $icon_sizes
Definition: crop.php:31
elgg_view_deprecated($view, array $vars, $suggestion, $version)
Display a view with a deprecation notice.
Definition: views.php:371
if(!$vars['title']&&$vars['title']!==false) if(isset($vars['filter_override'])) if(!isset($vars['filter'])&&elgg_is_logged_in()&&$context) $filter
Definition: content.php:62
elgg_extend_view($view, $view_extension, $priority=501, $viewtype= '')
Extends a view with another view.
Definition: views.php:401
$user
Definition: ban.php:13
$body_vars
$annotations
Definition: entity.php:20
elgg_trigger_plugin_hook($hook, $type, $params=null, $returnvalue=null)
Trigger a Plugin Hook and run all handler callbacks registered to that hook:type. ...
Definition: elgglib.php:809
elgg_deprecated_notice($msg, $dep_version, $backtrace_level=1)
Sends a notice about deprecated use of a function, view, etc.
Definition: elgglib.php:1055
elgg global
Pointer to the global context.
Definition: elgglib.js:12
$type
Definition: add.php:8
elgg_register_menu_item($menu_name, $menu_item)
Register an item for an Elgg menu.
Definition: navigation.php:92
elgg_view($view, $vars=array(), $bypass=false, $ignored=false, $viewtype= '')
Return a parsed view.
Definition: views.php:354
if(!elgg_instanceof($comment, 'object', 'comment')||!$comment->canEdit()) $form_vars
system_messages($message=null, $register="success", $count=false)
Queues a message to be displayed.
Definition: elgglib.php:416
elgg_view_layout($layout_name, $vars=array())
Displays a layout with optional parameters.
Definition: views.php:618
elgg_register_event_handler($event, $object_type, $callback, $priority=500)
Register a callback as an Elgg event handler.
Definition: elgglib.php:553
$builder
Definition: save.php:12
getText()
Get the display text of the menu item.
_elgg_views_send_header_x_frame_options()
Sends X-Frame-Options header on page requests.
Definition: views.php:1538
_elgg_views_prepare_head($title)
Prepare the variables for the html head.
Definition: views.php:490
elgg_view_menu_item(\ElggMenuItem $item, array $vars=array())
Render a menu item (usually as a link)
Definition: views.php:727
elgg_load_js($name)
Load a JavaScript resource on this page.
Definition: elgglib.php:189
elgg_view_title($title, $vars=array())
Renders a title.
Definition: views.php:1107
getType()
Returns the entity type.
elgg_register_ajax_view($view)
Register a view to be available for ajax calls.
Definition: views.php:208
$content
Set robots.txt action.
Definition: set_robots.php:6
elgg_view_comments($entity, $add_comment=true, array $vars=array())
Returns rendered comments and a comment form for an entity.
Definition: views.php:1146
elgg_view_entity(\ElggEntity $entity, $vars=array(), $bypass=false, $debug=false)
Returns a string of a rendered entity.
Definition: views.php:788
elgg_format_url($url)
Handles formatting of ampersands in urls.
Definition: output.php:105
if(isset($vars['item_class'])) $icon_class
Definition: tags.php:47
elgg_view_access_collections($owner_guid)
Displays a user&#39;s access collections, using the core/friends/collections view.
Definition: views.php:1392
elgg_view_page($title, $body, $page_shell= 'default', $vars=array())
Assembles and outputs a full page.
Definition: views.php:437
$menu
Definition: default.php:19
clearfix elgg elgg elgg elgg page header
Definition: admin.php:127
$output
Definition: item.php:10
$defaults
Definition: access.php:19
$entity
Definition: delete.php:10
elgg_view_entity_list($entities, $vars=array(), $offset=0, $limit=null, $full_view=true, $list_type_toggle=true, $pagination=true)
Returns a rendered list of entities with pagination.
Definition: views.php:967
$subtype
Definition: river.php:12
elgg_view_entity_icon(\ElggEntity $entity, $size= 'medium', $vars=array())
View the icon of an entity.
Definition: views.php:860
$version
Definition: version.php:14
elgg_view_form($action, $form_vars=array(), $body_vars=array())
Definition: views.php:1282
$viewtype
Definition: start.php:76
elgg_views_boot()
Initialize viewtypes on system boot event This ensures simplecache is cleared during upgrades...
Definition: views.php:1585
$priority
getValues()
Get all the values for this menu item.
count_messages($register="")
Counts the number of messages, either globally or in a particular register.
Definition: elgglib.php:463
getHref()
Get the URL of the menu item.
if(file_exists($welcome)) $vars
Definition: upgrade.php:93
$image
Definition: upload.php:37
elgg_view_river_item($item, array $vars=array())
Renders a human-readable representation of a river item.
Definition: views.php:1215
elgg_register_viewtype($viewtype)
Register a viewtype.
Definition: views.php:116