Extension: backup

Generated by php build/docs/rvn-docs.php. Do not edit this file by hand.

Manifest

| Field | Value |
| --- | --- |
| slug | backup |
| name | Backup & Restore |
| description | Export and restore complete Raven page-content and taxonomy archives. |
| type | system |
| author | Novelty Lanterns |
| homepage | https://lanterns.io/raven |
| docs | https://lanterns.io/raven |

Provider Files

  • private/ext/backup/ext.php
  • private/ext/backup/routes_panel.php
  • private/ext/backup/schema.php

Component Directories

  • private/ext/backup/lib/
  • private/ext/backup/tpl/

Route And Service Dependency Map

private/ext/backup/routes_panel.php

  • File-level rvn keys: config, csrf, db, driver, panel_site_data, prefix, root, view
  • File-level context keys: currentUserTheme, panelUrl, requirePanelLogin, rvn
  • Extension service keys: (none)
  • Extension service dirs: (none)

| Method | Path | Handler | Captures | Inferred Dependencies |
| --- | --- | --- | --- | --- |
| GET | /backup | inline-closure | render, requirePanelLogin | context:currentUserTheme, context:panelUrl, context:requirePanelLogin, rvn:* |
| GET | /backup/export | inline-closure | archive, requirePanelLogin | context:requirePanelLogin |
| POST | /backup/import | inline-closure | archive, render, requirePanelLogin, rvn | context:currentUserTheme, context:panelUrl, context:requirePanelLogin, rvn:* |

Library Symbols

| Symbol | Kind | Summary | @return |
| --- | --- | --- | --- |
| Raven\Ext\Backup\Archive::__construct() | method | Prepares the archive service for the active Raven installation. | void |
| Raven\Ext\Backup\Archive::export() | method | Exports all supported page-content and taxonomy records with their numeric ids intact. | array<string, mixed> JSON-serializable complete content archive. |
| Raven\Ext\Backup\Archive::restore() | method | Restores a complete archive into the current installation using the ids in the payload. | array{tables: int, channels: int, sets: int} Restore counts. |

Parameter Details

Raven\Ext\Backup\Archive::__construct()

  • File: private/ext/backup/lib/Backup/Archive.php
  • Params:
  • PDO $db Active Raven application database.
  • string $driver Database driver identifier.
  • string $prefix Application table prefix.
  • string $root Absolute Raven project root.

Raven\Ext\Backup\Archive::export()

  • File: private/ext/backup/lib/Backup/Archive.php
  • Params: (none)

Raven\Ext\Backup\Archive::restore()

  • File: private/ext/backup/lib/Backup/Archive.php
  • Params:
  • array&lt;string, mixed&gt; $archive Decoded archive payload.