Function __global->form_input_all_and_not

Definitions

sources/form_templates.php

  • Get the Tempcode for a complex input that chooses partials from a list ('all', 'all-except-these', or 'these').
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$pretty_name mixed No No required parameter N/A N/A A human intelligible name for this input field, provided in plain-text format (string or Tempcode)
$description mixed No No required parameter N/A N/A A description for this input field, provided in HTML format (string or Tempcode)
$base string No No required parameter N/A N/A The base name which this input field is for
$list Tempcode No No required parameter N/A N/A A list accumulation to select against
$type string No No + + - * N/A The current type of partial selection
$tabindex ?integer No No Null N/A N/A The tab index of the field (null: not specified)

Returns

  • The input field
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the Tempcode for a complex input that chooses partials from a list ('all', 'all-except-these', or 'these').
 *
 * @param  mixed $pretty_name A human intelligible name for this input field, provided in plain-text format (string or Tempcode)
 * @param  mixed $description A description for this input field, provided in HTML format (string or Tempcode)
 * @param  string $base The base name which this input field is for
 * @param  Tempcode $list A list accumulation to select against
 * @param  string $type The current type of partial selection
 * @set + - *
 * @param  ?integer $tabindex The tab index of the field (null: not specified)
 * @return Tempcode The input field
 */
function form_input_all_and_not($pretty_name, $description, string $base, object $list, string $type = '+', ?int $tabindex = null) : object