mirror of
https://gh.llkk.cc/https://github.com/mainwp/mainwp.dev.git
synced 2025-10-04 15:43:04 +08:00
3516 lines
178 KiB
HTML
3516 lines
178 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>MainWP Dashboard Code Reference</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<base href="../">
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
<link rel="stylesheet" href="css/base.css">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="css/template.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
|
|
<script src="js/search.js"></script>
|
|
<script defer src="js/searchIndex.js"></script>
|
|
</head>
|
|
<body id="top">
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">MainWP Dashboard Code Reference</a></h1>
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
<i class="fas fa-bars"></i>
|
|
</label>
|
|
<section data-search-form class="phpdocumentor-search">
|
|
<label>
|
|
<span class="visually-hidden">Search for</span>
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
</svg>
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
</label>
|
|
</section>
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="phpdocumentor">
|
|
<div class="phpdocumentor-section">
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
Menu
|
|
</label>
|
|
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/mainwp.html"><abbr title="\MainWP">MainWP</abbr></a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="namespaces/mainwp-child.html"><abbr title="\MainWP\Child">Child</abbr></a></li>
|
|
</ul>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/composer.html"><abbr title="\Composer">Composer</abbr></a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="namespaces/composer-autoload.html"><abbr title="\Composer\Autoload">Autoload</abbr></a></li>
|
|
</ul>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/paragonie.html"><abbr title="\ParagonIE">ParagonIE</abbr></a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="namespaces/paragonie-constanttime.html"><abbr title="\ParagonIE\ConstantTime">ConstantTime</abbr></a></li>
|
|
</ul>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpseclib3.html"><abbr title="\phpseclib3">phpseclib3</abbr></a></h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="namespaces/phpseclib3-common.html"><abbr title="\phpseclib3\Common">Common</abbr></a></li>
|
|
<li><a href="namespaces/phpseclib3-crypt.html"><abbr title="\phpseclib3\Crypt">Crypt</abbr></a></li>
|
|
<li><a href="namespaces/phpseclib3-exception.html"><abbr title="\phpseclib3\Exception">Exception</abbr></a></li>
|
|
<li><a href="namespaces/phpseclib3-file.html"><abbr title="\phpseclib3\File">File</abbr></a></li>
|
|
<li><a href="namespaces/phpseclib3-math.html"><abbr title="\phpseclib3\Math">Math</abbr></a></li>
|
|
<li><a href="namespaces/phpseclib3-net.html"><abbr title="\phpseclib3\Net">Net</abbr></a></li>
|
|
<li><a href="namespaces/phpseclib3-system.html"><abbr title="\phpseclib3\System">System</abbr></a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/MainWP.html"><abbr title="\MainWP">MainWP</abbr></a></h3>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="packages/MainWP-Child.html"><abbr title="\MainWP\Child">Child</abbr></a></li>
|
|
<li><a href="packages/MainWP-ChildCreditsPlugin.html"><abbr title="\MainWP\ChildCreditsPlugin">ChildCreditsPlugin</abbr></a></li>
|
|
<li><a href="packages/MainWP-Dashboard.html"><abbr title="\MainWP\Dashboard">Dashboard</abbr></a></li>
|
|
</ul>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/MainWPChild.html"><abbr title="\MainWPChild">MainWPChild</abbr></a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/ParagonIE.html"><abbr title="\ParagonIE">ParagonIE</abbr></a></h3>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="packages/ParagonIE-ConstantTime.html"><abbr title="\ParagonIE\ConstantTime">ConstantTime</abbr></a></li>
|
|
</ul>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Mainwp.html"><abbr title="\Mainwp">Mainwp</abbr></a></h3>
|
|
<ul class="phpdocumentor-list">
|
|
<li><a href="packages/Mainwp-Child.html"><abbr title="\Mainwp\Child">Child</abbr></a></li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
</section>
|
|
</aside>
|
|
|
|
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp.html">MainWP</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp-child.html">Child</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
Tar_Archiver
|
|
|
|
|
|
<div class="phpdocumentor-element__package">
|
|
in package
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP.html">MainWP</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP-Child.html">Child</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">19</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Class Tar_Archiver</p>
|
|
|
|
<section class="phpdocumentor-description"><p>Handle the Tar archiver actions.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constant_APPEND">APPEND</a>
|
|
<span>
|
|
= 1 </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constant_CREATE">CREATE</a>
|
|
<span>
|
|
= 2 </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constant_IDLE">IDLE</a>
|
|
<span>
|
|
= 0 </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_archive">$archive</a>
|
|
<span>
|
|
: resource </span>
|
|
</dt>
|
|
<dd>Backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_archivePath">$archivePath</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Backup archive file path.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_archiveSize">$archiveSize</a>
|
|
<span>
|
|
: float </span>
|
|
</dt>
|
|
<dd>Backup archive file size.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_backup">$backup</a>
|
|
<span>
|
|
: object </span>
|
|
</dt>
|
|
<dd>MainWP_Backup class instance.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_block">$block</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Block of the backup content.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_chunk">$chunk</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Chunk of the backup.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_chunkSize">$chunkSize</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Backup chunk size.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_cnt">$cnt</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Count number.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_debug">$debug</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Enable debug mode.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_excludeZip">$excludeZip</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Whether to exclude zip archives.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_gcCnt">$gcCnt</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Garbage collection count.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_lastRun">$lastRun</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Last time a backup has been run.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_logHandle">$logHandle</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Enable logging.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_mode">$mode</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Arvive mode, IDLE, APPEND or CREATE.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_pidContent">$pidContent</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Backup PID file content.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_pidFile">$pidFile</a>
|
|
<span>
|
|
: resource </span>
|
|
</dt>
|
|
<dd>Backup PID file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_pidUpdated">$pidUpdated</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Time of the last PID file update.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_tempContent">$tempContent</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Temprary backup content.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_type">$type</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Backup archive type.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Tar_Archiver constructor.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_dir">add_dir()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Add directory to the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_append">append()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Append to the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_close">close()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Close the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_create">create()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Create backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_create_full_backup">create_full_backup()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Create full backup.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_extract_to">extract_to()</a>
|
|
<span>
|
|
: null
|
|
</span>
|
|
</dt>
|
|
<dd>Extract backup archive file to a location.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_file_exists">file_exists()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Check if the file exists.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_get_extension">get_extension()</a>
|
|
<span>
|
|
: string
|
|
</span>
|
|
</dt>
|
|
<dd>Get backup archive file extension, .tar.bz2, .tar.gz or .tar.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_get_from_name">get_from_name()</a>
|
|
<span>
|
|
: string
|
|
</span>
|
|
</dt>
|
|
<dd>Get File content retrived by name.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_init_log_handle">init_log_handle()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Init log file handle.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_is_open">is_open()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Verify if the backup archive file is open.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_is_valid_block">is_valid_block()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Check if block is valid.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_log">log()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Log messages to the backup error log.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_prepare_append">prepare_append()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Prepare the append process.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_read">read()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Read the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_update_pid_file">update_pid_file()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Update backup archive PID file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_zip_file">zip_file()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Create ZIP file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_config">add_config()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Add config file to the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data">add_data()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Add data to the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_dir">add_empty_dir()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Fire off the add_empty_directory() function.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_directory">add_empty_directory()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Add empty directory to the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file">add_file()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Add file to the backup archive file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file_from_string">add_file_from_string()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Add file from a string.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_check_before_append">check_before_append()</a>
|
|
<span>
|
|
: array<string|int, mixed>
|
|
</span>
|
|
</dt>
|
|
<dd>Check before append.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_complete_pid_file">complete_pid_file()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Complete backup archive PID file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_create_pid_file">create_pid_file()</a>
|
|
<span>
|
|
: bool
|
|
</span>
|
|
</dt>
|
|
<dd>Create backup archive PID file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_include_core_files">include_core_files()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Include WordPress core file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_is_next_file">is_next_file()</a>
|
|
<span>
|
|
: array<string|int, mixed>|bool
|
|
</span>
|
|
</dt>
|
|
<dd>Is next file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_read_next_bytes">read_next_bytes()</a>
|
|
<span>
|
|
: array<string|int, mixed>|bool
|
|
</span>
|
|
</dt>
|
|
<dd>Read next bytes.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_write_chunk">write_chunk()</a>
|
|
<span>
|
|
: mixed
|
|
</span>
|
|
</dt>
|
|
<dd>Write backup chunk.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-constants">
|
|
<h3 class="phpdocumentor-elements__header" id="constants">
|
|
Constants
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_APPEND">
|
|
APPEND
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constant_APPEND" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">21</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">APPEND</span>
|
|
= <span class="phpdocumentor-signature__default-value">1</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_CREATE">
|
|
CREATE
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constant_CREATE" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">22</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">CREATE</span>
|
|
= <span class="phpdocumentor-signature__default-value">2</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_IDLE">
|
|
IDLE
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#constant_IDLE" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">20</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">IDLE</span>
|
|
= <span class="phpdocumentor-signature__default-value">""</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_archive">
|
|
$archive
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_archive" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">resource</span>
|
|
<span class="phpdocumentor-signature__name">$archive</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_archivePath">
|
|
$archivePath
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_archivePath" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">43</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup archive file path.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$archivePath</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_archiveSize">
|
|
$archiveSize
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_archiveSize" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">50</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup archive file size.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">float</span>
|
|
<span class="phpdocumentor-signature__name">$archiveSize</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_backup">
|
|
$backup
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_backup" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">85</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">MainWP_Backup class instance.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">object</span>
|
|
<span class="phpdocumentor-signature__name">$backup</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_block">
|
|
$block
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_block" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">754</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Block of the backup content.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$block</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_chunk">
|
|
$chunk
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_chunk" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">71</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Chunk of the backup.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$chunk</span>
|
|
= <span class="phpdocumentor-signature__default-value">''</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_chunkSize">
|
|
$chunkSize
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_chunkSize" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">78</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup chunk size.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$chunkSize</span>
|
|
= <span class="phpdocumentor-signature__default-value">4194304</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_cnt">
|
|
$cnt
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_cnt" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">775</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Count number.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$cnt</span>
|
|
= <span class="phpdocumentor-signature__default-value">0</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_debug">
|
|
$debug
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_debug" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">64</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Enable debug mode.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$debug</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_excludeZip">
|
|
$excludeZip
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_excludeZip" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">29</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Whether to exclude zip archives.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$excludeZip</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_gcCnt">
|
|
$gcCnt
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_gcCnt" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">768</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Garbage collection count.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$gcCnt</span>
|
|
= <span class="phpdocumentor-signature__default-value">0</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_lastRun">
|
|
$lastRun
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_lastRun" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">57</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Last time a backup has been run.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$lastRun</span>
|
|
= <span class="phpdocumentor-signature__default-value">0</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_logHandle">
|
|
$logHandle
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_logHandle" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">127</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Enable logging.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$logHandle</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_mode">
|
|
$mode
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_mode" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">120</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Arvive mode, IDLE, APPEND or CREATE.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$mode</span>
|
|
= <span class="phpdocumentor-signature__default-value">self::IDLE</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pidContent">
|
|
$pidContent
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_pidContent" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">106</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup PID file content.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$pidContent</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pidFile">
|
|
$pidFile
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_pidFile" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">99</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup PID file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">resource</span>
|
|
<span class="phpdocumentor-signature__name">$pidFile</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pidUpdated">
|
|
$pidUpdated
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_pidUpdated" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">113</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Time of the last PID file update.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$pidUpdated</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_tempContent">
|
|
$tempContent
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_tempContent" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">761</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Temprary backup content.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$tempContent</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_type">
|
|
$type
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#property_type" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">92</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Backup archive type.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$type</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">138</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tar_Archiver constructor.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">object </span><span class="phpdocumentor-signature__argument__name">$backup</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'tar'</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$pidFile</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Run any time class is called.</p>
|
|
</section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$backup</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">object</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>MainWP_Backup class instance.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">'tar'</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Backup arvhive type.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pidFile</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Request PID file or not.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_dir">
|
|
add_dir()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_dir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">532</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add directory to the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">add_dir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$excludes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$excludes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>List of file to exclude from the backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_dir"><abbr title="\MainWP\Child\Tar_Archiver::add_empty_dir()">Tar_Archiver::add_empty_dir()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add empty directory to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file"><abbr title="\MainWP\Child\Tar_Archiver::add_file()">Tar_Archiver::add_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add file to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_in_excludes"><abbr title="\MainWP\Child\MainWP_Helper::in_excludes()">MainWP_Helper::in_excludes()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>\MainWP\Child\Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_append">
|
|
append()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_append" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1264</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Append to the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">append</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filepath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$filepath</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File location path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_close">
|
|
close()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_close" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1376</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Close the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">close</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$closeLog</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$closeLog</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Log this action if set true.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_create">
|
|
create()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_create" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1238</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filepath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$filepath</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File location path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_create_full_backup">
|
|
create_full_backup()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_create_full_backup" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">336</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create full backup.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">create_full_backup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filepath</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$excludes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$addConfig</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$includeCoreFiles</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$excludezip</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$excludenonwp</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$append</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$filepath</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Backup file path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$excludes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Files to exclude from the backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$addConfig</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Add config file to backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$includeCoreFiles</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Include WordPress core files.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$excludezip</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Exclude zip files from the backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$excludenonwp</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Exclude non-WordPress directories in site root.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$append</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Append to backup file name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_create_pid_file"><abbr title="\MainWP\Child\Tar_Archiver::create_pid_file()">Tar_Archiver::create_pid_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Create PID file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_prepare_append"><abbr title="\MainWP\Child\Tar_Archiver::prepare_append()">Tar_Archiver::prepare_append()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Prepare to append.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_create"><abbr title="\MainWP\Child\Tar_Archiver::create()">Tar_Archiver::create()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Create backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_include_core_files"><abbr title="\MainWP\Child\Tar_Archiver::include_core_files()">Tar_Archiver::include_core_files()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Include WordPress core files.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\Tar_Archiver::create_backup_db()">Tar_Archiver::create_backup_db()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Create database backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file"><abbr title="\MainWP\Child\Tar_Archiver::add_file()">Tar_Archiver::add_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add file to backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_dir"><abbr title="\MainWP\Child\Tar_Archiver::add_dir()">Tar_Archiver::add_dir()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add directory to backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_config"><abbr title="\MainWP\Child\Tar_Archiver::add_config()">Tar_Archiver::add_config()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add config file to backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_directory"><abbr title="\MainWP\Child\Tar_Archiver::add_empty_directory()">Tar_Archiver::add_empty_directory()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add empty 'clone' directory to backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file_from_string"><abbr title="\MainWP\Child\Tar_Archiver::add_file_from_string()">Tar_Archiver::add_file_from_string()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add file from a string.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data"><abbr title="\MainWP\Child\Tar_Archiver::add_data()">Tar_Archiver::add_data()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add data to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_close"><abbr title="\MainWP\Child\Tar_Archiver::close()">Tar_Archiver::close()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Close the bacukup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_complete_pid_file"><abbr title="\MainWP\Child\Tar_Archiver::complete_pid_file()">Tar_Archiver::complete_pid_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Complete the PID file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_starts_with"><abbr title="\MainWP\Child\MainWP_Helper::starts_with()">MainWP_Helper::starts_with()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_in_excludes"><abbr title="\MainWP\Child\MainWP_Helper::in_excludes()">MainWP_Helper::in_excludes()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_extract_to">
|
|
extract_to()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_extract_to" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1543</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Extract backup archive file to a location.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">extract_to</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$to</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$to</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Desired location to extract file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">null</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_file_exists">
|
|
file_exists()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_file_exists" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1473</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if the file exists.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">file_exists</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return tru if the file exists, false if it doesn't.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_extension">
|
|
get_extension()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_get_extension" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">163</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get backup archive file extension, .tar.bz2, .tar.gz or .tar.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_extension</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Aarchive file extension, .tar.bz2, .tar.gz or .tar.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_from_name">
|
|
get_from_name()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_get_from_name" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1402</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get File content retrived by name.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_from_name</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>File content.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_init_log_handle">
|
|
init_log_handle()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_init_log_handle" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">301</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Init log file handle.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">init_log_handle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file_log</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$file_log</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Log file path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_is_open">
|
|
is_open()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_is_open" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1290</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Verify if the backup archive file is open.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">is_open</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>True if open, if not, false.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_is_valid_block">
|
|
is_valid_block()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_is_valid_block" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1660</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if block is valid.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">is_valid_block</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$block</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$block</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Block of the backup file content.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return true if it's valid block, false if not.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_log">
|
|
log()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_log" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1227</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Log messages to the backup error log.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">log</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$text</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Log message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_prepare_append">
|
|
prepare_append()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_prepare_append" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1301</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Prepare the append process.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">prepare_append</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filepath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$filepath</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File location path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_read">
|
|
read()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_read" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1348</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Read the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">read</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filepath</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$filepath</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File location path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_update_pid_file">
|
|
update_pid_file()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_update_pid_file" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">246</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Update backup archive PID file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">update_pid_file</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\WP_Filesystem_Direct::put_contents()">WP_Filesystem_Direct::put_contents()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Writes a string to a file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.wordpress.org/reference/classes/wp_filesystem_direct/put_contents/"><abbr title="https://developer.wordpress.org/reference/classes/wp_filesystem_direct/put_contents/">https://developer.wordpress.org/reference/classes/wp_filesystem_direct/put_contents/</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::add_empty_dir() Add empty directory.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_zip_file">
|
|
zip_file()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_zip_file" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">187</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create ZIP file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">zip_file</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$files</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$archive</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$files</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Files to zip.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$archive</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Type of archive to create.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_create"><abbr title="\MainWP\Child\Tar_Archiver::create()">Tar_Archiver::create()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Create archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file"><abbr title="\MainWP\Child\Tar_Archiver::add_file()">Tar_Archiver::add_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add file to the archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data"><abbr title="\MainWP\Child\Tar_Archiver::add_data()">Tar_Archiver::add_data()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add data to the archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_close"><abbr title="\MainWP\Child\Tar_Archiver::close()">Tar_Archiver::close()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Close archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_config">
|
|
add_config()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_config" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">468</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add config file to the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">add_config</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\wp_json_encode()">wp_json_encode()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Encode a variable into JSON, with some sanity checks.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\get_option()">get_option()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Retrieves an option value based on an option name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\get_bloginfo()">get_bloginfo()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Retrieves information about the current site.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.wordpress.org/reference/functions/wp_json_encode/"><abbr title="https://developer.wordpress.org/reference/functions/wp_json_encode/">https://developer.wordpress.org/reference/functions/wp_json_encode/</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.wordpress.org/reference/functions/get_option/"><abbr title="https://developer.wordpress.org/reference/functions/get_option/">https://developer.wordpress.org/reference/functions/get_option/</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.wordpress.org/reference/functions/get_bloginfo/"><abbr title="https://developer.wordpress.org/reference/functions/get_bloginfo/">https://developer.wordpress.org/reference/functions/get_bloginfo/</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_data">
|
|
add_data()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">578</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add data to the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">add_data</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\MainWP\Child\arary">arary</abbr> </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$data</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\MainWP\Child\arary">arary</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Data to add to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_dir"><abbr title="\MainWP\Child\Tar_Archiver::add_empty_dir()">Tar_Archiver::add_empty_dir()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add empty directory to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file"><abbr title="\MainWP\Child\Tar_Archiver::add_file()">Tar_Archiver::add_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add file to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_empty_dir">
|
|
add_empty_dir()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_dir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">647</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Fire off the add_empty_directory() function.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">add_empty_dir</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_directory"><abbr title="\MainWP\Child\Tar_Archiver::add_empty_directory()">Tar_Archiver::add_empty_directory()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add empty directory to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_empty_directory">
|
|
add_empty_directory()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_empty_directory" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">667</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add empty directory to the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">add_empty_directory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$uid</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$gid</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$mtime</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$mode</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Inode protection mode.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$uid</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Userid of the file owner.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$gid</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Groupid of the file owner .</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$mtime</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Time of last modification of the file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_check_before_append"><abbr title="\MainWP\Child\Tar_Archiver::check_before_append()">Tar_Archiver::check_before_append()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Check before append.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data"><abbr title="\MainWP\Child\Tar_Archiver::add_data()">Tar_Archiver::add_data()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add data to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::add_empty_dir() Fire off the add_empty_directory() function.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_file">
|
|
add_file()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">791</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add file to the backup archive file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">add_file</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>\MainWP\Child\Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data"><abbr title="\MainWP\Child\Tar_Archiver::add_data()">Tar_Archiver::add_data()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add data to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_update_pid_file"><abbr title="\MainWP\Child\Tar_Archiver::update_pid_file()">Tar_Archiver::update_pid_file()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Update the PID file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_ends_with"><abbr title="\MainWP\Child\MainWP_Helper::ends_with()">MainWP_Helper::ends_with()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_file_from_string">
|
|
add_file_from_string()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_add_file_from_string" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">962</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add file from a string.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">add_file_from_string</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$content</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$content</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry content.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_add_data"><abbr title="\MainWP\Child\Tar_Archiver::add_data()">Tar_Archiver::add_data()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Add data to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_check_before_append">
|
|
check_before_append()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_check_before_append" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1061</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check before append.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">check_before_append</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_close"><abbr title="\MainWP\Child\Tar_Archiver::close()">Tar_Archiver::close()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Close the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-Tar-Archiver.html#method_append"><abbr title="\MainWP\Child\Tar_Archiver::append()">Tar_Archiver::append()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Append to the backup archive file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return function output.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_complete_pid_file">
|
|
complete_pid_file()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_complete_pid_file" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">277</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Complete backup archive PID file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">complete_pid_file</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\WP_Filesystem_Direct::move()">WP_Filesystem_Direct::move()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Moves a file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.wordpress.org/reference/classes/wp_filesystem_direct/move/"><abbr title="https://developer.wordpress.org/reference/classes/wp_filesystem_direct/move/">https://developer.wordpress.org/reference/classes/wp_filesystem_direct/move/</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_create_pid_file">
|
|
create_pid_file()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_create_pid_file" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">216</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create backup archive PID file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">create_pid_file</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">resource </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$file</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">resource</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Backup archive PID file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\MainWP\Child\WP_Filesystem_Direct::put_contents()">WP_Filesystem_Direct::put_contents()</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Writes a string to a file.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="https://developer.wordpress.org/reference/classes/wp_filesystem_direct/put_contents/"><abbr title="https://developer.wordpress.org/reference/classes/wp_filesystem_direct/put_contents/">https://developer.wordpress.org/reference/classes/wp_filesystem_direct/put_contents/</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Return false on failure, true on success.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_include_core_files">
|
|
include_core_files()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_include_core_files" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">414</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Include WordPress core file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">include_core_files</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$nodes</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Default nodes.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">used-by</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>\MainWP\Child\Tar_Archiver::create_full_backup() Create full backup.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">uses</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_starts_with"><abbr title="\MainWP\Child\MainWP_Helper::starts_with()">MainWP_Helper::starts_with()</abbr></a></span>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_is_next_file">
|
|
is_next_file()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_is_next_file" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1106</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Is next file.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">is_next_file</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entryName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$entryName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Entry name.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>If true,skip file, if false or number, nothing to read, will continue with current file.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_read_next_bytes">
|
|
read_next_bytes()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_read_next_bytes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">1174</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Read next bytes.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">read_next_bytes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">resource </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$file</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">resource</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>File to process.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Number of bytes or false on failure.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_write_chunk">
|
|
write_chunk()
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#method_write_chunk" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="class/class-tar-archiver.php"><a href="files/class-class-tar-archiver.html"><abbr title="class/class-tar-archiver.php">class-tar-archiver.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">610</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write backup chunk.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">write_chunk</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h5>
|
|
<dl class="phpdocumentor-tag-list">
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">throws</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>Error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
</article>
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
<header class="phpdocumentor-search-results__header">
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
</header>
|
|
<section class="phpdocumentor-search-results__body">
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
<a href="classes/MainWP-Child-Tar-Archiver.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
</body>
|
|
</html>
|