mirror of
https://gh.wpcy.net/https://github.com/mainwp/mainwp.dev.git
synced 2026-07-17 06:34:55 +08:00
2637 lines
127 KiB
HTML
2637 lines
127 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>MainWP Dashboard Documentation</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 rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+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" />
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
<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="js/template.js"></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 Documentation</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 -three phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category -namespaces">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/mainwp.html" class="">MainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/mainwp-dashboard.html" class="">Dashboard</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/paragonie.html" class="">ParagonIE</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/paragonie-constanttime.html" class="">ConstantTime</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/phpseclib3.html" class="">phpseclib3</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/phpseclib3-common.html" class="">Common</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpseclib3-crypt.html" class="">Crypt</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpseclib3-exception.html" class="">Exception</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpseclib3-file.html" class="">File</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpseclib3-math.html" class="">Math</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpseclib3-net.html" class="">Net</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="namespaces/phpseclib3-system.html" class="">System</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category -packages">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPDashboard.html" class="">MainWPDashboard</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPAPIManagerKeyHandler.html" class="">MainWPAPIManagerKeyHandler</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPMainWP.html" class="">MainWPMainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPMainWP-API.html" class="">API</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPMainWP-Keys.html" class="">Keys</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPMainWP-Client.html" class="">Client</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPAPIManagerUpdateHandler.html" class="">MainWPAPIManagerUpdateHandler</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPMainWPAPIManager.html" class="">MainWPMainWPAPIManager</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWP.html" class="">MainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWP-Dashboard.html" class="">Dashboard</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardMainWPsitesclientlist.html" class="">DashboardMainWPsitesclientlist</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardThisclasshandlesthe.html" class="">DashboardThisclasshandlesthe</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardMainWPsitesmonitoringlist.html" class="">DashboardMainWPsitesmonitoringlist</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardCheckforpremiumpluginupdates.html" class="">DashboardCheckforpremiumpluginupdates</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSettings.html" class="">MainWPSettings</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPBackups.html" class="">MainWPBackups</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPBackups-Continue.html" class="">Continue</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPBootstrap.html" class="">MainWPBootstrap</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPUpdates.html" class="">MainWPUpdates</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPUpdates-Check.html" class="">Check</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPUpdates-Overview.html" class="">Overview</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPPingChilds.html" class="">MainWPPingChilds</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPStats.html" class="">MainWPStats</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/ParagonIE.html" class="">ParagonIE</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/ParagonIE-ConstantTime.html" class="">ConstantTime</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPExtensions.html" class="">MainWPExtensions</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSecurtiy.html" class="">MainWPSecurtiy</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSecurtiy-Issues.html" class="">Issues</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSetup.html" class="">MainWPSetup</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSetup-Wizard.html" class="">Wizard</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSite.html" class="">MainWPSite</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSite-Open.html" class="">Open</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPThemes.html" class="">MainWPThemes</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPUser.html" class="">MainWPUser</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPWidget.html" class="">MainWPWidget</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPWidget-Mainwp.html" class="">Mainwp</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPWidget-Recent.html" class="">Recent</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPPlugins.html" class="">MainWPPlugins</a>
|
|
</h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -reports">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
|
|
<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 -indices">
|
|
<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 -nine phpdocumentor-content">
|
|
<section>
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3.html">phpseclib3</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-net.html">Net</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpseclib3-net-sftp.html">SFTP</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
Stream
|
|
|
|
|
|
<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-Dashboard.html">Dashboard</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</h2>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
|
|
|
|
</div>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">27</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.27" class="phpdocumentor-element-found-in__source" data-line="27" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">SFTP Stream Wrapper</p>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#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">author</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>Jim Wigginton <a href="mailto:terrafrost@php.net">terrafrost@php.net</a></p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-properties">
|
|
Properties
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_context">$context</a>
|
|
<span>
|
|
: resource </span>
|
|
</dt>
|
|
<dd>Context resource</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_instances">$instances</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>SFTP instances</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_entries">$entries</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Directory entries</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_eof">$eof</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>EOF flag</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_mode">$mode</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Mode</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_notification">$notification</a>
|
|
<span>
|
|
: callable </span>
|
|
</dt>
|
|
<dd>Notification callback function</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_path">$path</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Path</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_pos">$pos</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Position</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_sftp">$sftp</a>
|
|
<span>
|
|
: object </span>
|
|
</dt>
|
|
<dd>SFTP instance</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#property_size">$size</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Size</dd>
|
|
|
|
</dl>
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method___call">__call()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>__call Magic Method</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>The Constructor</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method_register">register()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Registers this class as a URL wrapper.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method_parse_path">parse_path()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Path Parser</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_closedir">_dir_closedir()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Close directory handle</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_opendir">_dir_opendir()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Open directory handle</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_readdir">_dir_readdir()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Read entry from directory handle</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_rewinddir">_dir_rewinddir()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Rewind directory handle</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__mkdir">_mkdir()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Create a directory</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__rename">_rename()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Renames a file or directory</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__rmdir">_rmdir()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Removes a directory</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_cast">_stream_cast()</a>
|
|
<span>
|
|
: resource </span>
|
|
</dt>
|
|
<dd>Retrieve the underlaying resource</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_close">_stream_close()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Close an resource</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_eof">_stream_eof()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Tests for end-of-file on a file pointer</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_flush">_stream_flush()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Flushes the output</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_lock">_stream_lock()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Advisory file locking</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_metadata">_stream_metadata()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Change stream options</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_open">_stream_open()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Opens file or URL</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_read">_stream_read()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Read from stream</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_seek">_stream_seek()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Seeks to specific location in a stream</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_set_option">_stream_set_option()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Change stream options</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_stat">_stream_stat()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Retrieve information about a file resource</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_tell">_stream_tell()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Retrieve the current position of a stream</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_truncate">_stream_truncate()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Truncate stream</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_write">_stream_write()</a>
|
|
<span>
|
|
: int|false </span>
|
|
</dt>
|
|
<dd>Write to stream</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__unlink">_unlink()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Delete a file</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a class="" href="classes/phpseclib3-Net-SFTP-Stream.html#method__url_stat">_url_stat()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Retrieve information about a file</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_context">
|
|
$context
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_context" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">94</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.94" class="phpdocumentor-element-found-in__source" data-line="94" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Context resource</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">resource</span>
|
|
<span class="phpdocumentor-signature__name">$context</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>Technically this needs to be publicly accessible so PHP can set it directly</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_instances">
|
|
$instances
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_instances" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.36" class="phpdocumentor-element-found-in__source" data-line="36" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">SFTP instances</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$instances</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>Rather than re-create the connection we re-use instances if possible</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_entries">
|
|
$entries
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_entries" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">78</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.78" class="phpdocumentor-element-found-in__source" data-line="78" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Directory entries</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$entries</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_eof">
|
|
$eof
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_eof" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">85</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.85" class="phpdocumentor-element-found-in__source" data-line="85" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">EOF flag</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">bool</span>
|
|
<span class="phpdocumentor-signature__name">$eof</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_mode">
|
|
$mode
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">57</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.57" class="phpdocumentor-element-found-in__source" data-line="57" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Mode</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$mode</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_notification">
|
|
$notification
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_notification" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">101</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.101" class="phpdocumentor-element-found-in__source" data-line="101" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Notification callback function</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">callable</span>
|
|
<span class="phpdocumentor-signature__name">$notification</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_path">
|
|
$path
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_path" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">50</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.50" class="phpdocumentor-element-found-in__source" data-line="50" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Path</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">string</span>
|
|
<span class="phpdocumentor-signature__name">$path</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_pos">
|
|
$pos
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_pos" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">64</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.64" class="phpdocumentor-element-found-in__source" data-line="64" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Position</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$pos</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_sftp">
|
|
$sftp
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_sftp" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">43</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.43" class="phpdocumentor-element-found-in__source" data-line="43" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">SFTP instance</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">object</span>
|
|
<span class="phpdocumentor-signature__name">$sftp</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_size">
|
|
$size
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#property_size" 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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">71</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Size</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type">int</span>
|
|
<span class="phpdocumentor-signature__name">$size</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.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___call">
|
|
__call()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method___call" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">737</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.737" class="phpdocumentor-element-found-in__source" data-line="737" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">__call Magic Method</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</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">$arguments</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>When you're utilizing an SFTP stream you're not calling the methods in this class directly - PHP is calling them for you.
|
|
Which kinda begs the question... what methods is PHP calling and what parameters is it passing to them? This function
|
|
lets you figure that out.</p>
|
|
<p>If NET_SFTP_STREAM_LOGGING is defined all calls will be output on the screen and then (regardless of whether or not
|
|
NET_SFTP_STREAM_LOGGING is enabled) the parameters will be passed through to the appropriate method.</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">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$arguments</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">121</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.121" class="phpdocumentor-element-found-in__source" data-line="121" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The 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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
-static "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_register">
|
|
register()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method_register" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">109</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.109" class="phpdocumentor-element-found-in__source" data-line="109" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Registers this class as a URL wrapper.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">register</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$protocol</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'sftp'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">$protocol</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">'sftp'</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The wrapper name to be registered.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>True on success, false otherwise.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_parse_path">
|
|
parse_path()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method_parse_path" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">139</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.139" class="phpdocumentor-element-found-in__source" data-line="139" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Path Parser</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">parse_path</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Extract a path from a URI and actually connect to an SSH server if appropriate</p>
|
|
<p>If "notification" is set as a context parameter the message code for successful login is
|
|
NET_SSH2_MSG_USERAUTH_SUCCESS. For a failed login it's NET_SSH2_MSG_USERAUTH_FAILURE.</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">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__dir_closedir">
|
|
_dir_closedir()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_closedir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">566</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.566" class="phpdocumentor-element-found-in__source" data-line="566" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Close directory handle</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_dir_closedir</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__dir_opendir">
|
|
_dir_opendir()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_opendir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">526</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.526" class="phpdocumentor-element-found-in__source" data-line="526" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Open directory handle</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_dir_opendir</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">int </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>The only $options is "whether or not to enforce safe_mode (0x04)". Since safe mode was deprecated in 5.3 and
|
|
removed in 5.4 I'm just going to ignore it.</p>
|
|
<p>Also, nlist() is the best that this function is realistically going to be able to do. When an SFTP client
|
|
sends a SSH_FXP_READDIR packet you don't generally get info on just one file but on multiple files. Quoting
|
|
the SFTP specs:</p>
|
|
<p>The SSH_FXP_NAME response has the following format:</p>
|
|
<pre class="prettyprint"><code class="prettyprint"> uint32 id
|
|
uint32 count
|
|
repeats count times:
|
|
string filename
|
|
string longname
|
|
ATTRS attrs
|
|
</code></pre>
|
|
</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">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$options</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__dir_readdir">
|
|
_dir_readdir()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_readdir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">542</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.542" class="phpdocumentor-element-found-in__source" data-line="542" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Read entry from directory handle</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_dir_readdir</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__dir_rewinddir">
|
|
_dir_rewinddir()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_rewinddir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">555</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.555" class="phpdocumentor-element-found-in__source" data-line="555" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Rewind directory handle</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_dir_rewinddir</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__mkdir">
|
|
_mkdir()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__mkdir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">581</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.581" class="phpdocumentor-element-found-in__source" data-line="581" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create a directory</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_mkdir</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">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">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Only valid $options is STREAM_MKDIR_RECURSIVE</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">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</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">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$options</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__rename">
|
|
_rename()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__rename" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">475</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.475" class="phpdocumentor-element-found-in__source" data-line="475" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Renames a file or directory</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_rename</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path_from</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path_to</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Attempts to rename oldname to newname, moving it between directories if necessary.
|
|
If newname exists, it will be overwritten. This is a departure from what \phpseclib3\Net\SFTP
|
|
does.</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">$path_from</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$path_to</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__rmdir">
|
|
_rmdir()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__rmdir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">603</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.603" class="phpdocumentor-element-found-in__source" data-line="603" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Removes a directory</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_rmdir</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">int </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Only valid $options is STREAM_MKDIR_RECURSIVE per <a href="http://php.net/streamwrapper.rmdir">http://php.net/streamwrapper.rmdir</a>, however,
|
|
<a href="http://php.net/rmdir">http://php.net/rmdir</a> does not have a $recursive parameter as mkdir() does so I don't know how
|
|
STREAM_MKDIR_RECURSIVE is supposed to be set. Also, when I try it out with rmdir() I get 8 as
|
|
$options. What does 8 correspond to?</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">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$options</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_cast">
|
|
_stream_cast()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_cast" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">448</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.448" class="phpdocumentor-element-found-in__source" data-line="448" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Retrieve the underlaying resource</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_cast</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$cast_as</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">resource</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">$cast_as</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">resource</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_close">
|
|
_stream_close()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">719</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.719" class="phpdocumentor-element-found-in__source" data-line="719" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Close an resource</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_close</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_eof">
|
|
_stream_eof()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_eof" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">375</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.375" class="phpdocumentor-element-found-in__source" data-line="375" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Tests for end-of-file on a file pointer</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_eof</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>In my testing there are four classes functions that normally effect the pointer:
|
|
fseek, fputs / fwrite, fgets / fread and ftruncate.</p>
|
|
<p>Only fgets / fread, however, results in feof() returning true. do fputs($fp, 'aaa') on a blank file and feof()
|
|
will return false. do fread($fp, 1) and feof() will then return true. do fseek($fp, 10) on ablank file and feof()
|
|
will return false. do fread($fp, 1) and feof() will then return true.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_flush">
|
|
_stream_flush()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_flush" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">620</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.620" class="phpdocumentor-element-found-in__source" data-line="620" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Flushes the output</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_flush</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>See <a href="http://php.net/fflush">http://php.net/fflush</a>. Always returns true because \phpseclib3\Net\SFTP doesn't cache stuff before writing</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_lock">
|
|
_stream_lock()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_lock" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">459</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.459" class="phpdocumentor-element-found-in__source" data-line="459" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Advisory file locking</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_lock</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$operation</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">$operation</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_metadata">
|
|
_stream_metadata()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_metadata" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">415</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.415" class="phpdocumentor-element-found-in__source" data-line="415" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Change stream options</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_metadata</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">int </span><span class="phpdocumentor-signature__argument__name">$option</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$var</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$option</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$var</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_open">
|
|
_stream_open()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">243</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.243" class="phpdocumentor-element-found-in__source" data-line="243" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Opens file or URL</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_open</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">$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">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$opened_path</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$mode</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$options</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$opened_path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_read">
|
|
_stream_read()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_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="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">284</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.284" class="phpdocumentor-element-found-in__source" data-line="284" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Read from stream</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_read</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$count</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">$count</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_seek">
|
|
_stream_seek()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_seek" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">387</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.387" class="phpdocumentor-element-found-in__source" data-line="387" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Seeks to specific location in a stream</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_seek</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$whence</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">$offset</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$whence</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_set_option">
|
|
_stream_set_option()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_set_option" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">710</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.710" class="phpdocumentor-element-found-in__source" data-line="710" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Change stream options</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_set_option</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$option</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$arg1</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$arg2</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>STREAM_OPTION_WRITE_BUFFER isn't supported for the same reason stream_flush isn't.
|
|
The other two aren't supported because of limitations in \phpseclib3\Net\SFTP.</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">$option</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$arg1</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$arg2</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_stat">
|
|
_stream_stat()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_stat" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">630</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.630" class="phpdocumentor-element-found-in__source" data-line="630" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Retrieve information about a file resource</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_stat</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_tell">
|
|
_stream_tell()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_tell" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">358</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.358" class="phpdocumentor-element-found-in__source" data-line="358" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Retrieve the current position of a stream</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_tell</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_truncate">
|
|
_stream_truncate()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_truncate" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">687</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.687" class="phpdocumentor-element-found-in__source" data-line="687" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Truncate stream</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_truncate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$new_size</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">$new_size</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__stream_write">
|
|
_stream_write()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_write" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">325</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.325" class="phpdocumentor-element-found-in__source" data-line="325" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write to stream</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_stream_write</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|false</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int|false</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__unlink">
|
|
_unlink()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__unlink" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">645</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.645" class="phpdocumentor-element-found-in__source" data-line="645" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Delete a file</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_unlink</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
|
|
<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">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method__url_stat">
|
|
_url_stat()
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#method__url_stat" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php"><a href="files/libs-phpseclib-vendor-phpseclib-phpseclib-phpseclib-net-sftp-stream.html"><abbr title="libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php">Stream.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">666</span>
|
|
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#source-view.666" class="phpdocumentor-element-found-in__source" data-line="666" data-modal="source-view" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Retrieve information about a file</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">_url_stat</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">int </span><span class="phpdocumentor-signature__argument__name">$flags</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
</div>
|
|
|
|
<section class="phpdocumentor-description"><p>Ignores the STREAM_URL_STAT_QUIET flag because the entirety of \phpseclib3\Net\SFTP\Stream is quiet by default
|
|
might be worthwhile to reconstruct bits 12-16 (ie. the file type) if mode doesn't have them but we'll
|
|
cross that bridge when and if it's reached</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">$path</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$flags</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<div class="phpdocumentor-modal" id="source-view">
|
|
<div class="phpdocumentor-modal-bg" data-exit-button></div>
|
|
<div class="phpdocumentor-modal-container">
|
|
<div class="phpdocumentor-modal-content">
|
|
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/libs/phpseclib/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP/Stream.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
|
</div>
|
|
<button data-exit-button class="phpdocumentor-modal__close">×</button>
|
|
</div>
|
|
</div>
|
|
|
|
<script type="text/javascript">
|
|
(function () {
|
|
function loadExternalCodeSnippet(el, url, line) {
|
|
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
|
|
const language = 'php';
|
|
|
|
const code = document.createElement('code');
|
|
code.className = 'language-' + language;
|
|
pre.textContent = '';
|
|
pre.setAttribute('data-line', line)
|
|
code.textContent = 'Loading…';
|
|
pre.appendChild(code);
|
|
|
|
var xhr = new XMLHttpRequest();
|
|
|
|
xhr.open('GET', src, true);
|
|
|
|
xhr.onreadystatechange = function () {
|
|
if (xhr.readyState !== 4) {
|
|
return;
|
|
}
|
|
|
|
if (xhr.status < 400 && xhr.responseText) {
|
|
code.textContent = xhr.responseText;
|
|
Prism.highlightElement(code);
|
|
return;
|
|
}
|
|
|
|
if (xhr.status === 404) {
|
|
code.textContent = '✖ Error: File could not be found';
|
|
return;
|
|
}
|
|
|
|
if (xhr.status >= 400) {
|
|
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
return;
|
|
}
|
|
|
|
code.textContent = '✖ Error: An unknown error occurred';
|
|
};
|
|
|
|
xhr.send(null);
|
|
});
|
|
}
|
|
|
|
const modalButtons = document.querySelectorAll("[data-modal]");
|
|
const openedAsLocalFile = window.location.protocol === 'file:';
|
|
if (modalButtons.length > 0 && openedAsLocalFile) {
|
|
console.warn(
|
|
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
|
|
'browsers block XHR requests when a page is opened this way'
|
|
);
|
|
}
|
|
|
|
modalButtons.forEach(function (trigger) {
|
|
if (openedAsLocalFile) {
|
|
trigger.setAttribute("hidden", "hidden");
|
|
}
|
|
|
|
trigger.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
const modal = document.getElementById(trigger.dataset.modal);
|
|
if (!modal) {
|
|
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
|
|
return;
|
|
}
|
|
modal.classList.add("phpdocumentor-modal__open");
|
|
|
|
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
|
|
const exits = modal.querySelectorAll("[data-exit-button]");
|
|
exits.forEach(function (exit) {
|
|
exit.addEventListener("click", function (event) {
|
|
event.preventDefault();
|
|
modal.classList.remove("phpdocumentor-modal__open");
|
|
});
|
|
});
|
|
});
|
|
});
|
|
})();
|
|
</script>
|
|
|
|
</article>
|
|
</section>
|
|
<section class="phpdocumentor-on-this-page__sidebar">
|
|
|
|
<section class="phpdocumentor-on-this-page__content">
|
|
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
|
|
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/phpseclib3-Net-SFTP-Stream.html#toc-properties">Properties</a></li>
|
|
<li><a href="classes/phpseclib3-Net-SFTP-Stream.html#toc-methods">Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_context">$context</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_instances">$instances</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_entries">$entries</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_eof">$eof</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_mode">$mode</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_notification">$notification</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_path">$path</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_pos">$pos</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_sftp">$sftp</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#property_size">$size</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method___call">__call()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method___construct">__construct()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method_register">register()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method_parse_path">parse_path()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_closedir">_dir_closedir()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_opendir">_dir_opendir()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_readdir">_dir_readdir()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__dir_rewinddir">_dir_rewinddir()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__mkdir">_mkdir()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__rename">_rename()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__rmdir">_rmdir()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_cast">_stream_cast()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_close">_stream_close()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_eof">_stream_eof()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_flush">_stream_flush()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_lock">_stream_lock()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_metadata">_stream_metadata()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_open">_stream_open()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_read">_stream_read()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_seek">_stream_seek()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_set_option">_stream_set_option()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_stat">_stream_stat()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_tell">_stream_tell()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_truncate">_stream_truncate()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__stream_write">_stream_write()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__unlink">_unlink()</a></li>
|
|
<li class=""><a href="classes/phpseclib3-Net-SFTP-Stream.html#method__url_stat">_url_stat()</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
|
|
</section>
|
|
</div>
|
|
<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>
|
|
<a href="classes/phpseclib3-Net-SFTP-Stream.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
</body>
|
|
</html>
|
