Function __global->cns_get_best_group_property

Definitions

sources/cns_groups.php

  • Get the best value of all values of a property for a list of usergroups.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$groups array No No required parameter N/A N/A The list of usergroups
$property ID_TEXT No No required parameter N/A N/A The identifier of the property

Returns

  • The best property value ('best' is dependant on the property we are looking at)
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the best value of all values of a property for a list of usergroups.
 *
 * @param  array $groups The list of usergroups
 * @param  ID_TEXT $property The identifier of the property
 * @return mixed The best property value ('best' is dependant on the property we are looking at)
 */
function cns_get_best_group_property(array $groups, string $property)