Function __global->build_cpf_indices

Definitions

sources/cns_members_action.php

  • Make Custom Profile Field indices.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id AUTO_LINK No No required parameter N/A N/A CPF ID
$index boolean No No required parameter N/A N/A Whether an index is needed for search purposes (there may be other reasons though)
$type ID_TEXT No No required parameter N/A N/A CPF type
$db_type ID_TEXT No No required parameter N/A N/A Underlying field type
$immediate boolean No No False N/A N/A Whether to create the indexes immediately (as opposed to doing it in a task)

Returns

  • If the operation could succeed (false means limit hit)
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Make Custom Profile Field indices.
 *
 * @param  AUTO_LINK $id CPF ID
 * @param  boolean $index Whether an index is needed for search purposes (there may be other reasons though)
 * @param  ID_TEXT $type CPF type
 * @param  ID_TEXT $db_type Underlying field type
 * @param  boolean $immediate Whether to create the indexes immediately (as opposed to doing it in a task)
 * @return boolean If the operation could succeed (false means limit hit)
 */
function build_cpf_indices(int $id, bool $index, string $type, string $db_type, bool $immediate = false) : bool