📄 function.svn-status.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Returns the status of working copy files and directories</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.svn-repos-recover.html">svn_repos_recover</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.svn-update.html">svn_update</a></div> <div class="up"><a href="ref.svn.html">SVN Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.svn-status" class="refentry"> <div class="refnamediv"> <h1 class="refname">svn_status</h1> <p class="verinfo">(PECL svn:0.1-0.2)</p><p class="refpurpose"><span class="refname">svn_status</span> — <span class="dc-title">Returns the status of working copy files and directories</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><b><b>svn_status</b></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$path</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$flags</tt></span> ] )</div> <p class="para rdfs-comment"> Returns the status of working copy files and directories, giving modifications, additions, deletions and other changes to items in the working copy. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">path</tt></i></span> <dd> <p class="para"> Local path to file or directory to retrieve status of. </p> <blockquote><p><b class="note">Note</b>: <span class="simpara">Relative paths will be resolved as if the current working directory was the one that contains the PHP binary. To use the calling script's working directory, use <a href="function.realpath.html" class="function">realpath()</a> or dirname(__FILE__).</span></p></blockquote> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">flags</tt></i></span> <dd> <p class="para"> Any combination of <b><tt>SVN_NON_RECURSIVE</tt></b>, <b><tt>SVN_ALL</tt></b> (regardless of modification status), <b><tt>SVN_SHOW_UPDATES</tt></b> (entries will be added for items that are out-of-date), <b><tt>SVN_NO_IGNORE</tt></b> (disregard <i>svn:ignore</i> properties when scanning for new files) and <b><tt>SVN_IGNORE_EXTERNALS</tt></b>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a numerically indexed array of associative arrays detailing the status of items in the repository: </p> <div class="example-contents"><pre><div class="cdata"><pre>Array ( [0] => Array ( // information on item ) [1] => ...)</pre></div> </pre></div> <p class="para"> The information on the item is an associative array that can contain the following keys: </p> <dl> <dt> <span class="term"><var class="varname">path</var></span> <dd> <span class="simpara"> String path to file/directory of this entry on local filesystem. </span> </dd> </dt> <dt> <span class="term"><var class="varname">text_status</var></span> <dd> <span class="simpara"> Status of item's text. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values. </span> </dd> </dt> <dt> <span class="term"><var class="varname">repos_text_status</var></span> <dd> <span class="simpara"> Status of item's text in repository. Only accurate if <i><tt class="parameter">update</tt></i> was set to <b><tt>TRUE</tt></b>. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values. </span> </dd> </dt> <dt> <span class="term"><var class="varname">prop_status</var></span> <dd> <span class="simpara"> Status of item's properties. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values. </span> </dd> </dt> <dt> <span class="term"><var class="varname">repos_prop_status</var></span> <dd> <span class="simpara"> Status of item's property in repository. Only accurate if <i><tt class="parameter">update</tt></i> was set to <b><tt>TRUE</tt></b>. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values. </span> </dd> </dt> <dt> <span class="term"><var class="varname">locked</var></span> <dd> <span class="simpara"> Whether or not the item is locked. (Only set if <b><tt>TRUE</tt></b>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">copied</var></span> <dd> <span class="simpara"> Whether or not the item was copied (scheduled for addition with history). (Only set if <b><tt>TRUE</tt></b>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">switched</var></span> <dd> <span class="simpara"> Whether or not the item was switched using the switch command. (Only set if <b><tt>TRUE</tt></b>) </span> </dd> </dt> </dl> <p class="para"> These keys are only set if the item is versioned: </p> <dl> <dt> <span class="term"><var class="varname">name</var></span> <dd> <span class="simpara"> Base name of item in repository. </span> </dd> </dt> <dt> <span class="term"><var class="varname">url</var></span> <dd> <span class="simpara"> URL of item in repository. </span> </dd> </dt> <dt> <span class="term"><var class="varname">repos</var></span> <dd> <span class="simpara"> Base URL of repository. </span> </dd> </dt> <dt> <span class="term"><var class="varname">revision</var></span> <dd> <span class="simpara"> Integer revision of item in working copy. </span> </dd> </dt> <dt> <span class="term"><var class="varname">kind</var></span> <dd> <span class="simpara"> Type of item, i.e. file or directory. Refer to <a href="svn.constants.html#svn.constants.type" class="link">type constants</a> for possible values. </span> </dd> </dt> <dt> <span class="term"><var class="varname">schedule</var></span> <dd> <span class="simpara"> Scheduled action for item, i.e. addition or deletion. Constants for these magic numbers are not available, they can be emulated by using: </span> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">defined</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_normal'</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_normal'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// nothing special<br /> </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_add'</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">); </span><span style="color: #FF8000">// item will be added<br /> </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_delete'</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">); </span><span style="color: #FF8000">// item will be deleted<br /> </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_replace'</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">); </span><span style="color: #FF8000">// item will be added and deleted<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </dd> </dt> <dt> <span class="term"><var class="varname">deleted</var></span> <dd> <span class="simpara"> Whether or not the item was deleted, but parent revision lags behind. (Only set if <b><tt>TRUE</tt></b>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">absent</var></span> <dd> <span class="simpara"> Whether or not the item is absent, that is, Subversion knows that there should be something there but there isn't. (Only set if <b><tt>TRUE</tt></b>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">incomplete</var></span> <dd> <span class="simpara"> Whether or not the entries file for a directory is incomplete. (Only set if <b><tt>TRUE</tt></b>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">cmt_date</var></span> <dd> <span class="simpara"> Integer Unix timestamp of last commit date. (Unaffected by <i><tt class="parameter">update</tt></i>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">cmt_rev</var></span> <dd> <span class="simpara"> Integer revision of last commit. (Unaffected by <i><tt class="parameter">update</tt></i>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">cmt_author</var></span> <dd> <span class="simpara"> String author of last commit. (Unaffected by <i><tt class="parameter">update</tt></i>.) </span> </dd> </dt> <dt> <span class="term"><var class="varname">prop_time</var></span> <dd> <span class="simpara"> Integer Unix timestamp of last up-to-date time for properties </span> </dd> </dt> <dt> <span class="term"><var class="varname">text_time</var></span> <dd> <span class="simpara"> Integer Unix timestamp of last up-to-date time for text </span> </dd> </dt> </dl> </div> <div class="refsect1 notes"> <h3 class="title">Notes</h3> <div class="warning"><b class="warning">Warning</b><p class="simpara">This function is<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, andsurrounding documentation may change without notice in a future release of PHP.This function should be used at your own risk.</p></div> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 Basic example</b></p> <div class="example-contents"><p> This example demonstrates a basic, theoretical usage of this function. </p></div> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">svn_status</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #DD0000">'wc'</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents"><pre><div class="cdata"><pre>Array ( [0] => Array ( [path] => /home/bob/wc/sandwich.txt [text_status] => 8 // item was modified [repos_text_status] => 1 // no information available, use update [prop_status] => 3 // no changes [repos_prop_status] => 1 // no information available, use update [name] => sandwich.txt [url] => http://www.example.com/svnroot/deli/trunk/sandwich.txt [repos] => http://www.example.com/svnroot/ [revision] => 123 [kind] => 1 // file [schedule] => 0 // no special actions scheduled [cmt_date] => 1165543135 [cmt_rev] => 120 [cmt_author] => Alice [prop_time] => 1180201728 [text_time] => 1180201729 ))</pre></div> </pre></div> </div> </p> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.svn-update.html" class="function" rel="rdfs-seeAlso">svn_update()</a></li> <li class="member"><a href="function.svn-log.html" class="function" rel="rdfs-seeAlso">svn_log()</a></li> <li class="member"><a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.status.html" class="link external">» SVN documentation for svn status</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.svn-repos-recover.html">svn_repos_recover</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.svn-update.html">svn_update</a></div> <div class="up"><a href="ref.svn.html">SVN Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -