Sample Page - Record Highlighting - Filled Tile Highlight - Pedigree
This sample demonstrates record-level highlighting where coloured tiles are used to decorate selected records.
To get the effect shown here you need to reimplement the hookHighlighting_GetForRecord hook. It shows how to add a filled tile highlight based on the date of birth field ('A_DOB'). A different colour is used for odd and even birth years; hardly a real world example but it shows the basics of getting the field data and using it to generate a highlight.
Note also the legend that appears underneath the page content.
To see how the same code can highlight a search results page, click here.
To see how you can use a similar highlighting method at the field level, rather than the record level, click here.
Show/Hide Sample Code
# Hook function to apply highlighting for 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 - reference to map into which highlighting state can be
# stored for the current panel
# OPTIONAL
# Arg 9 - reference to map for future additional arguments; possibly undefined
sub hookHighlighting_GetForRecord {
my ($strTableSuffix, $rmHighlightingDef, $strContext, $rmEffects,
$rmFieldValues, $nPrimaryKey, $strFldPrefix, $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 record-level highlighting by adding
# a 'tile' to the rendered output for a record.
# A tile is a small coloured rectangle placed somewhere next
# to the rendered record. When rendering in results context,
# record highlight tiles are placed to the left of the hit #
# When rendering in plate context, record highlight tiles are
# placed underneath the record;
# The tile can contain supplied text, or can be blank.
# You can control the colour of the tile etc by setting an#
# inline CSS style. You can also make the tile link to a
# supplied URL.
# Extract the date of birth field value from the
# field results map:
my $date = $$rmFieldValues{$nPrimaryKey.':'.$strFldPrefix.'A_DOB'};
if (defined($date) && $date ne '') {
# This animal has its DOB set.
# Extract the year part:
my $strYear = substr($date, 0, 4);
# # Add a tile where the content is blank, the colour varies
# depending on whether the year is odd or even, and the
# link is to tenset:
$$rmEffects{'tile_dob_content'} = '';
$$rmEffects{'tile_dob_link'} = 'http://www.tenset.co.uk';
if (($strYear % 2) == 1 ) {
$$rmEffects{'tile_dob_inlinestyle_css'} =
'background-color: #00e0e0;';
# Set up an entry for the highlighting legend:
$$rmEffects{'tile_dob_legend'} =
$::g_q->escapeHTML("Born in an odd year");
} else {
$$rmEffects{'tile_dob_inlinestyle_css'} =
'background-color: #e000e0';
# Set up an entry for the highlighting legend:
$$rmEffects{'tile_dob_legend'} =
$::g_q->escapeHTML("Born in an even year");
}
}
}
# If the above code has not handled this highlighting definition itself,
# defer to the standard implementation:
if ($fUseStdImpl) {
&pdsHookStdImpl_Highlighting_GetForRecord(
$strTableSuffix, $rmHighlightingDef, $strContext, $rmEffects,
$rmFieldValues, $nPrimaryKey, $strFldPrefix, $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;
}
