Function Module_purchase->_is_filtered_out

Definitions

site/pages/modules/purchase.php

  • See if a product is filtered out.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$product_object object No No required parameter N/A N/A The product object
$type_code ID_TEXT No No required parameter N/A N/A The product codename
$details array No No required parameter N/A N/A The product details
$filter string No No required parameter N/A N/A Filter prefix
$type_filter ?integer No No required parameter N/A N/A Filter by eCommerce type (null: no filter)
$must_support_money boolean No No required parameter N/A N/A Filter out products that don't support money
$must_support_points boolean No No required parameter N/A N/A Filter out products that don't support points

Returns

  • Is filtered
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * See if a product is filtered out.
 *
 * @param  object $product_object The product object
 * @param  ID_TEXT $type_code The product codename
 * @param  array $details The product details
 * @param  string $filter Filter prefix
 * @param  ?integer $type_filter Filter by eCommerce type (null: no filter)
 * @param  boolean $must_support_money Filter out products that don't support money
 * @param  boolean $must_support_points Filter out products that don't support points
 * @return boolean Is filtered
 */
protected function _is_filtered_out(object $product_object, string $type_code, array $details, string $filter, ?int $type_filter, bool $must_support_money, bool $must_support_points) : bool