viewreference.module 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074
  1. <?php
  2. /**
  3. * @file
  4. * Defines a field type for referencing a view from a node.
  5. */
  6. /**
  7. * Implements hook_menu().
  8. */
  9. function viewreference_menu() {
  10. $items = array();
  11. $items['viewreference/autocomplete/%/%'] = array(
  12. 'title' => 'viewreference autocomplete',
  13. 'page callback' => 'viewreference_autocomplete',
  14. 'page arguments' => array(2, 3),
  15. 'access callback' => 'viewreference_autocomplete_access',
  16. 'access arguments' => array(2, 3),
  17. 'type' => MENU_CALLBACK,
  18. );
  19. return $items;
  20. }
  21. /**
  22. * Implements hook_theme().
  23. */
  24. function viewreference_theme() {
  25. return array(
  26. 'viewreference_display_title' => array(
  27. 'variables' => array(
  28. 'view' => NULL,
  29. 'view_name' => NULL,
  30. 'display_key' => NULL,
  31. 'append_id' => FALSE,
  32. ),
  33. ),
  34. 'viewreference_formatter_default' => array(
  35. 'variables' => array('element' => NULL),
  36. ),
  37. 'viewreference_formatter_full' => array(
  38. 'variables' => array('element' => NULL),
  39. ),
  40. 'viewreference_formatter_plain' => array(
  41. 'variables' => array('element' => NULL),
  42. ),
  43. 'viewreference_formatter_link' => array(
  44. 'variables' => array('element' => NULL),
  45. ),
  46. 'viewreference_formatter_path' => array(
  47. 'variables' => array('element' => NULL),
  48. ),
  49. );
  50. }
  51. /**
  52. * Implements hook_field_info().
  53. */
  54. function viewreference_field_info() {
  55. $field_info = array(
  56. 'viewreference' => array(
  57. 'label' => t('View reference'),
  58. 'description' => t('Reference a views display from the views module.'),
  59. 'settings' => array(
  60. 'referenceable_views' => array(),
  61. 'referenceable_tags' => array(
  62. 'allow' => '',
  63. 'deny' => '',
  64. ),
  65. 'arguments' => array(
  66. 'dsv_arguments' => 0,
  67. 'php_arguments' => 0,
  68. 'delimiter' => '/',
  69. 'rows' => 1,
  70. 'label' => '!field_label ' . t('arguments'),
  71. ),
  72. 'append_id' => 0,
  73. 'skip_default' => 1,
  74. 'skip_empty' => 0,
  75. ),
  76. 'default_widget' => 'viewreference_autocomplete',
  77. 'default_formatter' => 'viewreference_default',
  78. ),
  79. );
  80. return $field_info;
  81. }
  82. /**
  83. * Implements hook_field_schema().
  84. */
  85. function viewreference_field_schema($field) {
  86. $columns = array(
  87. 'view_id' => array(
  88. 'type' => 'varchar',
  89. 'length' => '255',
  90. 'default' => NULL,
  91. 'not null' => FALSE,
  92. ),
  93. 'arguments' => array(
  94. 'type' => 'text',
  95. 'size' => 'big',
  96. ),
  97. );
  98. return array(
  99. 'columns' => $columns,
  100. 'indexes' => array('view_id' => array('view_id')),
  101. );
  102. }
  103. /**
  104. * Implements hook_field_settings_form().
  105. */
  106. function viewreference_field_settings_form($field, $instance, $has_data) {
  107. $settings = $field['settings'];
  108. $form = array();
  109. $form['referenceable_views'] = array(
  110. '#type' => 'checkboxes',
  111. '#title' => t('Views that can be referenced'),
  112. '#description' => t('Select the Views that can be referenced. If no Views are selected here, and tags are not entered below, then all the Views will be available.'),
  113. '#multiple' => TRUE,
  114. '#default_value' => is_array($settings['referenceable_views']) ? $settings['referenceable_views'] : array(),
  115. '#options' => viewreference_get_views($settings['append_id']), // This call doesn't supply $settings, so they aren't filtered.
  116. );
  117. $form['referenceable_tags'] = array(
  118. '#type' => 'fieldset',
  119. '#title' => t('Views tags that can be referenced'),
  120. '#collapsible' => TRUE,
  121. '#collapsed' => (!empty($settings['referenceable_tags']['allow']) || !empty($settings['referenceable_tags']['deny'])) ? FALSE : TRUE,
  122. '#description' => t('Optionally you can allow views by tags here instead of, or in addition to, using <em>Views that can be referenced</em>, then other Views will be excluded. You can also deny views by tags, and if <em>Views that can be referenced</em> and the <em>Allow list</em> are left blank all other Views will be available.'),
  123. );
  124. $form['referenceable_tags']['allow'] = array(
  125. '#type' => 'textfield',
  126. '#title' => t('Allow list'),
  127. '#default_value' => !empty($settings['referenceable_tags']['allow']) ? $settings['referenceable_tags']['allow'] : '',
  128. '#size' => 128,
  129. '#maxlength' => 512,
  130. '#description' => t('Enter a comma delimited list of tags to include.'),
  131. );
  132. $form['referenceable_tags']['deny'] = array(
  133. '#type' => 'textfield',
  134. '#title' => t('Deny list'),
  135. '#default_value' => !empty($settings['referenceable_tags']['deny']) ? $settings['referenceable_tags']['deny'] : '',
  136. '#size' => 128,
  137. '#maxlength' => 512,
  138. '#description' => t('Enter a comma delimited list of tags to exclude.'),
  139. );
  140. $form['arguments'] = array(
  141. '#type' => 'fieldset',
  142. '#title' => t('Contextual filter arguments'),
  143. '#collapsible' => TRUE,
  144. '#collapsed' => ($settings['arguments']['dsv_arguments'] || $settings['arguments']['php_arguments']) ? FALSE : TRUE,
  145. '#description' => t('Enabling the following options will provide an input field for passing arguments (aka <em>contextual filters</em>) to the View.'),
  146. );
  147. $form['arguments']['dsv_arguments'] = array(
  148. '#type' => 'checkbox',
  149. '#title' => t('Allow delimiter seperated values.'),
  150. '#default_value' => isset($settings['arguments']['dsv_arguments']) ? $settings['arguments']['dsv_arguments'] : 0,
  151. '#description' => t('Users can provide a list of arguments seperated by a delimiter. e.g: <em>term_1/term_2</em>'),
  152. );
  153. $form['arguments']['php_arguments'] = array(
  154. '#type' => 'checkbox',
  155. '#title' => t('Allow PHP code.'),
  156. '#default_value' => isset($settings['arguments']['php_arguments']) ? $settings['arguments']['php_arguments'] : 0,
  157. '#description' => t('Users can insert PHP code to generate the list of arguments. e.g: <em>term_1/&lt;?php print "term_x/term_y"; ?&gt;/term_2</em>') .
  158. '<br />' . t('Note: The users must have the <em>use PHP for settings</em> permission.'),
  159. '#disabled' => !user_access('use PHP for settings'),
  160. );
  161. $form['arguments']['delimiter'] = array(
  162. '#type' => 'textfield',
  163. '#title' => t('Delimiter'),
  164. '#default_value' => !empty($settings['arguments']['delimiter']) ? $settings['arguments']['delimiter'] : '/',
  165. '#size' => 3,
  166. '#maxlength' => 30,
  167. '#required' => TRUE,
  168. );
  169. $row_range = range(0, 10);
  170. unset($row_range[0]);
  171. $form['arguments']['rows'] = array(
  172. '#type' => 'select',
  173. '#title' => t('Number of rows in argument field'),
  174. '#default_value' => isset($settings['arguments']['rows']) ? $settings['arguments']['rows'] : 1,
  175. '#options' => $row_range,
  176. '#description' => t('Set as 1 for textfield, or larger values for textarea (may be easier to write PHP with a textarea)'),
  177. '#required' => TRUE,
  178. );
  179. $form['arguments']['label'] = array(
  180. '#type' => 'textfield',
  181. '#title' => t('Label for arguments field'),
  182. '#default_value' => isset($settings['arguments']['label']) ? $settings['arguments']['label'] : '!field_label ' . t('arguments'),
  183. '#description' => t('Use <em>!field_label</em> to insert the field label.'),
  184. );
  185. $form['append_id'] = array(
  186. '#type' => 'checkbox',
  187. '#title' => t('Append unique ID in lists.'),
  188. '#default_value' => isset($settings['append_id']) ? $settings['append_id'] : 0,
  189. '#description' => t('It is possible for Views displays to have the same title, this option will append [view:view_display_n] in lists used by this field to disambiguate the options.'),
  190. );
  191. $form['skip_default'] = array(
  192. '#type' => 'checkbox',
  193. '#title' => t('Exclude the master (default) display from lists.'),
  194. '#default_value' => isset($settings['skip_default']) ? $settings['skip_default'] : 1,
  195. );
  196. $form['skip_empty'] = array(
  197. '#type' => 'checkbox',
  198. '#title' => t('Do not output view if no rows are detected'),
  199. '#default_value' => isset($settings['skip_empty']) ? $settings['skip_empty'] : 0,
  200. );
  201. $form['skip_disabled'] = array(
  202. '#type' => 'checkbox',
  203. '#title' => t('Do not allow selection of disabled views'),
  204. '#default_value' => isset($settings['skip_disabled']) ? $settings['skip_disabled'] : 0,
  205. );
  206. $form['sort_views'] = array(
  207. '#type' => 'checkbox',
  208. '#title' => t('Sort the views by title'),
  209. '#default_value' => isset($settings['sort_views']) ? $settings['sort_views'] : 1,
  210. );
  211. return $form;
  212. }
  213. /**
  214. * Implements hook_field_validate().
  215. */
  216. function viewreference_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
  217. $views = viewreference_get_views($field['settings']['append_id'], $field['settings']);
  218. foreach ($items as $delta => $item) {
  219. if (is_array($item)) {
  220. if (!empty($item['view_id'])) {
  221. if (!in_array($item['view_id'], array_keys($views))) {
  222. $errors[$field['field_name']][$langcode][$delta][] = array(
  223. 'error' => 'invalid_view',
  224. 'message' => t("%name: This view can't be referenced.",
  225. array('%name' => $instance['label'])),
  226. );
  227. }
  228. }
  229. }
  230. }
  231. }
  232. /**
  233. * Implements hook_field_is_empty().
  234. */
  235. function viewreference_field_is_empty($item, $field) {
  236. return empty($item['view_id']);
  237. }
  238. /**
  239. * Implements hook_field_formatter_info().
  240. */
  241. function viewreference_field_formatter_info() {
  242. $ret = array(
  243. 'viewreference_default' => array(
  244. 'label' => t('Default (view)'),
  245. 'description' => t('Display the referenced view.'),
  246. 'field types' => array('viewreference'),
  247. ),
  248. 'viewreference_full' => array(
  249. 'label' => t('Full (title and view)'),
  250. 'description' => t('Display the referenced view with a title.'),
  251. 'field types' => array('viewreference'),
  252. ),
  253. 'viewreference_plain' => array(
  254. 'label' => t('Title (no link)'),
  255. 'description' => t('Display the title of the referenced view.'),
  256. 'field types' => array('viewreference'),
  257. ),
  258. 'viewreference_link' => array(
  259. 'label' => t('Title (link)'),
  260. 'description' => t('Display the title of the referenced view as a link (if possible).'),
  261. 'field types' => array('viewreference'),
  262. ),
  263. 'viewreference_path' => array(
  264. 'label' => t('Path'),
  265. 'description' => t('Display the path of the referenced view (if possible).'),
  266. 'field types' => array('viewreference'),
  267. ),
  268. );
  269. return $ret;
  270. }
  271. /**
  272. * Implements hook_field_formatter_view().
  273. */
  274. function viewreference_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
  275. $element = array();
  276. $formatter = str_replace('viewreference_', '', $display['type']);
  277. foreach ($items as $delta => $item) {
  278. $element[$delta] = array(
  279. '#theme' => 'viewreference_formatter_' . $formatter,
  280. '#element' => array(
  281. 'entity_type' => &$entity_type,
  282. 'entity' => &$entity,
  283. 'field' => &$field,
  284. 'instance' => &$instance,
  285. 'langcode' => &$langcode,
  286. 'item' => $item,
  287. 'display' => &$display,
  288. ),
  289. );
  290. $element[$delta]['#element']['view'] = viewreference_get_view($element[$delta]['#element']);
  291. if (!$element[$delta]['#element']['view']) {
  292. unset($element[$delta]);
  293. }
  294. }
  295. return $element;
  296. }
  297. /**
  298. * Value callback for a viewreference_autocomplete element.
  299. */
  300. function viewreference_autocomplete_value($element, $input = FALSE, $form_state) {
  301. if ($input === FALSE) {
  302. $field_key = $element['#columns'][0];
  303. $args_key = $element['#columns'][1];
  304. if (!empty($element['#default_value'][$field_key])) {
  305. $field_name = $element['#field_name'];
  306. $field = field_info_field($field_name);
  307. $settings = $field['settings'];
  308. $settings['referenceable_views'] = array($element['#default_value'][$field_key]);
  309. $views = viewreference_get_views(TRUE, $settings);
  310. $value = $views[$element['#default_value'][$field_key]];
  311. return array($field_key => $value, $args_key => $element['#default_value'][$args_key]);
  312. }
  313. return array($field_key => NULL, $args_key => $element['#default_value'][$args_key]);
  314. }
  315. }
  316. /**
  317. * Validation callback for a viewreference_autocomplete element.
  318. */
  319. function viewreference_autocomplete_validate($element, &$form_state, $form) {
  320. $field = field_widget_field($element, $form_state);
  321. $value = $element['#value'];
  322. $new_value = NULL;
  323. if (!empty($value)) {
  324. $regex = '/' // Start of string
  325. . '(.*).*?' // Any non-greedy
  326. . '(\\[)' // [
  327. . '((?:[a-z][a-z0-9_]*))' // Variable 1
  328. . '(:)' // :
  329. . '((?:[a-z][a-z0-9_]*))' // Variable 2
  330. . '(\\])' // ]
  331. . '/is'; // End of string
  332. preg_match($regex, $value, $matches);
  333. if (!empty($matches)) {
  334. $new_value = $matches[3] . ':' . $matches[5];
  335. $allowed = viewreference_get_views(FALSE, $field['settings']);
  336. if (!isset($allowed[$new_value])) {
  337. form_error(
  338. $element,
  339. t(
  340. '%name: View display %value cannot be referenced.',
  341. array(
  342. '%name' => $element['#title'],
  343. '%value' => $new_value,
  344. )
  345. )
  346. );
  347. }
  348. }
  349. else {
  350. form_error(
  351. $element,
  352. t(
  353. '%name: The value %value is in an unexpected format. Expecting: %format',
  354. array(
  355. '%name' => $element['#title'],
  356. '%value' => $value,
  357. '%format' => '<em>View title [view:display_n]</em>',
  358. )
  359. )
  360. );
  361. }
  362. }
  363. form_set_value($element, $new_value, $form_state);
  364. }
  365. /**
  366. * Implements hook_field_widget_error().
  367. */
  368. function viewreference_field_widget_error($element, $error, $form, &$form_state) {
  369. form_error($element['view_id'], $error['message']);
  370. }
  371. /**
  372. * Menu access callback for the autocomplete path.
  373. *
  374. * Check for both 'edit' and 'view' access in the unlikely event
  375. * a user has edit but not view access.
  376. */
  377. function viewreference_autocomplete_access($entity_type, $field_name) {
  378. return user_access('access content') && ($field = field_info_field($field_name)) && field_access('view', $field, $entity_type) && field_access('edit', $field, $entity_type);
  379. }
  380. /**
  381. * Menu callback for the autocomplete results.
  382. */
  383. function viewreference_autocomplete($bundle_name, $field_name, $string = '') {
  384. // If the request has a '/' in the search text, then the menu system will have
  385. // split it into multiple arguments, recover the intended $string.
  386. $args = func_get_args();
  387. // Shift off the $bundle_name argument.
  388. array_shift($args);
  389. // Shift off the $field_name argument.
  390. array_shift($args);
  391. $string = implode('/', $args);
  392. $field = field_info_field($field_name);
  393. $settings = $field['settings'];
  394. $matches = viewreference_get_views($settings['append_id'], $settings, FALSE, $string, FALSE, TRUE);
  395. drupal_json_output($matches);
  396. }
  397. /**
  398. * Implements hook_options_list().
  399. */
  400. function viewreference_options_list($field) {
  401. $references = viewreference_get_views($field['settings']['append_id'], $field['settings']);
  402. $options = array();
  403. foreach ($references as $key => $value) {
  404. $options[$key] = $value['rendered'];
  405. }
  406. return $options;
  407. }
  408. /**
  409. * Create a display title for a view display.
  410. */
  411. function viewreference_views_display_title($view_name, $view, $display) {
  412. // Build the display title.
  413. if (isset($view->display[$display]->display_options['title'])) {
  414. // This view display has a nice title, let's use that.
  415. return $view->display[$display]->display_options['title'];
  416. }
  417. elseif (isset($view->display['default']->display_options['title'])) {
  418. // This view display inherits it's title from the default display.
  419. return $view->display['default']->display_options['title'];
  420. }
  421. else {
  422. // This view display does not have a title configured, we have to construct a title.
  423. return ucfirst($view_name) . ' ' . strtolower($view->display[$display]->display_title);
  424. }
  425. }
  426. /**
  427. * Get an array of data and rendered HTML items that are useful in theming the
  428. * formatter output.
  429. *
  430. * @param $element
  431. * An array of parameters used in viewing the element.
  432. * @param $params
  433. * An array of special features needed to be built:
  434. * 'embed' - The $view->preview() of the view display
  435. * 'title' - The display title of the view display
  436. * 'link' - A link to the view display, or the title if link not available.
  437. * 'path' - The path to the view display, or the title if path not available.
  438. * 'contextual' - The contextual links.
  439. * @return
  440. * The array of useful data about the view.
  441. */
  442. function viewreference_get_view($element, $params = array()) {
  443. if (!empty($element['item']['view_id'])) {
  444. if (!empty($element['view'])) {
  445. $view = $element['view'];
  446. }
  447. if (empty($view['view']) || empty($view['display']) || empty($view['name'])) {
  448. $view_id_parts = explode(':', $element['item']['view_id']);
  449. $view['name'] = $view_id_parts[0];
  450. $view['display'] = $view_id_parts[1];
  451. $view['view'] = views_get_view($view['name']);
  452. }
  453. if ($view['view'] && $view['view']->access($view['display'])) {
  454. // Save $_GET['q'] so it can be restored before returning from this function.
  455. //$q = $_GET['q'];
  456. if (empty($view['embed']) && (in_array('embed', $params) || !empty($element['field']['settings']['skip_empty']))) {
  457. $view['args'] = viewreference_get_element_args($element);
  458. //if (!empty($view['args'])) {
  459. // $_GET['q'] .= '/' . implode('/', $view['args']);
  460. //}
  461. $view['embed'] = $view['view']->preview($view['display'], $view['args']);
  462. // If the view is empty and the viewreference field is configured with
  463. // "skip empty views" enabled, skip outputting the view.
  464. if (!empty($element['field']['settings']['skip_empty']) && empty($view['view']->result)) {
  465. // Restore $_GET['q'] before skipping the view.
  466. //$_GET['q'] = $q;
  467. return FALSE;
  468. }
  469. }
  470. if ((in_array('title', $params) && empty($view['title'])) || (in_array('link', $params) && empty($view['link']))) {
  471. $view['display_key'] = $view['display'];
  472. $view['title'] = theme('viewreference_display_title', $view);
  473. if (in_array('link', $params) && empty($view['link'])) {
  474. $disabled = isset($view['view']->disabled) ? $view['view']->disabled: FALSE;
  475. if (isset($view['view']->display[$view['display']]->display_options['path']) && !$disabled) {
  476. $view['args'] = isset($view['args']) ? $view['args'] : viewreference_get_element_args($element);
  477. $view['url_args'] = implode('/', $view['args']);
  478. $view['path'] = $view['view']->display[$view['display']]->display_options['path'];
  479. if ($view['url_args']) {
  480. $view['path'] .= '/' . $view['url_args'];
  481. }
  482. $view['link'] = l($view['title'], $view['view']->get_url($view['args'], $view['path']));
  483. }
  484. else {
  485. $view['link'] = $view['title'];
  486. }
  487. }
  488. }
  489. if (in_array('contextual', $params) && empty($view['contextual'])) {
  490. $view['contextual'] = '';
  491. if (module_exists('contextual')) {
  492. $contextual = contextual_element_info();
  493. views_add_contextual_links($contextual['contextual_links'], 'special_block_-exp', $view['view'], $view['display']);
  494. if (!empty($contextual['contextual_links']['#contextual_links'])) {
  495. $view['contextual'] = drupal_render($contextual['contextual_links']);
  496. }
  497. }
  498. }
  499. //$_GET['q'] = $q;
  500. return $view;
  501. }
  502. }
  503. }
  504. /**
  505. * Theme function for 'default' viewreference field formatter.
  506. */
  507. function theme_viewreference_formatter_default($variables) {
  508. $element = &$variables['element'];
  509. $output = '';
  510. if ($view = viewreference_get_view($element, array('contextual', 'embed'))) {
  511. $output .= '<div class="contextual-links-region">';
  512. $output .= $view['contextual'];
  513. $output .= $view['embed'];
  514. $output .= '</div>';
  515. }
  516. return $output;
  517. }
  518. /**
  519. * Theme function for 'full' viewreference field formatter.
  520. */
  521. function theme_viewreference_formatter_full($variables) {
  522. $element = &$variables['element'];
  523. $output = '';
  524. if ($view = viewreference_get_view($element, array('contextual', 'title', 'embed'))) {
  525. $output .= '<div class="contextual-links-region">';
  526. $output .= '<h3 class="title viewreference-title">' . $view['title'] . '</h3>';
  527. $output .= $view['contextual'];
  528. $output .= $view['embed'];
  529. $output .= '</div>';
  530. }
  531. return $output;
  532. }
  533. /**
  534. * Theme function for 'plain' viewreference field formatter.
  535. */
  536. function theme_viewreference_formatter_plain($variables) {
  537. $element = &$variables['element'];
  538. $output = '';
  539. if ($view = viewreference_get_view($element, array('title'))) {
  540. $output .= $view['title'];
  541. }
  542. return $output;
  543. }
  544. /**
  545. * Theme function for 'link' viewreference field formatter.
  546. */
  547. function theme_viewreference_formatter_link($variables) {
  548. $element = &$variables['element'];
  549. $output = '';
  550. if ($view = viewreference_get_view($element, array('link'))) {
  551. $output .= $view['link'];
  552. }
  553. return $output;
  554. }
  555. /**
  556. * Theme function for 'path' viewreference field formatter.
  557. */
  558. function theme_viewreference_formatter_path($variables) {
  559. $element = &$variables['element'];
  560. $output = '';
  561. if ($view = viewreference_get_view($element, array('link'))) {
  562. $output .= isset($view['path']) ? $view['path'] : $view['link'];
  563. }
  564. return $output;
  565. }
  566. /**
  567. * Get an array of views.
  568. *
  569. * @param bool $append_id
  570. * Whether to append the id to the returned display names.
  571. * @param array $settings
  572. * The settings of the field.
  573. * @param bool $full
  574. * If TRUE will return all the data, rather than just the title.
  575. * @param string $string
  576. * String to match against the title to filter results by.
  577. * @param bool $exact_string
  578. * If TRUE the $string parameter must match exactly.
  579. * @param bool $long_key
  580. * If TRUE will key array by the title and ID, not just the ID.
  581. *
  582. * @return mixed[]
  583. * The array of views. The array value type depends on the parameters.
  584. */
  585. function viewreference_get_views($append_id = FALSE, $settings = NULL, $full = FALSE, $string = '', $exact_string = FALSE, $long_key = FALSE) {
  586. /** @var views_display[] $views_displays */
  587. $views_displays = _viewreference_get_applicable_views_displays($settings);
  588. return _viewreference_extract_views_displays($settings, $views_displays, $append_id, $full, $string, $exact_string, $long_key);
  589. }
  590. /**
  591. * @param array $settings
  592. * If applying filters, the settings of the field.
  593. *
  594. * @return array[]
  595. * An array where the keys are views machine names, and each value is an array
  596. * of the format array($view, $applicable_displays), where the first element
  597. * is a view, and the second element is an array of views displays.
  598. */
  599. function _viewreference_get_applicable_views_displays($settings) {
  600. $loaded_views = views_get_all_views();
  601. // Prepare filters.
  602. if (!empty($settings['referenceable_views'])) {
  603. $filters['ids'] = array_filter($settings['referenceable_views']);
  604. }
  605. if (!empty($settings['referenceable_tags']['allow'])) {
  606. $filters['allow_tags'] = array_map('trim', explode(',', $settings['referenceable_tags']['allow']));
  607. }
  608. if (!empty($settings['referenceable_tags']['deny'])) {
  609. $filters['deny_tags'] = array_map('trim', explode(',', $settings['referenceable_tags']['deny']));
  610. }
  611. $applicable_views_displays = array();
  612. foreach ((array)$loaded_views as $view_name => $view) {
  613. // Limit views to active views
  614. if (!empty($settings['skip_disabled']) && $view->disabled) {
  615. continue;
  616. }
  617. // Prepare this view's tags.
  618. $tags = array_map('trim', explode(',', $view->tag));
  619. // Determine if there are allow tags
  620. $has_allow_tag = FALSE;
  621. if (!empty($tags) && !empty($filters['allow_tags'])) {
  622. foreach ($tags as $tag) {
  623. if (in_array($tag, $filters['allow_tags'])) {
  624. $has_allow_tag = TRUE;
  625. break;
  626. }
  627. }
  628. }
  629. // Determine if there are deny tags
  630. $has_deny_tag = FALSE;
  631. if (!empty($tags) && !empty($filters['deny_tags'])) {
  632. foreach ($tags as $tag) {
  633. if (in_array($tag, $filters['deny_tags'])) {
  634. $has_deny_tag = TRUE;
  635. break;
  636. }
  637. }
  638. }
  639. // Skip the entire view, if there is a deny tag.
  640. if ($has_deny_tag) {
  641. continue;
  642. }
  643. $allow_all = $has_allow_tag
  644. || (empty($filters['ids']) && empty($filters['allow_tags']));
  645. $applicable_displays = array();
  646. foreach ((array)$view->display as $display_key => $display) {
  647. // Skip this one if it's a 'default' view and we're skipping defaults.
  648. if ($display_key === 'default' && $settings['skip_default']) {
  649. continue;
  650. }
  651. if ($allow_all) {
  652. $applicable_displays[$display_key] = $display;
  653. continue;
  654. }
  655. // Skip this one if it's not 'allowed'.
  656. $id = $view_name . ':' . $display_key;
  657. if (!empty($filters['ids']) && in_array($id, $filters['ids'])) {
  658. $applicable_displays[$display_key] = $display;
  659. }
  660. }
  661. if (!empty($applicable_displays)) {
  662. $applicable_views_displays[$view_name] = array($view, $applicable_displays);
  663. }
  664. }
  665. return $applicable_views_displays;
  666. }
  667. /**
  668. * Get an array of views.
  669. *
  670. * @param array $settings
  671. * The settings of the field.
  672. * @param views_display[] $views_displays
  673. * @param bool $append_id
  674. * Whether to append the id to the returned display names.
  675. * @param bool $full
  676. * If TRUE will return all the data, rather than just the title.
  677. * @param string $string
  678. * String to match against the title to filter results by.
  679. * @param bool $exact_string
  680. * If TRUE the $string parameter must match exactly.
  681. * @param bool $long_key
  682. * If TRUE will key array by the title and ID, not just the ID.
  683. *
  684. * @return mixed[]
  685. * The array of views.
  686. */
  687. function _viewreference_extract_views_displays($settings, $views_displays, $append_id = FALSE, $full = FALSE, $string = '', $exact_string = FALSE, $long_key = FALSE) {
  688. $views = array();
  689. foreach ($views_displays as $view_name => $view_and_displays) {
  690. list($view, $view_displays) = $view_and_displays;
  691. /** @var views_display $display */
  692. foreach ($view_displays as $display_key => $display) {
  693. $id = $view_name . ':' . $display_key;
  694. // Get display title.
  695. $theme_vars = array(
  696. 'view' => $view,
  697. 'view_name' => $view_name,
  698. 'display_key' => $display_key,
  699. 'append_id' => $append_id,
  700. );
  701. $display_title = theme('viewreference_display_title', $theme_vars);
  702. // Determine whether and what to return.
  703. $key = $long_key ? $display_title . ($append_id ? '' : ' [' . $id . ']') : $id;
  704. if ($string) {
  705. if (!$exact_string && (stripos($display_title, $string) !== FALSE || stripos($key, $string) !== FALSE)) {
  706. $views[$key] = $full ? $display : $display_title;
  707. }
  708. elseif ($display_title == $string) {
  709. $views[$key] = $full ? $display : $display_title;
  710. }
  711. }
  712. else {
  713. $views[$key] = $full ? $display : $display_title;
  714. }
  715. }
  716. }
  717. if (!empty($settings['sort_views']))
  718. {
  719. asort($views);
  720. }
  721. return $views;
  722. }
  723. /**
  724. * Theme the display title for this view display.
  725. *
  726. * @param $variables
  727. An array of arguments that will be extracted to the following variables:
  728. * $view - The view object.
  729. * $view_name - The name of the view.
  730. * $display_key - The name of the display to use.
  731. * $append_id - Boolean indicating whether to append a unique id.
  732. * @return
  733. * The display title of this views display.
  734. */
  735. function theme_viewreference_display_title($variables) {
  736. // Get variables passed to theme function.
  737. $variables['view']->set_display($variables['display_key']);
  738. $display_title = $variables['view']->display_handler->options['title'];
  739. if (!$display_title) {
  740. // No title, we have to construct a title.
  741. $display_title = ucfirst($variables['view_name']) . ' ' .
  742. strtolower($variables['view']->display[$variables['display_key']]->display_title);
  743. }
  744. if (isset($variables['view']->display[$variables['display_key']]->display_title)) {
  745. $display_title .= ' - ' . $variables['view']->display[$variables['display_key']]->display_title;
  746. }
  747. if ($variables['append_id']) {
  748. // Append ID for disambiguation in forms (views displays can have the same title).
  749. $display_title .= ' [' . $variables['view_name'] . ':' . $variables['display_key'] . ']';
  750. }
  751. return $display_title;
  752. }
  753. /**
  754. * Convert arguments text field entry to an array of arguments.
  755. */
  756. function viewreference_get_element_args($element) {
  757. $string = &$element['item']['arguments'];
  758. $field = &$element['field'];
  759. $settings = $field['settings'];
  760. $delimiter = &$settings['arguments']['delimiter'];
  761. $dsv_arguments = &$settings['arguments']['dsv_arguments'];
  762. $php_arguments = &$settings['arguments']['php_arguments'];
  763. $arguments = '';
  764. $args = array();
  765. if ($php_arguments) {
  766. $last_edit_user = user_load($element['entity']->revision_uid);
  767. if (user_access('use PHP for settings', $last_edit_user)) {
  768. $variables = array(
  769. $element['entity_type'] => $element['entity'],
  770. );
  771. $arguments = viewreference_eval($string, $variables);
  772. }
  773. else {
  774. $arguments = $string;
  775. }
  776. }
  777. elseif ($dsv_arguments) {
  778. $arguments = $string;
  779. }
  780. if ($arguments) {
  781. $args = explode($delimiter, $arguments);
  782. foreach ($args as $k => $v) {
  783. $args[$k] = check_plain(trim($v));
  784. }
  785. }
  786. // Allow modules to easily supply their own views arguments.
  787. drupal_alter('viewreference_args', $args, $element);
  788. return $args;
  789. }
  790. /**
  791. * A version of php_eval() that allows passing of variables.
  792. */
  793. function viewreference_eval($code, $variables = array()) {
  794. global $theme_path, $theme_info, $conf;
  795. // Store current theme path.
  796. $old_theme_path = $theme_path;
  797. // Restore theme_path to the theme, as long as drupal_eval() executes,
  798. // so code evaluted will not see the caller module as the current theme.
  799. // If theme info is not initialized get the path from theme_default.
  800. if (!isset($theme_info)) {
  801. $theme_path = drupal_get_path('theme', $conf['theme_default']);
  802. }
  803. else {
  804. $theme_path = dirname($theme_info->filename);
  805. }
  806. foreach ((array)$variables as $key => $value) {
  807. $$key = $value;
  808. }
  809. ob_start();
  810. print eval('?>' . $code);
  811. $output = ob_get_contents();
  812. ob_end_clean();
  813. // Recover original theme path.
  814. $theme_path = $old_theme_path;
  815. return $output;
  816. }
  817. /**
  818. * Implements hook_field_widget_info().
  819. */
  820. function viewreference_field_widget_info() {
  821. return array(
  822. 'viewreference_select' => array(
  823. 'label' => t('Select list'),
  824. 'description' => t('Display the list of referenceable views as a select list.'),
  825. 'field types' => array('viewreference'),
  826. 'behaviors' => array(
  827. 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
  828. 'default value' => FIELD_BEHAVIOR_DEFAULT,
  829. ),
  830. ),
  831. 'viewreference_autocomplete' => array(
  832. 'label' => t('Autocomplete text field'),
  833. 'description' => t('Display the list of referenceable views as a textfield with autocomplete behaviour.'),
  834. 'field types' => array('viewreference'),
  835. 'behaviors' => array(
  836. 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
  837. 'default value' => FIELD_BEHAVIOR_DEFAULT,
  838. ),
  839. ),
  840. );
  841. }
  842. /**
  843. * Implements hook_field_widget_form().
  844. */
  845. function viewreference_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
  846. switch ($instance['widget']['type']) {
  847. case 'viewreference_select':
  848. $element += array(
  849. '#type' => 'viewreference_select',
  850. '#default_value' => isset($items[$delta]) ? $items[$delta] : NULL,
  851. );
  852. break;
  853. case 'viewreference_autocomplete':
  854. $element += array(
  855. '#type' => 'viewreference_autocomplete',
  856. '#default_value' => isset($items[$delta]) ? $items[$delta] : NULL,
  857. '#value_callback' => 'viewreference_autocomplete_value',
  858. );
  859. break;
  860. }
  861. return $element;
  862. }
  863. /**
  864. * Implements hook_element_info().
  865. */
  866. function viewreference_element_info() {
  867. return array(
  868. 'viewreference_select' => array(
  869. '#input' => TRUE,
  870. '#columns' => array('view_id', 'arguments'),
  871. '#delta' => 0,
  872. '#process' => array('viewreference_select_process'),
  873. ),
  874. 'viewreference_autocomplete' => array(
  875. '#input' => TRUE,
  876. '#columns' => array('view_id', 'arguments'),
  877. '#delta' => 0,
  878. '#process' => array('viewreference_autocomplete_process'),
  879. '#autocomplete_path' => FALSE,
  880. ),
  881. );
  882. }
  883. /**
  884. * Process callback for a viewreference_select element.
  885. *
  886. * @see viewreference_element_info().
  887. */
  888. function viewreference_select_process($element, $form_state, $form) {
  889. $field_name = $element['#field_name'];
  890. $language = $element['#language'];
  891. $field = field_widget_field($element, $form_state);
  892. $instance = field_widget_instance($element, $form_state);
  893. $settings = $field['settings'];
  894. $options = _viewreference_select_widget_options($settings);
  895. if (!$instance['required']) {
  896. $options = array(0 => '<'. t('none') .'>') + $options;
  897. }
  898. $element[$element['#columns'][0]] = array(
  899. '#type' => 'select',
  900. '#multiple' => 0,
  901. '#options' => $options,
  902. '#default_value' => isset($element['#value'][$element['#columns'][0]]) ? $element['#value'][$element['#columns'][0]] : '',
  903. '#field_name' => $field_name,
  904. '#delta' => $element['#delta'],
  905. '#columns' => $element['#columns'],
  906. '#title' => $element['#title'],
  907. '#required' => $instance['required'],
  908. '#description' => isset($instance['description']) ? $instance['description'] : NULL,
  909. );
  910. if ($settings['arguments']['dsv_arguments'] || $settings['arguments']['php_arguments']) {
  911. $element[$element['#columns'][1]] = array(
  912. '#type' => ($settings['arguments']['rows'] == 1 ? 'textfield' : 'textarea'),
  913. '#default_value' => isset($element['#value'][$element['#columns'][1]]) ? $element['#value'][$element['#columns'][1]] : '',
  914. '#title' => isset($settings['arguments']['label']) ?
  915. str_replace('!field_label', $instance['label'], check_plain($settings['arguments']['label'])) :
  916. $instance['label'] . ' ' . t('arguments'),
  917. '#rows' => $settings['arguments']['rows'],
  918. '#language' => $language,
  919. '#delta' => $element['#delta'],
  920. '#columns' => $element['#columns'],
  921. );
  922. }
  923. return $element;
  924. }
  925. /**
  926. * @return array[]
  927. */
  928. function _viewreference_select_widget_options($settings) {
  929. $options = array();
  930. foreach (_viewreference_get_applicable_views_displays($settings) as $view_key => $view_and_displays) {
  931. list($view, $view_displays) = $view_and_displays;
  932. $view_optgroup_key = $view_key;
  933. $view_title = $view->get_title();
  934. if (!empty($view_title)) {
  935. $view_optgroup_key .= ' (' . $view_title . ')';
  936. }
  937. foreach ($view_displays as $display_key => $display) {
  938. $option_key = $view_key . ':' . $display_key;
  939. $option_title = $display_key;
  940. if (!empty($display->display_title)) {
  941. $option_title .= ' (' . $display->display_title . ')';
  942. }
  943. $options[$view_optgroup_key][$option_key] = $option_title;
  944. }
  945. ksort($options[$view_optgroup_key]);
  946. }
  947. ksort($options);
  948. return $options;
  949. }
  950. /**
  951. * Process callback for a viewreference_autocomplete element.
  952. *
  953. * @see viewreference_element_info().
  954. */
  955. function viewreference_autocomplete_process($element, $form_state, $form) {
  956. $field_parents = $element['#field_parents'];
  957. $field_name = $element['#field_name'];
  958. $language = $element['#language'];
  959. $field_state = field_form_get_state($field_parents, $field_name, $language, $form_state);
  960. $field = $field_state['field'];
  961. $instance = $field_state['instance'];
  962. $bundle = $instance['bundle'];
  963. $settings = $field['settings'];
  964. $element[$element['#columns'][0]] = array(
  965. '#type' => 'textfield',
  966. '#default_value' => isset($element['#value'][$element['#columns'][0]]) ? $element['#value'][$element['#columns'][0]] : '',
  967. '#autocomplete_path' => 'viewreference/autocomplete/'. $bundle . '/' . $field_name,
  968. '#element_validate' => array('viewreference_autocomplete_validate'),
  969. '#field_name' => $field_name,
  970. '#language' => $language,
  971. '#delta' => $element['#delta'],
  972. '#columns' => $element['#columns'],
  973. '#title' => $element['#title'],
  974. '#required' => $element['#required'],
  975. '#description' => isset($element['#description']) ? $element['#description'] : '',
  976. );
  977. if ($settings['arguments']['dsv_arguments'] || $settings['arguments']['php_arguments']) {
  978. $element[$element['#columns'][1]] = array(
  979. '#type' => ($settings['arguments']['rows'] == 1 ? 'textfield' : 'textarea'),
  980. '#default_value' => isset($element['#value'][$element['#columns'][1]]) ? $element['#value'][$element['#columns'][1]] : '',
  981. '#title' => $instance['label'] . ' ' . t('arguments'),
  982. '#rows' => $settings['arguments']['rows'],
  983. '#delta' => $element['#delta'],
  984. '#columns' => $element['#columns'],
  985. '#required' => $element['#required'],
  986. '#description' => isset($element['#description']) ? $element['#description'] : '',
  987. );
  988. }
  989. return $element;
  990. }