Fixed and improved version

README.md

@@ -0,0 +1,63 @@
+# Facets
+
+## Description
+
+Plugin for Omeka Classic. Once installed and active, allows to insert a Faceted search refining block containing available metadata values extracted from browsing context. Works for both Items and Collections.
+
+Settings allow to choose the hook to be used, which criteria to use for search refinement, whether to ignore single entries, sorting order for values, whether to show values popularity, whether to use an horizontal or vertical layout, whether to make the block collapsible, etc.
+
+## Credits
+
+Original development is part of the [Armarium](https://www.armarium-hautsdefrance.fr/) Project, managed by the french association [AR2L Hauts de France](http://www.ar2l-hdf.fr/).
+
+Fixed and improved version by [DBinaghi](https://github.com/DBinaghi).
+
+## Installation
+Uncompress files and rename plugin folder "Facets".
+
+Then install it like any other Omeka plugin.
+
+## (optional) Theme customization
+
+Facets will appear by default in the **Items browse** and **Collections browse** pages, where the `public_items_browse` and `public_collections_browse` hooks are set. It is possible to use instead a custom `public_facets` hook, that can be positioned wherever needed (`YOUR_THEME/items/browse.php` or `YOUR_THEME/common/header.php`, f.i.) according to the theme used; in such a case, the use of [get_specific_plugin_hook_output](http://omeka.readthedocs.io/en/latest/Reference/libraries/globals/get_specific_plugin_hook_output.html) function is suggested. 
+
+For **Thanks, Roy** theme, for example, best way is to change `common/header.php` code using the custom hook, while unchecking **Block collapsible** option and setting **Vertical** as **Block layout**:
+```php
+<div id="search-container" role="search">
+    <?php if (get_theme_option('use_advanced_search') === null || get_theme_option('use_advanced_search')): ?>
+    <?php echo search_form(array('show_advanced' => true)); ?>
+    <?php else: ?>
+    <?php echo search_form(); ?>
+    <?php endif; ?>
+</div>
+<?php echo get_specific_plugin_hook_output('Facets', 'public_facets', array('view' => $this)); ?>
+```
+For **Berlin** theme, instead, check **Block collapsible** option, set **Horizontal** as **Block layout** and then add the custom hook in `items/browse.php` and `collections/browse.php`:
+```php
+<?php echo item_search_filters(); ?>
+
+<?php echo get_specific_plugin_hook_output('Facets', 'public_facets', array('view' => $this)); ?>
+
+<?php echo pagination_links(); ?>
+```
+
+Background and foreground colors, as well as other parameters, can be customized in `facets.css` file (`views/public/css` folder).
+
+## Plugin configuration
+
+The elements used for search refinement can be selected in the configuration page; best practice suggestion is to activate only elements that are displayed in the browse page, and that are offering some kind of data aggregation (a unique id would not offer any really useful refinement).
+
+Similarly, one can choose to also include **Item Types**, **Collections** and **Tags** to the facets block.
+
+**Single values** can be exluded as not really significant, although they will be listed anyway if less than 5 values are available.
+
+Facets block can be set up for **vertical** or **horizontal** layout, according to the theme layout; and it can be made **collapsible**, to use less vertical space (recommended for horizontal layout).
+
+Style for facets can be either **dropdown selectbox**, or **checkbox**; this last one allows to choose more values, while with the first one one value excludes other. For checkbox style, a **minimum amount of values** can be set too.
+
+Sorting order can be **alphabetical**, or **first by popularity and then alphabetical**. Popularity count can be shown, if needed.
+
+**Date** element filter's behaviour is a bit different: dates are ordered decrescently, and only year is displayed; consequently, the matching will be with the beginning of the date (assuming the format is '_yyyy-mm-dd_'). By default, the following are considered date fields: '**Date**', '**Date Available**', '**Date Created**', '**Date Accepted**', '**Date Copyrighted**', '**Date Submitted**', '**Date Issued**', '**Date Modified**', '**Date Valid**' (the list can be changed in browse.php file).
+
+## Licence
+MIT Licence, please credit AR2L [AR2L Hauts de France](http://www.ar2l-hdf.fr/) and [Daniele Binaghi](https://github.com/DBinaghi).

config_form.php

@@ -0,0 +1,289 @@
+<?php 
+	$view = get_view();
+?>
+<style type = "text/css">
+	.boxes, .boxes-left {
+		vertical-align: middle;
+	}
+	.boxes {
+		text-align: center;
+	}
+	.field select {
+		margin-bottom: 0;
+	}
+</style>
+
+<h2><?php echo __('Use'); ?></h2>
+
+<div class="field">
+	<div class="two columns alpha">
+		<?php echo $view->formLabel('facets_public_hook', __('Public Hooks')); ?>
+	</div>
+	<div class="inputs five columns omega">
+		<p class="explanation">
+			<?php echo __('The hooks you want to use: Omeka\'s default <code>public_items_browse</code> and <code>public_collections_browse</code>, already coded into every page (so no changes are needed), normally showing up at the end of the page; or the plugin\'s own <code>public_facets</code>, that has to be coded into relevant theme pages but can be used wherever deemed right.'); ?>
+		</p>
+		<?php echo $view->formRadio('facets_public_hook',
+			get_option('facets_public_hook'),
+			null,
+			array(
+				'default' => 'public_items_browse & public_collections_browse',
+				'custom' => 'public_facets',
+			)); 
+		?>
+    </div>
+</div>
+
+<h2><?php echo __('Aspect'); ?></h2>
+
+<div class="field">
+	<div class="two columns alpha">
+		<?php echo $view->formLabel('facets_description', __('Description')); ?>
+	</div>
+	<div class="inputs five columns omega">
+		<p class="explanation">
+			<?php echo __('If checked, a short description will be shown above all values.'); ?>
+		</p>
+		<?php echo $view->formCheckbox('facets_description', get_option('facets_description'), null, array('1', '0')); ?>
+    </div>
+</div>
+
+<div class="field">
+	<div class="two columns alpha">
+		<?php echo $view->formLabel('facets_count', __('Facet Count')); ?>
+	</div>
+	<div class="inputs five columns omega">
+		<p class="explanation">
+			<?php echo __('For all checkbox style fields, the maximum amount of values to be displayed (0 means all values will be displayed).'); ?>
+		</p>
+		<?php echo $view->formText('facets_count', get_option('facets_count')); ?>
+    </div>
+</div>
+
+<div class="field">
+	<div class="two columns alpha">
+		<?php echo $view->formLabel('facets_direction', __('Block Layout')); ?>
+	</div>
+	<div class="inputs five columns omega">
+		<p class="explanation">
+			<?php echo __('The layout direction of the facets block.'); ?>
+		</p>
+		<?php echo $view->formSelect(
+			'facets_direction',
+			get_option('facets_direction'),
+			array(),
+			array(
+				'horizontal' => __('Horizontal (useful for themes with top main navigation menu)'),
+				'vertical' => __('Vertical (useful for themes with side main navigation menu)')
+			)); 
+		?>
+   </div>
+</div>
+
+<div class="field">
+	<div class="two columns alpha">
+		<?php echo $view->formLabel('facets_collapsible', __('Collapsible Block')); ?>
+	</div>
+	<div class="inputs five columns omega">
+		<p class="explanation">
+			<?php echo __('If checked, facets block will be collapsible (tip: as it saves space, it\'s particularly useful with horizontal theme layouts).'); ?>
+		</p>
+		<?php echo $view->formCheckbox('facets_collapsible', get_option('facets_collapsible'), null, array('1', '0')); ?>
+    </div>
+</div>
+
+<h2><?php echo __('Elements'); ?></h2>
+
+<div class="field">
+	<div class="inputs seven columns omega">
+		<p class="explanation">
+			<?php echo __('The elements that can be used for search refinement. Item and Collection columns to (de)activate, Style column to choose the facet style, Sort order column to choose sorting order, Popularity column to show counters near names.'); ?>
+		</p>
+		<table id="facets_elements-table">
+			<thead>
+				<tr>
+					<th class="boxes"><?php echo __('Element Name'); ?></th>
+					<th class="boxes"><?php echo __('Item'); ?></th>
+					<th class="boxes"><?php echo __('Collection'); ?></th>
+					<th class="boxes"><?php echo __('Style'); ?></th>
+					<th class="boxes"><?php echo __('Sort Order'); ?></th>
+					<th class="boxes"><?php echo __('Popularity'); ?></th>
+				</tr>
+			</thead>
+			<tbody>
+				<?php
+					$current_element_set = null;
+					foreach ($elements as $element):
+						if ($element->set_name != $current_element_set):
+							$current_element_set = $element->set_name;
+				?>
+				<tr>
+					<th colspan="6">
+						<strong><?php echo __($current_element_set); ?></strong>
+					</th>
+				</tr>
+				<?php 	endif; ?>
+				<tr>
+					<td class="boxes-left"><?php echo __($element->name); ?></td>
+					<td class="boxes">
+						<?php 
+							echo $view->formCheckbox(
+								"elements[{$element->name}][item]",
+								'1', 
+								array(
+									'disableHidden' => true,
+									'checked' => (isset($settings['elements'][$element->name]['item']) && $settings['elements'][$element->name]['item'] == 1)
+								)
+							); 
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							if ($element->set_name == 'Dublin Core') {
+								echo $view->formCheckbox(
+									"elements[{$element->name}][collection]",
+									'1', 
+									array(
+										'disableHidden' => true,
+										'checked' => (isset($settings['elements'][$element->name]['collection']) && $settings['elements'][$element->name]['collection'] == 1)
+									)
+								); 
+							} else {
+								echo "&nbsp";
+							}								
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							$style = (isset($settings['elements'][$element->name]['style']) ? $settings['elements'][$element->name]['style'] : '');
+							echo $view->formSelect(
+								"elements[{$element->name}][style]",
+								$style,
+								array(),
+								array(
+									'dropdown' => __('Dropdown'),
+									'checkbox' => __('Checkbox')
+								)
+							); 
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							$sortOrder = (isset($settings['elements'][$element->name]['sort']) ? $settings['elements'][$element->name]['sort'] : '');
+							echo $view->formSelect(
+								"elements[{$element->name}][sort]",
+								$sortOrder,
+								array(),
+								array(
+									'alpha' => __('Alphabetical'),
+									'count_alpha' => __('Popularity first, then alphabetical')
+								)
+							); 
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							echo $view->formCheckbox(
+								"elements[{$element->name}][popularity]",
+								'1', 
+								array(
+									'disableHidden' => true,
+									'checked' => (isset($settings['elements'][$element->name]['popularity']) && $settings['elements'][$element->name]['popularity'] == 1)
+								)
+							); 
+						?>
+					</td>
+				</tr>
+			<?php endforeach; ?>
+				<tr>
+					<th colspan="6">
+						<strong><?php echo __('Extra parameters'); ?></strong>
+					</th>
+				</tr>
+			<?php 
+				$extraParameters = array(
+					'item_types' => array('label' => 'Item Type', 'collection' => 0),
+					'collections' => array('label' => 'Collection', 'collection' => 0),
+					'tags' => array('label' => 'Tags', 'collection' => 0),
+					'users' => array('label' => 'Owner', 'collection' => 1),
+					'public' => array('label' => 'Public', 'collection' => 1),
+					'featured' => array('label' => 'Featured', 'collection' => 1)
+				);
+				foreach ($extraParameters as $key => $value):
+			?>
+				<tr>
+					<td class="boxes-left"><?php echo __($value['label']); ?></td>
+					<td class="boxes">
+						<?php 
+							echo $view->formCheckbox(
+								"{$key}[item]",
+								'1', 
+								array(
+									'disableHidden' => true,
+									'checked' => (isset($settings[$key]['item']) && $settings[$key]['item'] == 1)
+								)
+							); 
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							if ($value['collection']) {
+								echo $view->formCheckbox(
+									"{$key}[collection]",
+									'1', 
+									array(
+										'disableHidden' => true,
+										'checked' => isset($settings[$key]['collection'])
+									)
+								); 
+							} else {
+								echo "&nbsp;";
+							}
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							$style = (isset($settings[$key]['style']) ? $settings[$key]['style'] : '');
+							echo $view->formSelect(
+								"{$key}[style]",
+								$style,
+								array(),
+								array(
+									'dropdown' => __('Dropdown'),
+									'checkbox' => __('Checkbox')
+								)
+							); 
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							$sort = (isset($settings[$key]['sort']) ? $settings[$key]['sort'] : '');
+							echo $view->formSelect(
+								"{$key}[sort]",
+								$sort,
+								array(),
+								array(
+									'alpha' => __('Alphabetical'),
+									'count_alpha' => __('Popularity first, then alphabetical')
+								)
+							); 
+						?>
+					</td>
+					<td class="boxes">
+						<?php 
+							echo $view->formCheckbox(
+								"{$key}[popularity]", 
+								'1', 
+								array(
+									'disableHidden' => true,
+									'checked' => (isset($settings[$key]['popularity']) && $settings[$key]['popularity'] == 1)
+								)
+							); 
+						?>
+					</td>
+				</tr>
+			<?php endforeach; ?>
+			</tbody>
+		</table>
+	</div>
+</div>