Function __global->transaction_amend_screen

Definitions

sources/points3.php

  • The UI/actualiser to amend a point transaction.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id AUTO_LINK No No required parameter N/A N/A The ID of the transaction record to edit
$title Tempcode No No required parameter N/A N/A The title of the screen
$member_id_of ?MEMBER No No Null N/A N/A The member belonging to the transaction being amended (null: We are using the points ledger from admin_points)
$reason ?SHORT_TEXT No No Null N/A N/A The new reason to set for the transaction (null: not yet specified)
$redirect URLPATH No No Blank (empty string) N/A N/A Where to redirect after editing the transaction

Returns

  • The UI to edit a transaction (null: the edit was successful)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * The UI/actualiser to amend a point transaction.
 *
 * @param  AUTO_LINK $id The ID of the transaction record to edit
 * @param  Tempcode $title The title of the screen
 * @param  ?MEMBER $member_id_of The member belonging to the transaction being amended (null: We are using the points ledger from admin_points)
 * @param  ?SHORT_TEXT $reason The new reason to set for the transaction (null: not yet specified)
 * @param  URLPATH $redirect Where to redirect after editing the transaction
 * @return ?Tempcode The UI to edit a transaction (null: the edit was successful)
 */
function transaction_amend_screen(int $id, object $title, ?int $member_id_of = null, ?string $reason = null, string $redirect = '') : ?object