PHP Based Formatting

PHP Based Formatting for Custom Fields adds an incredible amount of flexibility to what you can do with the output of custom fields. With some basic knowledge of php programming you can start creating conditionals in no time to modify the output of custom fields.

Available PHP Classes and Variables

PHP Classes
$CustomFields	The JReviews CustomFields theme helper which lets you use the same methods described in How to customize the layout of custom fields in Theme_files.
$User	The Joomla User object contains information about the current logged in user.
$DB	The Joomla Database object allows you to query the database.
$Access	The JReviews Access class lets you quickly find out if a user has access to perform certain actions or determine if the user belongs to a specific user group.
Variables
$name	The custom field name.
$entry	The complete listing or review array depending on the location of the field.
$field	The array for the current custom field.
$fields	The array of all custom fields available for the entry.
$value	A string or array with the current field values. Multiple option fields like checkboxes and multiple select will be arrays, while other fields will be strings. For fields without options (text, decimal, integer, etc.) the $value matches the $text variable below.
$text	A string or array with the current field values. Multiple option fields like checkboxes and multiple select will be arrays, while other fields will be strings.
$image	A string or array with the current field option image name if one was assigned.
$output	An array with the current output for the field.

Examples

• Don't include php tags in the code.
• Always 'return' the output instead of using 'echo'.

Displaying the default output without changes

This is the most basic output. It doesn't change the default output of the field

return $output;

Hiding the field

return false;

Displaying a message for guests and the real output to logged in users

if($Access->isGuest()) {
   return "You must be logged in to view this field";
}
else {
   return $output;
}

Another way to accomplish the same thing:

if($User->id == 0) {
   return "You must be logged in to view this field";
}
else {
   return $output;
}

Display different images in banner field depending on selected value in select list

The following code goes in the PHP Based Formatting of the banner field.

$city = $CustomField->fieldValue('jr_city',$entry);
 
switch($city) {
   case 'san-francisco':
      $banner = "sanfrancisco.jpg";
   break;
   case 'new-york':
      $banner = "newyork.jpg";
   break;
   default: // All other cities display the banner normally
       return $output;
   break;
}
 
$banner = '/media/banners' . $banner;
 
return "<img src=".$banner." />";

Display checkbox or multiple select field only if at least two options are checked

$count = is_array($output) ? count($output) : 1;
 
 
if($count > 1) {
   return $output;
}
else {
   return false;
}

Hiding the output of a field until a button is clicked

We use the listing id as part of the javascript code so that the elements have unique classes if used in list pages.

$id = $entry['Listing']['listing_id'];
$shown = '<span class="jrPhoneShow'.$id.' jrButton">Click to reveal info</span>';
$hidden = '<span class="jrPhoneHidden'.$id.' jrHidden">'.$text.'</span>'; 
$script = '
<script>
   (function($) {
      $(".jrPhoneShow'.$id.'").on("click",function() {
         $(this).hide();
         $(".jrPhoneHidden'.$id.'").show();
      });
   })(jQuery);
</script>';  
return $shown . $hidden . $script;

Performing calculations with fields

If you have fields with numeric values and need to calculate a different value you can use a banner field to perform the calculations.

$price = $CustomFields->fieldValue('jr_price',$entry);
$volume = $CustomFields->fieldValue('jr_volume',$entry);
$total = $price * $volume;
return $total;

If one of the values is zero, you can display the default output of the banner instead:

$price = $CustomFields->fieldValue('jr_price',$entry);
$volume = $CustomFields->fieldValue('jr_volume',$entry);
$total = $price * $volume;
if($total > 0) {
   return $total;
}
else {
   return $output;
}