Changeset 764

Timestamp:

Mar 12, 2022 11:19:03 PM (2 years ago)

Author:

anonymous

Message:

Add $merge parameter to exclude values from record versioning (e.g., site_add_vars)

File:

• trunk/lib/Version.inc.php (modified) (4 diffs)

trunk/lib/Version.inc.php

@@ -202 +202 @@
      * @param string $record_val    The value of the key column for the record.
      * @param string $title         The title of this record. Only used for human presentation.
+     * @param array  $merge         Array of values to merge with the current record values (use this to force 'key' to be an empty string in a saved version, e.g., ['key' => '']).
      *
      * @return int                  The id for the version (mysql last insert id).
      */
-    public function create($record_table, $record_key, $record_val, $title='', $notes='')
+    public function create($record_table, $record_key, $record_val, $title='', $notes='', Array $merge=[])
     {
         $app =& App::getInstance();
@@ -213 +214 @@
 
         // Get current record.
-        if (!$record = $this->getCurrent($record_table, $record_key, $record_val)) {
+        if (!$record = $this->getCurrent($record_table, $record_key, $record_val, $merge)) {
             $app->logMsg(sprintf('Could not create %s version, record not found: %s, %s, %s.', $title, $record_table, $record_key, $record_val), LOG_ERR, __FILE__, __LINE__);
             return false;
@@ -560 +561 @@
      * Get the current record data from the original table.
      *
-     * @param string $version_id    The id of the version to restore.
-     *
-     * @return mixed                Array of data saved in version, or false if none.
-     */
-    public function getCurrent($record_table, $record_key, $record_val)
+     * @param string $record_table  The table containing the record.
+     * @param string $record_key    The key column for the record.
+     * @param string $record_val    The value of the key column for the record.
+     * @param array  $merge         Array of values to merge with the current record values (use this to redact certain values, e.g., ['key' => '']).
+     *
+     * @return mixed                Array of data from the current database record.
+     */
+    public function getCurrent($record_table, $record_key, $record_val, Array $merge=[])
     {
         $db =& DB::getInstance();
@@ -581 +585 @@
         ");
         if ($record = mysql_fetch_assoc($qid)) {
-            return $record;
+            return array_merge($record, $merge);
         } else {
             return false;