From e0fe8c1701866d01037b6243d496ea703f60f26c Mon Sep 17 00:00:00 2001 From: Paul Pound Date: Thu, 31 May 2012 14:28:42 -0300 Subject: [PATCH 1/2] moved templates to theme directory and preprocess functions to theme.inc --- .../islandora_basic_collection.module | 128 +++--------------- .../islandora-basic-collection-grid.tpl.php | 0 ...islandora-basic-collection-wrapper.tpl.php | 0 .../islandora-basic-collection.tpl.php | 0 .../islandora_basic_collection.theme.inc | 114 ++++++++++++++++ 5 files changed, 135 insertions(+), 107 deletions(-) rename islandora_basic_collection/{ => theme}/islandora-basic-collection-grid.tpl.php (100%) rename islandora_basic_collection/{ => theme}/islandora-basic-collection-wrapper.tpl.php (100%) rename islandora_basic_collection/{ => theme}/islandora-basic-collection.tpl.php (100%) create mode 100644 islandora_basic_collection/theme/islandora_basic_collection.theme.inc diff --git a/islandora_basic_collection/islandora_basic_collection.module b/islandora_basic_collection/islandora_basic_collection.module index 5dc7ea2e..e0f53a02 100644 --- a/islandora_basic_collection/islandora_basic_collection.module +++ b/islandora_basic_collection/islandora_basic_collection.module @@ -146,7 +146,7 @@ function islandora_basic_collection_manage_object($object_id) { ); $form['collection_manager']['delete_members']['form'] = drupal_get_form('islandora_collection_deletion_form', $object_id); - + // Pass the form around any modules that are interested so that they can add their own collection management functions. module_invoke_all('islandora_collection_manager', $form); @@ -191,22 +191,26 @@ function islandora_basic_collection_access($object_id) { function islandora_basic_collection_theme($existing, $type, $theme, $path) { return array( 'islandora_basic_collection' => array( - 'template' => 'islandora-basic-collection', + 'file' => 'theme/islandora_basic_collection.theme.inc', + 'template' => 'theme/islandora-basic-collection', 'pattern' => 'islandora_basic_collection__', //we can add pids to the end of this pattern in our preprocess function // and templates will be able to have have a pid appended to the template name to overide a template on a per object basis //an example template would be named islandora-basic-image--islandora-27.tpl.phps 'variables' => array('islandora_object' => NULL), ), 'islandora_basic_collection_grid' => array( - 'template' => 'islandora-basic-collection-grid', + 'file' => 'theme/islandora_basic_collection.theme.inc', + 'template' => 'theme/islandora-basic-collection-grid', 'pattern' => 'islandora_basic_collection_grid__', 'variables' => array('islandora_object' => NULL, 'collection_results' => NULL), ), 'islandora_basic_collection_wrapper' => array( - 'template' => 'islandora-basic-collection-wrapper', + 'file' => 'theme/islandora_basic_collection.theme.inc', + 'template' => 'theme/islandora-basic-collection-wrapper', 'variables' => array('islandora_object' => NULL), ), 'islandora_basic_collection_management_form_table' => array( + 'file' => 'theme/islandora_basic_collection.theme.inc', 'arguments' => array('element' => NULL), 'file' => 'includes/CollectionManagerTable.inc', ), @@ -254,110 +258,11 @@ function islandora_basic_collection_islandora_view_object($object, $user) { } /** - * list view preprocess - * currently just calls normal view preprocess as variables are the same - * @param type $variables - */ -function islandora_basic_collection_preprocess_islandora_basic_collection_grid(&$variables) { - islandora_basic_collection_preprocess_islandora_basic_collection($variables); -} - -function islandora_basic_collection_preprocess_islandora_basic_collection_wrapper(&$variables) { - $page_number = (empty($_GET['page'])) ? 0 : $_GET['page']; - $page_size = (empty($_GET['pagesize'])) ? variable_get('islandora_basic_collection_page_size', '10') : $_GET['pagesize']; - $islandora_object = $variables['islandora_object']; - $results = islandora_basic_collection_get_objects($islandora_object, $page_number, $page_size); - $total_count = count($results); - pager_default_initialize($total_count, $page_size); - $variables['collection_pager'] = theme('pager', array('quantity' => 10)); - $display = (empty($_GET['display'])) ? 'list' : $_GET['display']; - if ($display == 'grid') { - $collection_content = theme('islandora_basic_collection_grid', array('islandora_object' => $islandora_object, 'collection_results' => $results)); - } - else { - $collection_content = theme('islandora_basic_collection', array('islandora_object' => $islandora_object, 'collection_results' => $results)); - } - $variables['collection_content'] = $collection_content; -} - -/** - * - * @global type $base_url - * @param array $variables - * an array of variables that will be passed to the theme function + * a wrappert to retrieve an object from Fedora + * @global object $user + * @param string $object_id + * @return null|\FedoraObject */ -function islandora_basic_collection_preprocess_islandora_basic_collection(&$variables) { -// base url - global $base_url; -// base path - global $base_path; - $islandora_object = $variables['islandora_object']; - module_load_include('inc', 'islandora', 'includes/islandora_dublin_core'); - try { - $dc = $islandora_object['DC']->content; - $dc_object = Dublin_Core::import_from_xml_string($dc); - } catch (Exception $e) { - drupal_set_message(t('Error retrieving object %s %t', array('%s' => $islandora_object->id, '%t' => $e->getMessage())), 'error'); - } - $page_number = (empty($_GET['page'])) ? 0 : $_GET['page']; - $page_size = (empty($_GET['pagesize'])) ? variable_get('islandora_basic_collection_page_size', '10') : $_GET['pagesize']; - $results = $variables['collection_results'];//islandora_basic_collection_get_objects($islandora_object, $page_number, $page_size); - $total_count = count($results); - $variables['islandora_dublin_core'] = $dc_object; - $variables['islandora_object_label'] = $islandora_object->label; - $variables['theme_hook_suggestions'][] = 'islandora_basic_collection__' . str_replace(':', '_', $islandora_object->id); - if (isset($islandora_object['OBJ'])) { - $full_size_url = $base_url . '/islandora/object/' . $islandora_object->id . '/datastream/OBJ/view'; - $variables['islandora_full_img'] = ''; - } - if (isset($islandora_object['TN'])) { - $thumbnail_size_url = $base_url . '/islandora/object/' . $islandora_object->id . '/datastream/TN/view'; - $variables['islandora_thumbnail_img'] = ''; - } - if (isset($islandora_object['MEDIUM_SIZE'])) { - $medium_size_url = $base_url . '/islandora/object/' . $islandora_object->id . '/datastream/MEDIUM_SIZE/view'; - $variables['islandora_medium_img'] = ''; - } - - $associated_objects_array = array(); - $start = $page_size * ($page_number); - $end = min($start + $page_size, $total_count); - - for ($i = $start; $i < $end; $i++) { - $pid = $results[$i]['object']['value']; - $fc_object = islandora_basic_collection_get_object($pid); - if (!isset($fc_object)) { - continue; //null object so don't show in collection view; - } - $associated_objects_array[$pid]['object'] = $fc_object; - try { - $dc = $fc_object['DC']->content; - $dc_object = Dublin_Core::import_from_xml_string($dc); - $associated_objects_array[$pid]['dc_array'] = $dc_object->as_formatted_array(); - } catch (Exception $e) { - drupal_set_message(t('Error retrieving object %s %t', array('%s' => $islandora_object->id, '%t' => $e->getMessage())), 'error'); - } - $object_url = 'islandora/object/' . $pid; - $thumbnail_img = ''; - $title = $results[$i]['title']['value']; - $associated_objects_array[$pid]['pid'] = $pid; - $associated_objects_array[$pid]['path'] = $object_url; - $associated_objects_array[$pid]['title'] = $title; - $associated_objects_array[$pid]['class'] = strtolower(preg_replace('/[^A-Za-z0-9]/', '-', $pid)); - if (isset($fc_object['TN'])) { - $thumbnail_img = ''; - } - else { - //TODO: change this default image url - $thumbnail_img = ''; - } - $associated_objects_array[$pid]['thumbnail'] = $thumbnail_img; - $associated_objects_array[$pid]['title_link'] = l($title, $object_url, array('html' => TRUE, 'attributes' => array('title' => $title))); - $associated_objects_array[$pid]['thumb_link'] = l($thumbnail_img, $object_url, array('html' => TRUE, 'attributes' => array('title' => $title))); - } - $variables['associated_objects_array'] = $associated_objects_array; -} - function islandora_basic_collection_get_object($object_id) { module_load_include('inc', 'islandora', 'RestConnection'); global $user; @@ -371,6 +276,15 @@ function islandora_basic_collection_get_object($object_id) { return $fedora_object; } +/** + * gets objects associated with this object with teh isMemberOf or isMemberOfCollection + * + * @global object $user + * @param object $object + * @param string $page_number + * @param string $page_size + * @return array + */ function islandora_basic_collection_get_objects($object, $page_number = 1, $page_size = 5) { $query = 'select $object $title $content from <#ri> where ($object $title diff --git a/islandora_basic_collection/islandora-basic-collection-grid.tpl.php b/islandora_basic_collection/theme/islandora-basic-collection-grid.tpl.php similarity index 100% rename from islandora_basic_collection/islandora-basic-collection-grid.tpl.php rename to islandora_basic_collection/theme/islandora-basic-collection-grid.tpl.php diff --git a/islandora_basic_collection/islandora-basic-collection-wrapper.tpl.php b/islandora_basic_collection/theme/islandora-basic-collection-wrapper.tpl.php similarity index 100% rename from islandora_basic_collection/islandora-basic-collection-wrapper.tpl.php rename to islandora_basic_collection/theme/islandora-basic-collection-wrapper.tpl.php diff --git a/islandora_basic_collection/islandora-basic-collection.tpl.php b/islandora_basic_collection/theme/islandora-basic-collection.tpl.php similarity index 100% rename from islandora_basic_collection/islandora-basic-collection.tpl.php rename to islandora_basic_collection/theme/islandora-basic-collection.tpl.php diff --git a/islandora_basic_collection/theme/islandora_basic_collection.theme.inc b/islandora_basic_collection/theme/islandora_basic_collection.theme.inc new file mode 100644 index 00000000..3e79e1f9 --- /dev/null +++ b/islandora_basic_collection/theme/islandora_basic_collection.theme.inc @@ -0,0 +1,114 @@ + 10)); + $display = (empty($_GET['display'])) ? 'list' : $_GET['display']; + if ($display == 'grid') { + $collection_content = theme('islandora_basic_collection_grid', array('islandora_object' => $islandora_object, 'collection_results' => $results)); + } + else { + $collection_content = theme('islandora_basic_collection', array('islandora_object' => $islandora_object, 'collection_results' => $results)); + } + $variables['collection_content'] = $collection_content; +} + +/** + * + * @global type $base_url + * @param array $variables + * an array of variables that will be passed to the theme function + */ +function islandora_basic_collection_preprocess_islandora_basic_collection(&$variables) { +// base url + global $base_url; +// base path + global $base_path; + $islandora_object = $variables['islandora_object']; + module_load_include('inc', 'islandora', 'includes/islandora_dublin_core'); + try { + $dc = $islandora_object['DC']->content; + $dc_object = Dublin_Core::import_from_xml_string($dc); + } catch (Exception $e) { + drupal_set_message(t('Error retrieving object %s %t', array('%s' => $islandora_object->id, '%t' => $e->getMessage())), 'error'); + } + $page_number = (empty($_GET['page'])) ? 0 : $_GET['page']; + $page_size = (empty($_GET['pagesize'])) ? variable_get('islandora_basic_collection_page_size', '10') : $_GET['pagesize']; + $results = $variables['collection_results']; //islandora_basic_collection_get_objects($islandora_object, $page_number, $page_size); + $total_count = count($results); + $variables['islandora_dublin_core'] = $dc_object; + $variables['islandora_object_label'] = $islandora_object->label; + $display = (empty($_GET['display'])) ? 'list' : $_GET['display']; + if ($display == 'grid') { + $variables['theme_hook_suggestions'][] = 'islandora_basic_collection_grid__' . str_replace(':', '_', $islandora_object->id); + } + else { + $variables['theme_hook_suggestions'][] = 'islandora_basic_collection__' . str_replace(':', '_', $islandora_object->id); + } + if (isset($islandora_object['OBJ'])) { + $full_size_url = $base_url . '/islandora/object/' . $islandora_object->id . '/datastream/OBJ/view'; + $variables['islandora_full_img'] = ''; + } + if (isset($islandora_object['TN'])) { + $thumbnail_size_url = $base_url . '/islandora/object/' . $islandora_object->id . '/datastream/TN/view'; + $variables['islandora_thumbnail_img'] = ''; + } + if (isset($islandora_object['MEDIUM_SIZE'])) { + $medium_size_url = $base_url . '/islandora/object/' . $islandora_object->id . '/datastream/MEDIUM_SIZE/view'; + $variables['islandora_medium_img'] = ''; + } + + $associated_objects_array = array(); + $start = $page_size * ($page_number); + $end = min($start + $page_size, $total_count); + + for ($i = $start; $i < $end; $i++) { + $pid = $results[$i]['object']['value']; + $fc_object = islandora_basic_collection_get_object($pid); + if (!isset($fc_object)) { + continue; //null object so don't show in collection view; + } + $associated_objects_array[$pid]['object'] = $fc_object; + try { + $dc = $fc_object['DC']->content; + $dc_object = Dublin_Core::import_from_xml_string($dc); + $associated_objects_array[$pid]['dc_array'] = $dc_object->as_formatted_array(); + } catch (Exception $e) { + drupal_set_message(t('Error retrieving object %s %t', array('%s' => $islandora_object->id, '%t' => $e->getMessage())), 'error'); + } + $object_url = 'islandora/object/' . $pid; + $thumbnail_img = ''; + $title = $results[$i]['title']['value']; + $associated_objects_array[$pid]['pid'] = $pid; + $associated_objects_array[$pid]['path'] = $object_url; + $associated_objects_array[$pid]['title'] = $title; + $associated_objects_array[$pid]['class'] = strtolower(preg_replace('/[^A-Za-z0-9]/', '-', $pid)); + if (isset($fc_object['TN'])) { + $thumbnail_img = ''; + } + else { + //TODO: change this default image url + $thumbnail_img = ''; + } + $associated_objects_array[$pid]['thumbnail'] = $thumbnail_img; + $associated_objects_array[$pid]['title_link'] = l($title, $object_url, array('html' => TRUE, 'attributes' => array('title' => $title))); + $associated_objects_array[$pid]['thumb_link'] = l($thumbnail_img, $object_url, array('html' => TRUE, 'attributes' => array('title' => $title))); + } + $variables['associated_objects_array'] = $associated_objects_array; +} + +?> From 586843910ae3bcb917e67af5b7a624ba483a52d6 Mon Sep 17 00:00:00 2001 From: Paul Pound Date: Thu, 31 May 2012 15:04:22 -0300 Subject: [PATCH 2/2] removed check for islandora content model forms in collection module --- islandora_basic_collection/islandora_basic_collection.module | 2 -- 1 file changed, 2 deletions(-) diff --git a/islandora_basic_collection/islandora_basic_collection.module b/islandora_basic_collection/islandora_basic_collection.module index 5875c972..8d14a042 100644 --- a/islandora_basic_collection/islandora_basic_collection.module +++ b/islandora_basic_collection/islandora_basic_collection.module @@ -65,7 +65,6 @@ function islandora_basic_collection_menu() { * Implements hook_menu_local_tasks_alter(). */ function islandora_basic_collection_menu_local_tasks_alter(&$data, $router_item, $root_path) { - if (module_exists('islandora_content_model_forms')) { // Add action link if ($root_path == 'islandora/object/%/manage/collection') { $object_id = $router_item['page_arguments'][0]; @@ -78,7 +77,6 @@ function islandora_basic_collection_menu_local_tasks_alter(&$data, $router_item, ); } } - } } /**