v2.0

Added Title Line/Image positioning, Configurable fields for title line
(type + meta), fixed barcode integration

Author: Stephen

README.md

@@ -15,15 +15,20 @@ Download the whole diretory and rename to "pdf_export". Then you can install it
 
 - Resource Types to exclude (pick from list). This will hide PDF Export link from the view pages of those resources.
 - Fonts: can configure a filepath (relative to webroot, not a URL) to a custom font (ttf file) that sits on your server for heading (usually bold) and body/list text (usually regular).
-- URL to image to use as header 
-- Exclude title from top of PDF 
-- Fields to include (2 fields, multiselect and comma separated list of metadata field IDs, ie: 67,73,78,etc)
+- URL to image to use as header
+- Position header image 
+- Exclude title header from top of PDF 
+- Choose fields for title header
 - Image size to use in PDF. Defaults to "hdr", but for some installs this is huge and unnecessary.
 - Set image height (inches) 
+- Position title line and image horizontally (L,C,R)
+- Fields to include (2 fields, multiselect and comma separated list of metadata field IDs, ie: 67,73,78,etc)
 - Integration with [whereabouts plugin](https://github.com/ssuess/resourcespace-plugin-whereabouts)  (if installed)
+- Integration with [rs_barcode plugin](https://github.com/ssuess/rs_barcode)  (if installed)
 
 
 ## Changelog
+* `v 2.0` - Added Title Line/Image positioning, Configurable fields for title line (type + meta), fixed barcode integration
 * `v 1.9` - Fixed crashing bug in collection div, added special perm check (pdf) for config rights. Fix square img problem.
 * `v 1.8` - Output barcode from specified field
 * `v 1.7` - New config exclude title, fix if no logo specified, allow full height image (to margin)

config/config.php

@@ -8,13 +8,16 @@
 $pdf_export_admin_edit_access=array();
 $pdf_export_logo_url ="";
 $pdf_export_logo_deets=".5,.3,0,.5";
+$pdf_export_title_array="8,12";
 $pdf_export_exclude_title=false;
+$pdf_export_includetype_title=true;
 $pdf_export_fields_include=array();
 $pdf_export_fields_include_hidden ="";
 $pdf_export_ttf_header_font_path="";
 $pdf_export_ttf_list_font_path="";
 $pdf_export_imagesizeid="";
 $pdf_export_imgheight="6";
+$pdf_export_imagejustify="L";
 $pdf_export_whereabouts_integration=false;
 $pdf_export_barcode=false;
 $pdf_export_barcode_field="80";

include/general.php

@@ -41,7 +41,7 @@ function create_pdf_export_pdf($ref,$is_collection=false,$size="letter",$cleanup
 	# This leaves the pdfs and jpg previews in filestore/annotate so that they can be grabbed later.
 	# $cleanup will result in a slightly different path that is not cleaned up afterwards.
 
-	global $pdf_export_barcode_field,$pdf_export_barcode_type,$pdf_export_barcode,$pdf_export_exclude_title,$pdf_export_logo_deets,$pdf_export_imgheight,$onetimenotes,$pdf_export_whereabouts_integration,$pdf_export_imagesizeid,$pdf_export_ttf_list_font_path,$pdf_export_ttf_header_font_path,$pdf_export_fields_include_hidden,$pdf_export_logo_url,$contact_sheet_preview_size,$pdf_output_only_annotated,$lang,$userfullname,$view_title_field,$baseurl,$imagemagick_path,$imagemagick_colorspace,$ghostscript_path,$previewpage,$storagedir,$storageurl,$pdf_export_font,$access,$k;
+	global $pdf_export_title_array,$pdf_export_includetype_title,$pdf_export_imagejustify,$pdf_export_barcode_field,$pdf_export_barcode_type,$pdf_export_barcode,$pdf_export_exclude_title,$pdf_export_logo_deets,$pdf_export_imgheight,$onetimenotes,$pdf_export_whereabouts_integration,$pdf_export_imagesizeid,$pdf_export_ttf_list_font_path,$pdf_export_ttf_header_font_path,$pdf_export_fields_include_hidden,$pdf_export_logo_url,$contact_sheet_preview_size,$pdf_output_only_annotated,$lang,$userfullname,$view_title_field,$baseurl,$imagemagick_path,$imagemagick_colorspace,$ghostscript_path,$previewpage,$storagedir,$storageurl,$pdf_export_font,$access,$k;
 	$date= date("m-d-Y h:i a");
 
 	include_once(dirname(__FILE__) . '/../../../include/search_functions.php');
@@ -130,8 +130,11 @@ public function MultiRow($left, $right) {
 	$ttflistfontvar = $configarray['pdf_export_ttf_list_font_path'];
 	$logourlvar = $configarray['pdf_export_logo_url'];
 	$logodeetsvar=$configarray['pdf_export_logo_deets'];
+	$titleincludetypevar=$configarray['pdf_export_includetype_title'];
+	$titlearrayvar=$configarray['pdf_export_title_array'];
 	$imagesizeidvar = $configarray['pdf_export_imagesizeid'];
 	$imageheightvar = $configarray['pdf_export_imgheight'];
+	$imagejustifyvar = $configarray['pdf_export_imagejustify'];
 	$exportfieldslistvar = $configarray['pdf_export_fields_include_hidden'];
 	$excludetitlevar = $configarray['pdf_export_exclude_title'];
 	$exportbarcodecvar = $configarray['pdf_export_barcode'];
@@ -142,8 +145,11 @@ public function MultiRow($left, $right) {
 	$ttflistfontvar = $pdf_export_ttf_list_font_path;
 	$logourlvar = $pdf_export_logo_url;
 	$logodeetsvar=$pdf_export_logo_deets;
+	$titleincludetypevar=$pdf_export_includetype_title;
+	$titlearrayvar=$pdf_export_title_array;
 	$imageheightvar=$pdf_export_imgheight;
 	$imagesizeidvar = $pdf_export_imagesizeid;
+	$imagejustifyvar = $pdf_export_imagejustify;
 	$exportfieldslistvar = $pdf_export_fields_include_hidden;
 	$excludetitlevar = $pdf_export_exclude_title;
 	$exportbarcodecvar = $pdf_export_barcode;
@@ -191,7 +197,7 @@ public function MultiRow($left, $right) {
 	$mylogoheight=0;
 	}
 	$includearr=explode(",",$exportfieldslistvar);
-	
+	$titlearrayvararr=explode(",",$titlearrayvar);
 	$page=1;
 	$totalpages=1;
 	$m=1;
@@ -268,9 +274,18 @@ public function MultiRow($left, $right) {
 			$pdf->SetFont('helvetica', 'B', 15,'',false);
 			}	
 			$ypos=$pdf->GetY();	
-			if ($excludetitlevar==0) {								
-			$righttitle=str_replace("\\r\\n","\n",strtoupper(i18n_get_translated($resourcedata['field'.$view_title_field])));
-			$pdf->MultiCell(0,0, $righttitle, 0, 'L', 0, 1,.45,$ypos+$logofinalY, true, 0,false,false);		
+			if ($excludetitlevar==0) {
+			if ($titleincludetypevar==0) {
+			$toplinecomposite='';
+			} else {
+			$toplinecomposite= i18n_get_translated(get_resource_type_name($resourcedata['resource_type'])).' - ';
+			}
+			foreach ($titlearrayvararr as $toplineitem) {
+			$toplinecomposite .= ltrim(i18n_get_translated(get_data_by_field($ref,$toplineitem)),',') . " - ";
+			}
+			$toplinestring = substr($toplinecomposite, 0, -3);							
+			$righttitle=str_replace("\\r\\n","\n",strtoupper($toplinestring));
+			$pdf->MultiCell(0,0, $righttitle, 0, $pdf_export_imagejustify, 0, 1,.45,$ypos+$logofinalY, true, 0,false,false);		
 			// store current object
 			$pdf->startTransaction();
 			// get the number of lines for multicell
@@ -295,7 +310,7 @@ public function MultiRow($left, $right) {
 			$titlelineratio = .2;
 			$ypos=$logofinalY+$titleheight+.5;$pdf->SetY($ypos);
 			}
-			$pdf->Image($imgpath,.5,$ypos,$imagewidth,$imageheight,"jpg",$baseurl. '/?r=' . $ref);	
+			$pdf->Image($imgpath,.5,$ypos,$imagewidth,$imageheight,"jpg",$baseurl. '/?r=' . $ref,'','','',$pdf_export_imagejustify);	
 			// set color for background
 			$pdf->SetFillColor(255, 255, 255);
 			$pdf->setCellPaddings(0.01, 0.06, 0.01, 0.1);

languages/en.php

@@ -12,13 +12,17 @@
 $lang["pdf_export_chooseconfig"]="Select a config to use: ";
 $lang["pdf_export_logo_url"]="PDF header image (URL)<br />Supports jpg, png, and svg<br /><br />";
 $lang["pdf_export_logo_deets"]="Header image: Left, Top, Width and Height in inches (numeric and comma separated, use 0 for auto calc of width/height)<br /><br />";
-$lang["pdf_export_exclude_title"]="Exclude file title from top of page.<br /><br />";
+$lang["pdf_export_exclude_title"]="Exclude title line from top of page.<br /><br />";
+$lang["pdf_export_includetype_title"]="Include file type in title line.<br /><br />";
+$lang["pdf_export_title_array"]="Field ids to include in title line.<br />(comma separated)<br /><br />";
 $lang["pdf_export_fields_include"]="Fields to include in the export, in order<br /><br />";
 $lang["pdf_export_fields_include_hidden"]="This field just shows the IDs (see <a href='/pages/admin/admin_resource_type_fields.php'>here</a>) from fields you chose above. You can type or rearrange them by hand here to change the order above.<br /><br />";
 $lang["pdf_export_ttf_header_font_path"]="Header font conversion from ttf (filepath)<br />(relative to webroot)<br /><br />";
 $lang["pdf_export_ttf_list_font_path"]="List font conversion from ttf (filepath)<br />(relative to webroot)<br /><br />";
 $lang["pdf_export_imagesizeid"]="Image size to use<br />(use ref ID of <a href='/pages/admin/admin_size_management.php'>preview size</a>)<br /><br />";
 $lang["pdf_export_imgheight"]="Image height on page (inches)<br />(if image width is wider than page it will be scaled down and this value will be ignored)<br /><br />";
+$lang["pdf_export_imagejustify"]="Title & Image position on page<br />(horizontal - Left, Center, or Right)<br /><br />";
+$lang["pdf_export_imagejustify_choices"]=array('L','C','R');
 $lang['pdf_export_whereabouts_integration']="whereabouts plugin integration?<br/>(includes current whereabouts in list, use 'w' as include field ID in list above)<br /><br />";
 $lang["pdf_export_configuration"]="PDF Export Options";
 $lang["extensions_to_exclude"]="Extensions to exclude<br />(comma separated):";

languages/fr.php

@@ -14,9 +14,13 @@
 $lang["pdf_export_fields_include"]="Champs de la base de données à inclure<br />(utilisez ref IDs de <a href='/pages/admin/admin_resource_type_fields.php'>métadonnées</a>, séparées par des virgules et dans l'ordre que vous voulez qu'ils apparaissent)<br /><br />";
 $lang["pdf_export_ttf_header_font_path"]="Police en-tete - convertir un fichier ttf<br />(chemin relatif à webroot)<br /><br />";
 $lang["pdf_export_ttf_list_font_path"]="Police de liste - convertir un fichier ttf<br />(chemin relatif à webroot)<br /><br />";
+$lang["pdf_export_exclude_title"]="Exclure la ligne de titre du dessus de la page.<br /><br />";
+$lang["pdf_export_includetype_title"]="Inclure type dans la ligne titre.<br /><br />";
+$lang["pdf_export_title_array"]="Champs de la base de données à inclure dans la ligne titre (utilisez ref IDs de <a href='/pages/admin/admin_resource_type_fields.php'>métadonnées</a>, séparées par des virgules et dans l'ordre que vous voulez qu'ils apparaissent)<br /><br />";
 $lang["pdf_export_imagesizeid"]="Taille de l'image à utiliser<br />(utilisez ref IDs de <a href='/pages/admin/admin_size_management.php'>'Manage Sizes'</a>)<br /><br />";
 $lang['pdf_export_whereabouts_integration']="whereabouts plugin integration?<br/>(includes current whereabouts in list, use 'w' as include field ID in list above)<br /><br />";
-
+$lang["pdf_export_imagejustify"]="Position de la ligne titre et d'image sur la page (horizontale - gauche (L), central (C), ou droit (R))<br /><br />";
+$lang["pdf_export_imagejustify_choices"]=array('L','C','R');
 $lang["pdf_export_configuration"]="PDF Export Options";
 $lang["extensions_to_exclude"]="Extensions to exclude<br />(séparées par des virgules):";
 $lang["resource_types_to_exclude"]="Resource Types à exclure<br />(case à cocher):";

pages/pdf_export_config.php

@@ -163,7 +163,6 @@ function loadIt() {
 <?php } ?>
 
 <div class="BasicsBox" >
-
 <?php if (!$is_collection){?>
 <p><a href="<?php echo $baseurl_short?>pages/view.php?ref=<?php echo $ref?>&search=<?php echo urlencode($search)?>&offset=<?php echo $offset?>&order_by=<?php echo $order_by?>&sort=<?php echo $sort?>&archive=<?php echo $archive?>&pdf_export=true" onClick="return CentralSpaceLoad(this);">&lt;&nbsp;<?php echo $lang["backtoresourceview"]?></a></p>
 <?php } else {?>

pages/setup.php

@@ -23,8 +23,11 @@
 $page_def[] = config_add_text_input('pdf_export_logo_url', $lang["pdf_export_logo_url"]);
 $page_def[] = config_add_text_input('pdf_export_logo_deets', $lang["pdf_export_logo_deets"]);
 $page_def[] = config_add_boolean_select('pdf_export_exclude_title', $lang['pdf_export_exclude_title']);
+$page_def[] = config_add_boolean_select('pdf_export_includetype_title', $lang['pdf_export_includetype_title']);
+$page_def[] = config_add_text_input('pdf_export_title_array', $lang["pdf_export_title_array"]);
 $page_def[] = config_add_text_input('pdf_export_imagesizeid', $lang["pdf_export_imagesizeid"]);
 $page_def[] = config_add_text_input('pdf_export_imgheight', $lang["pdf_export_imgheight"]);
+$page_def[] = config_add_single_select('pdf_export_imagejustify', $lang["pdf_export_imagejustify"],$lang["pdf_export_imagejustify_choices"],false);
 
 $pdf_export_full_fields_options=array();
 $allfields = sql_query('SELECT ref, title FROM resource_type_field;');
@@ -41,10 +44,11 @@
 if (isset($whereabouts_rt_exclude)) {
 $page_def[] = config_add_boolean_select('pdf_export_whereabouts_integration', $lang['pdf_export_whereabouts_integration']);
 }
+if (isset($barcode_display_fields)) {
 $page_def[] = config_add_boolean_select('pdf_export_barcode', $lang['pdf_export_barcode']);
 $page_def[] = config_add_single_select('pdf_export_barcode_type', $lang['pdf_export_barcode_type'],$lang['pdf_export_barcode_type_choices'],false);
 $page_def[] = config_add_text_input('pdf_export_barcode_field', $lang["pdf_export_barcode_field"]);
-
+}
 // Do the page generation ritual -- don't change this section.
 $upload_status = config_gen_setup_post($page_def, $plugin_name);
 include '../../../include/header.php';
@@ -113,6 +117,10 @@ function do_alert($msg)
         prejson.push({name:"pdf_export_exclude_title", value: titex});
         var bctrue = jQuery('#pdf_export_barcode').val();
         prejson.push({name:"pdf_export_barcode", value: bctrue});
+		var titincludetype = jQuery('#pdf_export_includetype_title').val();
+        prejson.push({name:"pdf_export_includetype_title", value: titincludetype});
+		var imgposhoriz = jQuery('#pdf_export_imagejustify').val();
+        prejson.push({name:"pdf_export_imagejustify", value: imgposhoriz});
         var bctype = jQuery('#pdf_export_barcode_type').val();
         prejson.push({name:"pdf_export_barcode_type", value: bctype});        
         var confignamevalue = jQuery('#configname').val();
@@ -146,6 +154,12 @@ function do_alert($msg)
         toggleFields();
     });
 
+ toggleFieldstitle(); //call this first so we start out with the correct visibility depending on the selected form values
+    //this will call our toggleFields function every time the selection value of our underAge field changes
+    jQuery("#pdf_export_exclude_title").change(function () {
+        toggleFieldstitle();
+    });
+
 });
 //this toggles the visibility of our parent permission fields depending on the current selected value of the underAge field
 function toggleFields() {
@@ -157,6 +171,17 @@ function toggleFields() {
             jQuery('#pdf_export_barcode_field').parent().hide();
             }
 
+}    
+
+function toggleFieldstitle() {
+    if (jQuery('#pdf_export_exclude_title').val()==0) {
+            jQuery('#pdf_export_includetype_title').parent().show();
+            jQuery('#pdf_export_title_array').parent().show();
+               } else {
+            jQuery('#pdf_export_includetype_title').parent().hide();
+            jQuery('#pdf_export_title_array').parent().hide();
+            }
+            
 }    
 </script><div id="pdfconfigwrapper"><?php
 config_gen_setup_html($page_def, $plugin_name, $upload_status, $plugin_page_heading);

pdf_export.yaml

@@ -1,6 +1,6 @@
 name    : pdf_export
 author  : Stephen Suess
-version : 1.9
+version : 2.0
 desc    : Enable export of detail view info to PDF
 info_url: https://github.com/ssuess/resourcespace-plugin-pdf_export
 config_url: /plugins/pdf_export/pages/setup.php