-
Notifications
You must be signed in to change notification settings - Fork 858
Expand file tree
/
Copy pathssh2-sftp-mkdir.xml
More file actions
122 lines (115 loc) · 3.34 KB
/
ssh2-sftp-mkdir.xml
File metadata and controls
122 lines (115 loc) · 3.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-sftp-mkdir">
<refnamediv>
<refname>ssh2_sftp_mkdir</refname>
<refpurpose>Create a directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ssh2_sftp_mkdir</methodname>
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0777</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<simpara>
Creates a directory on the remote file server with permissions set to
<parameter>mode</parameter>.
</simpara>
<simpara>
This function is similar to using <function>mkdir</function> with the
<link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
<simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dirname</parameter></term>
<listitem>
<simpara>
Path of the new directory.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<simpara>
Permissions on the new directory.
The actual mode is affected by the current umask.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recursive</parameter></term>
<listitem>
<simpara>
If <parameter>recursive</parameter> is &true; any parent directories
required for <parameter>dirname</parameter> will be automatically created as well.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
&return.success;
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Creating a directory on a remote server</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$sftp = ssh2_sftp($connection);
ssh2_sftp_mkdir($sftp, '/home/username/newdir');
/* Or: mkdir("ssh2.sftp://$sftp/home/username/newdir"); */
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>mkdir</function></member>
<member><function>ssh2_sftp_rmdir</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->