Function __global->build_search_submitter_clauses

Definitions

sources/database_search.php

  • Build up a submitter search clause, taking into account members, authors, usernames, and usergroups.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$member_field_name ?ID_TEXT No No required parameter N/A N/A The field name for member IDs (null: Cannot match against member IDs)
$member_id ?MEMBER No No required parameter N/A N/A Member ID (null: Unknown, so cannot search)
$author ID_TEXT No No required parameter N/A N/A Author
$author_field_name ?ID_TEXT No No Null N/A N/A The field name for authors (null: Cannot match against member IDs)

Returns

  • An SQL fragment (null: block query)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Build up a submitter search clause, taking into account members, authors, usernames, and usergroups.
 *
 * @param  ?ID_TEXT $member_field_name The field name for member IDs (null: Cannot match against member IDs)
 * @param  ?MEMBER $member_id Member ID (null: Unknown, so cannot search)
 * @param  ID_TEXT $author Author
 * @param  ?ID_TEXT $author_field_name The field name for authors (null: Cannot match against member IDs)
 * @return ?string An SQL fragment (null: block query)
 */
function build_search_submitter_clauses(?string $member_field_name, ?int $member_id, string $author, ?string $author_field_name = null) : ?string