Elgg  Version 1.12
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 
272 
289 function elgg_set_view_location($view, $location, $viewtype = '') {
290  _elgg_services()->views->setViewLocation($view, $location, $viewtype);
291 }
292 
304 function elgg_view_exists($view, $viewtype = '', $recurse = true) {
305  return _elgg_services()->views->viewExists($view, $viewtype, $recurse);
306 }
307 
340 function elgg_view($view, $vars = array(), $bypass = false, $ignored = false, $viewtype = '') {
341  return _elgg_services()->views->renderView($view, $vars, $bypass, $viewtype);
342 }
343 
357 function elgg_view_deprecated($view, array $vars, $suggestion, $version) {
358  return _elgg_services()->views->renderDeprecatedView($view, $vars, $suggestion, $version);
359 }
360 
387 function elgg_extend_view($view, $view_extension, $priority = 501, $viewtype = '') {
388  _elgg_services()->views->extendView($view, $view_extension, $priority, $viewtype);
389 }
390 
400 function elgg_unextend_view($view, $view_extension) {
401  return _elgg_services()->views->unextendView($view, $view_extension);
402 }
403 
423 function elgg_view_page($title, $body, $page_shell = 'default', $vars = array()) {
424 
425  $params = array();
426  $params['identifier'] = _elgg_services()->request->getFirstUrlSegment();
427  $params['segments'] = _elgg_services()->request->getUrlSegments();
428  array_shift($params['segments']);
429  $page_shell = elgg_trigger_plugin_hook('shell', 'page', $params, $page_shell);
430 
431  $system_messages = _elgg_services()->systemMessages;
432 
433  $messages = null;
434  if ($system_messages->count()) {
435  $messages = $system_messages->dumpRegister();
436 
437  if (isset($messages['error'])) {
438  // always make sure error is the first type
439  $errors = array(
440  'error' => $messages['error']
441  );
442 
443  unset($messages['error']);
444  $messages = array_merge($errors, $messages);
445  }
446  }
447 
448  $vars['title'] = $title;
449  $vars['body'] = $body;
450  $vars['sysmessages'] = $messages;
451 
452  // head has keys 'title', 'metas', 'links'
453  $head_params = _elgg_views_prepare_head($title);
454 
455  $vars['head'] = elgg_trigger_plugin_hook('head', 'page', $vars, $head_params);
456 
457  $vars = elgg_trigger_plugin_hook('output:before', 'page', null, $vars);
458 
459  // check for deprecated view
460  if ($page_shell == 'default' && elgg_view_exists('pageshells/pageshell')) {
461  elgg_deprecated_notice("pageshells/pageshell is deprecated by page/$page_shell", 1.8);
462  $output = elgg_view('pageshells/pageshell', $vars);
463  } else {
464  $output = elgg_view("page/$page_shell", $vars);
465  }
466 
467  $vars['page_shell'] = $page_shell;
468 
469  // Allow plugins to modify the output
470  return elgg_trigger_plugin_hook('output', 'page', $vars, $output);
471 }
472 
481  $params = array(
482  'links' => array(),
483  'metas' => array(),
484  );
485 
486  if (empty($title)) {
487  $params['title'] = elgg_get_config('sitename');
488  } else {
489  $params['title'] = $title . ' : ' . elgg_get_config('sitename');
490  }
491 
492  $params['metas']['content-type'] = array(
493  'http-equiv' => 'Content-Type',
494  'content' => 'text/html; charset=utf-8',
495  );
496 
497  $params['metas']['description'] = array(
498  'name' => 'description',
499  'content' => elgg_get_config('sitedescription')
500  );
501 
502  // https://developer.chrome.com/multidevice/android/installtohomescreen
503  $params['metas']['viewport'] = array(
504  'name' => 'viewport',
505  'content' => 'width=device-width',
506  );
507  $params['metas']['mobile-web-app-capable'] = array(
508  'name' => 'mobile-web-app-capable',
509  'content' => 'yes',
510  );
511  $params['metas']['apple-mobile-web-app-capable'] = array(
512  'name' => 'apple-mobile-web-app-capable',
513  'content' => 'yes',
514  );
515  $params['links']['apple-touch-icon'] = array(
516  'rel' => 'apple-touch-icon',
517  'href' => elgg_normalize_url('_graphics/favicon-128.png'),
518  );
519 
520  // favicons
521  $params['links']['icon-ico'] = array(
522  'rel' => 'icon',
523  'href' => elgg_normalize_url('_graphics/favicon.ico'),
524  );
525  $params['links']['icon-vector'] = array(
526  'rel' => 'icon',
527  'sizes' => '16x16 32x32 48x48 64x64 128x128',
528  'type' => 'image/svg+xml',
529  'href' => elgg_normalize_url('_graphics/favicon.svg'),
530  );
531  $params['links']['icon-16'] = array(
532  'rel' => 'icon',
533  'sizes' => '16x16',
534  'type' => 'image/png',
535  'href' => elgg_normalize_url('_graphics/favicon-16.png'),
536  );
537  $params['links']['icon-32'] = array(
538  'rel' => 'icon',
539  'sizes' => '32x32',
540  'type' => 'image/png',
541  'href' => elgg_normalize_url('_graphics/favicon-32.png'),
542  );
543  $params['links']['icon-64'] = array(
544  'rel' => 'icon',
545  'sizes' => '64x64',
546  'type' => 'image/png',
547  'href' => elgg_normalize_url('_graphics/favicon-64.png'),
548  );
549  $params['links']['icon-128'] = array(
550  'rel' => 'icon',
551  'sizes' => '128x128',
552  'type' => 'image/png',
553  'href' => elgg_normalize_url('_graphics/favicon-128.png'),
554  );
555 
556  // RSS feed link
557  global $autofeed;
558  if (isset($autofeed) && $autofeed == true) {
560  if (substr_count($url,'?')) {
561  $url .= "&view=rss";
562  } else {
563  $url .= "?view=rss";
564  }
565  $params['links']['rss'] = array(
566  'rel' => 'alternative',
567  'type' => 'application/rss+xml',
568  'title' => 'RSS',
569  'href' => elgg_format_url($url),
570  );
571  }
572 
573  return $params;
574 }
575 
608 function elgg_view_layout($layout_name, $vars = array()) {
609 
610  $params = array();
611  $params['identifier'] = _elgg_services()->request->getFirstUrlSegment();
612  $params['segments'] = _elgg_services()->request->getUrlSegments();
613  array_shift($params['segments']);
614  $layout_name = elgg_trigger_plugin_hook('layout', 'page', $params, $layout_name);
615 
616  if (is_string($vars) || $vars === null) {
617  elgg_deprecated_notice("The use of unlimited optional string arguments in elgg_view_layout() was deprecated in favor of an options array", 1.8);
618  $arg = 1;
619  $param_array = array();
620  while ($arg < func_num_args()) {
621  $param_array['area' . $arg] = func_get_arg($arg);
622  $arg++;
623  }
624  } else {
625  $param_array = $vars;
626  }
627  $param_array['layout'] = $layout_name;
628 
629  $params = elgg_trigger_plugin_hook('output:before', 'layout', null, $param_array);
630 
631  // check deprecated location
632  if (elgg_view_exists("canvas/layouts/$layout_name")) {
633  elgg_deprecated_notice("canvas/layouts/$layout_name is deprecated by page/layouts/$layout_name", 1.8);
634  $output = elgg_view("canvas/layouts/$layout_name", $params);
635  } elseif (elgg_view_exists("page/layouts/$layout_name")) {
636  $output = elgg_view("page/layouts/$layout_name", $params);
637  } else {
638  $output = elgg_view("page/layouts/default", $params);
639  }
640 
641  return elgg_trigger_plugin_hook('output:after', 'layout', $params, $output);
642 }
643 
678 function elgg_view_menu($menu_name, array $vars = array()) {
679  global $CONFIG;
680 
681  $vars['name'] = $menu_name;
682 
683  $vars = elgg_trigger_plugin_hook('parameters', "menu:$menu_name", $vars, $vars);
684 
685  $sort_by = elgg_extract('sort_by', $vars, 'text');
686 
687  if (isset($CONFIG->menus[$menu_name])) {
688  $menu = $CONFIG->menus[$menu_name];
689  } else {
690  $menu = array();
691  }
692 
693  // Give plugins a chance to add menu items just before creation.
694  // This supports dynamic menus (example: user_hover).
695  $menu = elgg_trigger_plugin_hook('register', "menu:$menu_name", $vars, $menu);
696 
697  $builder = new \ElggMenuBuilder($menu);
698  $vars['menu'] = $builder->getMenu($sort_by);
699  $vars['selected_item'] = $builder->getSelected();
700 
701  // Let plugins modify the menu
702  $vars['menu'] = elgg_trigger_plugin_hook('prepare', "menu:$menu_name", $vars, $vars['menu']);
703 
704  if (elgg_view_exists("navigation/menu/$menu_name")) {
705  return elgg_view("navigation/menu/$menu_name", $vars);
706  } else {
707  return elgg_view("navigation/menu/default", $vars);
708  }
709 }
710 
719 function elgg_view_menu_item(\ElggMenuItem $item, array $vars = array()) {
720  if (!isset($vars['class'])) {
721  $vars['class'] = 'elgg-menu-content';
722  }
723 
724  $vars = array_merge($item->getValues(), $vars);
725 
726  if ($item->getLinkClass()) {
727  $vars['class'] .= ' ' . $item->getLinkClass();
728  }
729 
730  if ($item->getHref() === false || $item->getHref() === null) {
731  $text = $item->getText();
732 
733  // if contains elements, don't wrap
734  if (preg_match('~<[a-z]~', $text)) {
735  return $text;
736  } else {
737  return elgg_format_element('span', array('class' => 'elgg-non-link'), $text);
738  }
739  }
740 
741  if (!isset($vars['rel']) && !isset($vars['is_trusted'])) {
742  $vars['is_trusted'] = true;
743  }
744 
745  if ($item->getConfirmText()) {
746  $vars['confirm'] = $item->getConfirmText();
747  }
748 
749  return elgg_view('output/url', $vars);
750 }
751 
779 function elgg_view_entity(\ElggEntity $entity, $vars = array(), $bypass = false, $debug = false) {
780 
781  // No point continuing if entity is null
782  if (!$entity || !($entity instanceof \ElggEntity)) {
783  return false;
784  }
785 
786  global $autofeed;
787  $autofeed = true;
788 
789  $defaults = array(
790  'full_view' => true,
791  );
792 
793  if (is_array($vars)) {
794  $vars = array_merge($defaults, $vars);
795  } else {
796  elgg_deprecated_notice("Update your use of elgg_view_entity()", 1.8);
797  $vars = array(
798  'full_view' => $vars,
799  );
800  }
801 
802  $vars['entity'] = $entity;
803 
804  $entity_type = $entity->getType();
805  $entity_subtype = $entity->getSubtype();
806  if (empty($entity_subtype)) {
807  $entity_subtype = 'default';
808  }
809 
810  $entity_views = array(
811  elgg_extract('item_view', $vars, ''),
812  $entity->view,
813  "$entity_type/$entity_subtype",
814  "$entity_type/default",
815  );
816 
817  $contents = '';
818  foreach ($entity_views as $view) {
819  if (elgg_view_exists($view)) {
820  $contents = elgg_view($view, $vars, $bypass, $debug);
821  break;
822  }
823  }
824 
825  // Marcus Povey 20090616 : Speculative and low impact approach for fixing #964
826  if ($vars['full_view']) {
827  $annotations = elgg_view_entity_annotations($entity, $vars['full_view']);
828 
829  if ($annotations) {
831  }
832  }
833  return $contents;
834 }
835 
851 function elgg_view_entity_icon(\ElggEntity $entity, $size = 'medium', $vars = array()) {
852 
853  // No point continuing if entity is null
854  if (!$entity || !($entity instanceof \ElggEntity)) {
855  return false;
856  }
857 
858  $vars['entity'] = $entity;
859  $vars['size'] = $size;
860 
861  $entity_type = $entity->getType();
862 
863  $subtype = $entity->getSubtype();
864  if (empty($subtype)) {
865  $subtype = 'default';
866  }
867 
868  $contents = '';
869  if (elgg_view_exists("icon/$entity_type/$subtype")) {
870  $contents = elgg_view("icon/$entity_type/$subtype", $vars);
871  }
872  if (empty($contents)) {
873  $contents = elgg_view("icon/$entity_type/default", $vars);
874  }
875  if (empty($contents)) {
876  $contents = elgg_view("icon/default", $vars);
877  }
878 
879  return $contents;
880 }
881 
903 function elgg_view_annotation(\ElggAnnotation $annotation, array $vars = array(), $bypass = false, $debug = false) {
904  global $autofeed;
905  $autofeed = true;
906 
907  $defaults = array(
908  'full_view' => true,
909  );
910 
911  $vars = array_merge($defaults, $vars);
912  $vars['annotation'] = $annotation;
913 
914  // @todo setting the view on an annotation is not advertised anywhere
915  // do we want to keep this?
916  $view = $annotation->view;
917  if (is_string($view)) {
918  return elgg_view($view, $vars, $bypass, $debug);
919  }
920 
921  $name = $annotation->name;
922  if (empty($name)) {
923  return false;
924  }
925 
926  $annotation_views = array(
927  elgg_extract('item_view', $vars, ''),
928  "annotation/$name",
929  "annotation/default",
930  );
931 
932  $contents = '';
933  foreach ($annotation_views as $view) {
934  if (elgg_view_exists($view)) {
935  $contents = elgg_view($view, $vars, $bypass, $debug);
936  break;
937  }
938  }
939 
940  return $contents;
941 }
942 
970 function elgg_view_entity_list($entities, $vars = array(), $offset = 0, $limit = null, $full_view = true,
971 $list_type_toggle = true, $pagination = true) {
972 
973  if (!is_int($offset)) {
974  $offset = (int)get_input('offset', 0);
975  }
976 
977  // list type can be passed as request parameter
978  $list_type = get_input('list_type', 'list');
979  if (get_input('listtype')) {
980  elgg_deprecated_notice("'listtype' has been deprecated by 'list_type' for lists", 1.8);
981  $list_type = get_input('listtype');
982  }
983 
984  if (is_array($vars)) {
985  // new function
986  $defaults = array(
987  'items' => $entities,
988  'list_class' => 'elgg-list-entity',
989  'full_view' => true,
990  'pagination' => true,
991  'list_type' => $list_type,
992  'list_type_toggle' => false,
993  'offset' => $offset,
994  'limit' => null,
995  );
996 
997  $vars = array_merge($defaults, $vars);
998 
999  } else {
1000  // old function parameters
1001  elgg_deprecated_notice("Please update your use of elgg_view_entity_list()", 1.8);
1002 
1003  if ($limit === null) {
1004  $limit = elgg_get_config('default_limit');
1005  }
1006 
1007  $vars = array(
1008  'items' => $entities,
1009  'count' => (int) $vars, // the old count parameter
1010  'offset' => $offset,
1011  'limit' => (int) $limit,
1012  'full_view' => $full_view,
1013  'pagination' => $pagination,
1014  'list_type' => $list_type,
1015  'list_type_toggle' => $list_type_toggle,
1016  'list_class' => 'elgg-list-entity',
1017  );
1018  }
1019 
1020  if (!$vars["limit"] && !$vars["offset"]) {
1021  // no need for pagination if listing is unlimited
1022  $vars["pagination"] = false;
1023  }
1024 
1025  if ($vars['list_type'] != 'list') {
1026  return elgg_view('page/components/gallery', $vars);
1027  } else {
1028  return elgg_view('page/components/list', $vars);
1029  }
1030 }
1031 
1050 function elgg_view_annotation_list($annotations, array $vars = array()) {
1051  $defaults = array(
1052  'items' => $annotations,
1053  'offset' => null,
1054  'limit' => null,
1055  'list_class' => 'elgg-list-annotation elgg-annotation-list', // @todo remove elgg-annotation-list in Elgg 1.9
1056  'full_view' => true,
1057  'offset_key' => 'annoff',
1058  );
1059 
1060  $vars = array_merge($defaults, $vars);
1061 
1062  if (!$vars["limit"] && !$vars["offset"]) {
1063  // no need for pagination if listing is unlimited
1064  $vars["pagination"] = false;
1065  }
1066 
1067  return elgg_view('page/components/list', $vars);
1068 }
1069 
1085  if (!($entity instanceof \ElggEntity)) {
1086  return false;
1087  }
1088 
1089  $entity_type = $entity->getType();
1090 
1091  $annotations = elgg_trigger_plugin_hook('entity:annotate', $entity_type,
1092  array(
1093  'entity' => $entity,
1094  'full_view' => $full_view,
1095  )
1096  );
1097 
1098  return $annotations;
1099 }
1100 
1111 function elgg_view_title($title, $vars = array()) {
1112  if (!is_array($vars)) {
1113  elgg_deprecated_notice('setting $submenu in elgg_view_title() is deprecated', 1.8);
1114  $vars = array('submenu' => $vars);
1115  }
1116 
1117  $vars['title'] = $title;
1118 
1119  return elgg_view('page/elements/title', $vars);
1120 }
1121 
1132 function elgg_view_friendly_time($time) {
1133  return elgg_view('output/friendlytime', array('time' => $time));
1134 }
1135 
1136 
1150 function elgg_view_comments($entity, $add_comment = true, array $vars = array()) {
1151  if (!($entity instanceof \ElggEntity)) {
1152  return false;
1153  }
1154 
1155  $vars['entity'] = $entity;
1156  $vars['show_add_form'] = $add_comment;
1157  $vars['class'] = elgg_extract('class', $vars, "{$entity->getSubtype()}-comments");
1158 
1159  $output = elgg_trigger_plugin_hook('comments', $entity->getType(), $vars, false);
1160  if ($output) {
1161  return $output;
1162  } else {
1163  return elgg_view('page/elements/comments', $vars);
1164  }
1165 }
1166 
1182 function elgg_view_image_block($image, $body, $vars = array()) {
1183  $vars['image'] = $image;
1184  $vars['body'] = $body;
1185  return elgg_view('page/components/image_block', $vars);
1186 }
1187 
1203 function elgg_view_module($type, $title, $body, array $vars = array()) {
1204  $vars['type'] = $type;
1205  $vars['title'] = $title;
1206  $vars['body'] = $body;
1207  return elgg_view('page/components/module', $vars);
1208 }
1209 
1218 function elgg_view_river_item($item, array $vars = array()) {
1219  if (!($item instanceof \ElggRiverItem)) {
1220  return '';
1221  }
1222  // checking default viewtype since some viewtypes do not have unique views per item (rss)
1223  $view = $item->getView();
1224  if (!$view || !elgg_view_exists($view, 'default')) {
1225  return '';
1226  }
1227 
1228  $subject = $item->getSubjectEntity();
1229  $object = $item->getObjectEntity();
1230  if (!$subject || !$object) {
1231  // subject is disabled or subject/object deleted
1232  return '';
1233  }
1234 
1235  // @todo this needs to be cleaned up
1236  // Don't hide objects in closed groups that a user can see.
1237  // see https://github.com/elgg/elgg/issues/4789
1238  // else {
1239  // // hide based on object's container
1240  // $visibility = \Elgg\GroupItemVisibility::factory($object->container_guid);
1241  // if ($visibility->shouldHideItems) {
1242  // return '';
1243  // }
1244  // }
1245 
1246  $vars['item'] = $item;
1247 
1248  $river_views = array(
1249  elgg_extract('item_view', $vars, ''),
1250  "river/item",
1251  );
1252 
1253  $contents = '';
1254  foreach ($river_views as $view) {
1255  if (elgg_view_exists($view)) {
1256  $contents = elgg_view($view, $vars);
1257  break;
1258  }
1259  }
1260 
1261  return $contents;
1262 }
1263 
1298 function elgg_view_form($action, $form_vars = array(), $body_vars = array()) {
1299  global $CONFIG;
1300 
1301  $defaults = array(
1302  'action' => $CONFIG->wwwroot . "action/$action",
1303  'body' => elgg_view("forms/$action", $body_vars)
1304  );
1305 
1306  $form_class = 'elgg-form-' . preg_replace('/[^a-z0-9]/i', '-', $action);
1307 
1308  // append elgg-form class to any class options set
1309  if (isset($form_vars['class'])) {
1310  $form_vars['class'] = $form_vars['class'] . " $form_class";
1311  } else {
1312  $form_vars['class'] = $form_class;
1313  }
1314 
1315  $form_vars = array_merge($defaults, $form_vars);
1316  $form_vars['action_name'] = $action;
1317 
1318  return elgg_view('input/form', $form_vars);
1319 }
1320 
1335 function elgg_view_tagcloud(array $options = array()) {
1336 
1337  $type = $subtype = '';
1338  if (isset($options['type'])) {
1339  $type = $options['type'];
1340  }
1341  if (isset($options['subtype'])) {
1342  $subtype = $options['subtype'];
1343  }
1344 
1345  $tag_data = elgg_get_tags($options);
1346  return elgg_view("output/tagcloud", array(
1347  'value' => $tag_data,
1348  'type' => $type,
1349  'subtype' => $subtype,
1350  ));
1351 }
1352 
1363 function elgg_view_list_item($item, array $vars = array()) {
1364 
1365  if ($item instanceof \ElggEntity) {
1366  return elgg_view_entity($item, $vars);
1367  } else if ($item instanceof \ElggAnnotation) {
1368  return elgg_view_annotation($item, $vars);
1369  } else if ($item instanceof \ElggRiverItem) {
1370  return elgg_view_river_item($item, $vars);
1371  }
1372 
1373  return '';
1374 }
1375 
1388 function elgg_view_icon($name, $vars = array()) {
1389  if (empty($vars)) {
1390  $vars = array();
1391  }
1392 
1393  if ($vars === true) {
1394  elgg_deprecated_notice("Using a boolean to float the icon is deprecated. Use the class float.", 1.9);
1395  $vars = array('class' => 'float');
1396  }
1397 
1398  if (is_string($vars)) {
1399  $vars = array('class' => $vars);
1400  }
1401 
1402  if (!is_array($vars)) {
1403  throw new \InvalidArgumentException('$vars needs to be a string or an array');
1404  }
1405 
1406  if (!array_key_exists('class', $vars)) {
1407  $vars['class'] = array();
1408  }
1409 
1410  if (!is_array($vars['class'])) {
1411  $vars['class'] = array($vars['class']);
1412  }
1413 
1414  $vars['class'][] = "elgg-icon-$name";
1415 
1416  return elgg_view("output/icon", $vars);
1417 }
1418 
1429  if ($collections = get_user_access_collections($owner_guid)) {
1431  if ($user) {
1432  $entities = $user->getFriends(array('limit' => 0));
1433  } else {
1434  $entities = array();
1435  }
1436 
1437  foreach ($collections as $key => $collection) {
1438  $collections[$key]->members = get_members_of_access_collection($collection->id, true);
1439  $collections[$key]->entities = $entities;
1440  }
1441  }
1442 
1443  return elgg_view('core/friends/collections', array('collections' => $collections));
1444 }
1445 
1463 function autoregister_views($view_base, $folder, $base_location_path, $viewtype) {
1464  return _elgg_services()->views->autoregisterViews($view_base, $folder, $base_location_path, $viewtype);
1465 }
1466 
1479  if (preg_match('~[\.-]min\.~', $params['view'])) {
1480  // bypass minification
1481  return;
1482  }
1483 
1484  if ($type == 'js') {
1485  if (elgg_get_config('simplecache_minify_js')) {
1486  return JSMin::minify($content);
1487  }
1488  } elseif ($type == 'css') {
1489  if (elgg_get_config('simplecache_minify_css')) {
1490  $cssmin = new CSSmin();
1491  return $cssmin->run($content);
1492  }
1493  }
1494 }
1495 
1496 
1509  $filter = new \Elgg\Amd\ViewFilter();
1510  return $filter->filter($params['view'], $content);
1511 }
1512 
1520  global $autofeed;
1521  if (isset($autofeed) && $autofeed == true) {
1522  $url = current_page_url();
1523  if (substr_count($url, '?')) {
1524  $url .= "&view=rss";
1525  } else {
1526  $url .= "?view=rss";
1527  }
1528 
1530  elgg_register_menu_item('extras', array(
1531  'name' => 'rss',
1532  'text' => elgg_view_icon('rss'),
1533  'href' => $url,
1534  'title' => elgg_echo('feed:rss'),
1535  ));
1536  }
1537 }
1538 
1545  header('X-Frame-Options: SAMEORIGIN');
1546 }
1547 
1554  $removed_views = array(
1555  "1.10" => array(
1556  'core/settings/tools',
1557  ),
1558  );
1559 
1560  $views_svc = _elgg_services()->views;
1561  foreach ($removed_views as $version => $names) {
1562  foreach ($names as $name) {
1563  if ($views_svc->viewExists($name)) {
1564  elgg_deprecated_notice("The view $name is no longer used and should not be provided or extended.", $version);
1565  }
1566  }
1567  }
1568 }
1569 
1577  $location = _elgg_services()->views->getViewLocation('page_elements/contentwrapper');
1578  if ($location === "/var/www/views/") {
1579  elgg_extend_view('page_elements/contentwrapper', 'page/elements/wrapper');
1580  }
1581 }
1582 
1591 function elgg_views_boot() {
1592  global $CONFIG;
1593 
1595 
1596  elgg_register_simplecache_view('js/text.js');
1597 
1598  elgg_register_js('elgg.require_config', elgg_get_simplecache_url('js', 'elgg/require_config'), 'head');
1599  elgg_register_js('require', '/vendors/requirejs/require-2.1.10.min.js', 'head');
1600  elgg_register_js('jquery', '/vendors/jquery/jquery-1.11.0.min.js', 'head');
1601  elgg_register_js('jquery-migrate', '/vendors/jquery/jquery-migrate-1.2.1.min.js', 'head');
1602  elgg_register_js('jquery-ui', '/vendors/jquery/jquery-ui-1.10.4.min.js', 'head');
1603 
1604  // this is the only lib that isn't required to be loaded sync in head
1605  elgg_define_js('jquery.form', array(
1606  'src' => '/vendors/jquery/jquery.form.min.js',
1607  'deps' => array('jquery'),
1608  'exports' => 'jQuery.fn.ajaxForm',
1609  ));
1610  elgg_define_js('jquery.ui', array(
1611  'src' => '/vendors/jquery/jquery-ui-1.10.4.min.js',
1612  'deps' => array('jquery'),
1613  ));
1614 
1615  $elgg_js_url = elgg_get_simplecache_url('js', 'elgg');
1616  elgg_register_js('elgg', $elgg_js_url, 'head');
1617 
1618  elgg_load_js('elgg.require_config');
1619  elgg_load_js('require');
1620  elgg_load_js('jquery');
1621  elgg_load_js('jquery-migrate');
1622  elgg_load_js('jquery-ui');
1623  elgg_load_js('elgg');
1624 
1625  $lightbox_js_url = elgg_get_simplecache_url('js', 'lightbox');
1626  elgg_register_js('lightbox', $lightbox_js_url);
1627 
1628  elgg_register_css('lightbox', 'vendors/jquery/colorbox/theme/colorbox.css');
1629 
1630  $elgg_css_url = elgg_get_simplecache_url('css', 'elgg');
1631  elgg_register_css('elgg', $elgg_css_url);
1632 
1633  elgg_load_css('elgg');
1634 
1635  elgg_register_ajax_view('js/languages');
1636 
1637  elgg_register_plugin_hook_handler('simplecache:generate', 'js', '_elgg_views_amd');
1638  elgg_register_plugin_hook_handler('simplecache:generate', 'css', '_elgg_views_minify');
1639  elgg_register_plugin_hook_handler('simplecache:generate', 'js', '_elgg_views_minify');
1640 
1641  elgg_register_plugin_hook_handler('output:before', 'layout', 'elgg_views_add_rss_link');
1642  elgg_register_plugin_hook_handler('output:before', 'page', '_elgg_views_send_header_x_frame_options');
1643 
1644  // discover the core viewtypes
1645  // @todo the cache is loaded in load_plugins() but we need to know viewtypes earlier
1646  $view_path = $CONFIG->viewpath;
1647  $viewtype_dirs = scandir($view_path);
1648  foreach ($viewtype_dirs as $viewtype) {
1649  if (_elgg_is_valid_viewtype($viewtype) && is_dir($view_path . $viewtype)) {
1650  elgg_register_viewtype($viewtype);
1651  }
1652  }
1653 
1654  // set default icon sizes - can be overridden in settings.php or with plugin
1655  if (!isset($CONFIG->icon_sizes)) {
1656  $icon_sizes = array(
1657  'topbar' => array('w' => 16, 'h' => 16, 'square' => true, 'upscale' => true),
1658  'tiny' => array('w' => 25, 'h' => 25, 'square' => true, 'upscale' => true),
1659  'small' => array('w' => 40, 'h' => 40, 'square' => true, 'upscale' => true),
1660  'medium' => array('w' => 100, 'h' => 100, 'square' => true, 'upscale' => true),
1661  'large' => array('w' => 200, 'h' => 200, 'square' => false, 'upscale' => false),
1662  'master' => array('w' => 550, 'h' => 550, 'square' => false, 'upscale' => false),
1663  );
1664  elgg_set_config('icon_sizes', $icon_sizes);
1665  }
1666 }
1667 
1668 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
1669  $events->registerHandler('boot', 'system', 'elgg_views_boot');
1670  $events->registerHandler('init', 'system', 'elgg_views_handle_deprecated_views');
1671  $events->registerHandler('ready', 'system', '_elgg_views_deprecate_removed_views');
1672 };
$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_get_tags(array $options=array())
Get popular tags and their frequencies.
Definition: tags.php:78
$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:1203
$annotation
Elgg default annotation view.
Definition: default.php:10
elgg_normalize_url($url)
Definition: output.php:311
elgg_view_icon($name, $vars=array())
View one of the elgg sprite icons.
Definition: views.php:1388
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:166
if($footer) $contents
Definition: module.php:44
current_page_url()
Returns the current page&#39;s complete URL.
Definition: input.php:65
$size
Definition: view.php:10
$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:1084
$defaults
elgg_view_tagcloud(array $options=array())
Create a tagcloud for viewing.
Definition: views.php:1335
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_view_exists($view, $viewtype= '', $recurse=true)
Returns whether the specified view exists.
Definition: views.php:304
elgg_register_css($name, $url, $priority=null)
Register a CSS file for inclusion in the HTML head.
Definition: elgglib.php:242
if(!$count) $offset
Definition: pagination.php:26
_elgg_views_amd($hook, $type, $content, $params)
Inserts module names into anonymous modules by handling the "simplecache:generate" hook...
Definition: views.php:1508
$pagination
Definition: gallery.php:22
elgg_view_annotation_list($annotations, array $vars=array())
Returns a rendered list of annotations, plus pagination.
Definition: views.php:1050
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_register_plugin_hook_handler($hook, $type, $callback, $priority=500)
Definition: elgglib.php:717
get_members_of_access_collection($collection_id, $guids_only=false)
Get all of members of an access collection.
Definition: access.php:418
$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:1576
elgg_unregister_external_view($view)
Unregister a view for ajax calls.
Definition: views.php:264
$title
Definition: save.php:22
$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:1463
_elgg_views_deprecate_removed_views()
Checks for usage of core views that have been removed.
Definition: views.php:1553
$params
Definition: login.php:72
elgg_view_list_item($item, array $vars=array())
View an item in a list.
Definition: views.php:1363
$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:1478
elgg_view_menu($menu_name, array $vars=array())
Render a menu.
Definition: views.php:678
$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:405
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:269
$limit
Definition: userpicker.php:38
elgg_register_js($name, $url, $location= 'head', $priority=null)
Register a JavaScript file for inclusion.
Definition: elgglib.php:141
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:1519
elgg_view_annotation(\ElggAnnotation $annotation, array $vars=array(), $bypass=false, $debug=false)
Returns a string of a rendered annotation.
Definition: views.php:903
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:1132
$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:289
elgg_unextend_view($view, $view_extension)
Unextends a view.
Definition: views.php:400
elgg_view_image_block($image, $body, $vars=array())
Wrapper function for the image block display pattern.
Definition: views.php:1182
elgg_set_config($name, $value)
Set an Elgg configuration value.
_elgg_services()
Definition: autoloader.php:14
$item
Definition: item.php:12
global $CURRENT_SYSTEM_VIEWTYPE
The viewtype override.
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:357
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:387
$user
Definition: ban.php:13
$body_vars
$annotations
Definition: entity.php:20
elgg_trigger_plugin_hook($hook, $type, $params=null, $returnvalue=null)
Definition: elgglib.php:790
elgg_deprecated_notice($msg, $dep_version, $backtrace_level=1)
Log a notice about deprecated use of a function, view, etc.
Definition: elgglib.php:1031
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:340
if(!elgg_instanceof($comment, 'object', 'comment')||!$comment->canEdit()) $form_vars
elgg_extract($key, $array, $default=null, $strict=true)
Checks for $array[$key] and returns its value if it exists, else returns $default.
Definition: elgglib.php:1271
elgg_view_layout($layout_name, $vars=array())
Displays a layout with optional parameters.
Definition: views.php:608
$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:1544
_elgg_views_prepare_head($title)
Prepare the variables for the html head.
Definition: views.php:480
elgg_view_menu_item(\ElggMenuItem $item, array $vars=array())
Render a menu item (usually as a link)
Definition: views.php:719
elgg_load_js($name)
Load a JavaScript resource on this page.
Definition: elgglib.php:203
elgg_view_title($title, $vars=array())
Renders a title.
Definition: views.php:1111
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:1150
elgg_view_entity(\ElggEntity $entity, $vars=array(), $bypass=false, $debug=false)
Returns a string of a rendered entity.
Definition: views.php:779
elgg_format_url($url)
Handles formatting of ampersands in urls.
Definition: output.php:105
elgg_view_access_collections($owner_guid)
Displays a user&#39;s access collections, using the core/friends/collections view.
Definition: views.php:1428
elgg_view_page($title, $body, $page_shell= 'default', $vars=array())
Assembles and outputs a full page.
Definition: views.php:423
$menu
Definition: default.php:19
clearfix elgg elgg elgg elgg page header
Definition: admin.php:127
$output
Definition: item.php:10
$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:970
$subtype
Definition: river.php:12
elgg_view_entity_icon(\ElggEntity $entity, $size= 'medium', $vars=array())
View the icon of an entity.
Definition: views.php:851
$version
Definition: version.php:14
elgg_view_form($action, $form_vars=array(), $body_vars=array())
Definition: views.php:1298
$viewtype
Definition: start.php:86
elgg_views_boot()
Initialize viewtypes on system boot event This ensures simplecache is cleared during upgrades...
Definition: views.php:1591
$priority
getValues()
Get all the values for this menu item.
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:1218
elgg_register_viewtype($viewtype)
Register a viewtype.
Definition: views.php:116