Sample Page - Field Highlighting - Background Highlight - Search Results
This sample demonstrates field-level highlighting where you supply an inline CSS style to be applied to the whole field.
To get the effect shown here you need to reimplement the hookHighlighting_GetForField hook. This shows how to set the background colour for a field depending on the date of birth field ('A_DOB'). It tests the birth year, and if it is in the 1980's, returns a style string of background-color: #e0e000; which results in a yellow background, or if it is in the 1970's, returns a style string of background-color: #e02040; (reddish); hardly a real world example but it shows the basics of getting the field data and using it to generate a highlight.
To see how the same code can highlight a pedigree page, click here.
To see how you can use a similar highlighting method at the record level, rather than the field level, click here.
Show/Hide Sample Code
# Hook function to determine highlighting for a specific
# field within a record - storing the required highlighting
# decorations in a supplied map.
#
# Arg 1 - table suffix
# Arg 2 - reference to map holding decoded highlight definition
# Arg 3 - context
# Arg 4 - reference to map into which highlight effects are to be stored
# Arg 5 - reference to map of field values
# Arg 6 - primary key
# Arg 7 - field name prefix
# Arg 8 - full field name
# Arg 9 - reference to map into which highlighting state can be stored
# for the current panel
# OPTIONAL
# Arg 10 - reference to map for future additional arguments; possibly undefined
sub hookHighlighting_GetForField {
my ($strTableSuffix, $rmHighlightingDef, $strContext, $rmEffects,
$rmFieldValues, $nPrimaryKey, $strFldPrefix, $strFullFldName,
$rmState, $rmArgsEx) = @_;
# You probably dont want to interfere with the correct working of
# pedserve's internally defined highlighting methods. So what you
# should do is make your highlighting definition identifiable
# - by including terms that you can test for here. Then you can
# defer to the default implementation when necessary.
my $fUseStdImpl = 1;
# Example that checks for the term 'myhighlighting=yes'
# in the highlighting definition, and if present handles it here.
# To use this, you would have to define a highlighting during the
# script startup with a call to &pdsSetHighlightingDef() e.g.
# &pdsSetHighlightingDef('A_myhighlighting',
# 'label=Highlight DOB;myhighlighting=yes;');
# Note also the check against $strTableSuffix to ensure this is only
# used with animal records, and the check that this is not a
# pedserve-private definition:
if (!defined($$rmHighlightingDef{'pdsprivate'}) &&
$strTableSuffix eq 'A' &&
defined($$rmHighlightingDef{'myhighlighting'}) &&
$$rmHighlightingDef{'myhighlighting'} eq 'yes') {
# Dont defer to standard implementation below:
$fUseStdImpl = 0;
# This demonstrates highlighting by setting the background
# colour for the field.
if ($strFullFldName eq $strFldPrefix.'A_DOB') {
# This is the date of birth field.
# Extract the actual value of the field from the field results map:
my $date = $$rmFieldValues{$nPrimaryKey.':'.$strFldPrefix.'A_DOB'};
# If the DOB is valid and in the 1980's:
if (defined($date) && $date =~ m/^198.*/) {
# Set a CSS style for the field:
$$rmEffects{'inlinestyle_css'} = 'background-color: #e0e000;';
$$rmEffects{'inlinestyle_legend'} =
$::g_q->escapeHTML("Born in the 1980's");
}
# If the DOB is valid and in the 1970's:
if (defined($date) && $date =~ m/^197.*/) {
# Set a CSS style for the field:
$$rmEffects{'inlinestyle_css'} = 'background-color: #e02040;';
$$rmEffects{'inlinestyle_legend'} =
$::g_q->escapeHTML("Born in the 1970's");
}
}
}
# If the above code has not handled this highlighting definition
# itself, defer to the standard implementation:
if ($fUseStdImpl) {
&pdsHookStdImpl_Highlighting_GetForField(
$strTableSuffix, $rmHighlightingDef, $strContext, $rmEffects,
$rmFieldValues, $nPrimaryKey, $strFldPrefix, $strFullFldName,
$rmState, $rmArgsEx);
}
}
This custom highlighting method uses the date of birth field ('A_DOB'). When Pedserve fetches data from the database, it does not automatically fetch all the fields - it only fetches those it needs. For this reason, when your custom highlighting method is selected, you need to take steps to ensure that Pedserve will pull any fields you need. You do this by reimplementing the hookHighlighting_GetExtraFlds hook:
Show/Hide Sample Code
# Hook function to return extra fields that are required by a given
# highlighting method.
#
# Arg 1 - table suffix
# Arg 2 - reference to map holding decoded highlight definition
# Arg 3 - context
# Arg 4 - field name prefix
# OPTIONAL
# Arg 4 - reference to map for future additional arguments; possibly undefined
sub hookHighlighting_GetExtraFlds {
my ($strTableSuffix, $rmHighlightingDef,
$strContext, $strFldPrefix, $rmArgsEx) = @_;
# You probably dont want to interfere with the correct working
# of pedserve's internally defined highlighting methods.
# So what you should do is make your highlighting definition
# identifiable - by including terms that you can test
# for here. Then you can defer to the default implementation
# when necessary.
my $fUseStdImpl = 1;
my $strReturn = '';
# Trivial example that checks for the term 'myhighlighting=yes'
# in the highlighting definition, and if present returns a specific
# field name. To use this, you would have to define a highlighting
# method during the script startup with a call to
# &pdsSetHighlightingDef() e.g.
# &pdsSetHighlightingDef('A_myhighlighting',
# 'label=Highlight DOB;myhighlighting=yes;');
# Note also the check against $strTableSuffix to ensure this is only
# used with animal records, and
# the check that this is not a pedserve-private definition:
if (!defined($$rmHighlightingDef{'pdsprivate'}) &&
$strTableSuffix eq 'A' &&
defined($$rmHighlightingDef{'myhighlighting'}) &&
$$rmHighlightingDef{'myhighlighting'} eq 'yes') {
# Dont defer to standard implementation below:
$fUseStdImpl = 0;
# Set the fields to return:
# (this example will use the date of birth field to apply specific
# highlights for given dates etc)
$strReturn = $strFldPrefix.'A_DOB';
}
# If the above code has not handled this highlighting definition itself,
# defer to the standard implementation:
if ($fUseStdImpl) {
$strReturn = &pdsHookStdImpl_Highlighting_GetExtraFlds($strTableSuffix,
$rmHighlightingDef, $strContext, $strFldPrefix, $rmArgsEx);
}
return $strReturn;
}
