<html>
<head>
<title>P4/Ruby - P4DepotFile</title>
<link rel="stylesheet" type="text/css" href="docstyle.css">
</head>
<body>
<p align="right">
<a href="index.html">Contents</a>
</p>
<div class="classhdr">
</div>
<div class="classhdr">
<table border=0>
<tr>
<td>
<span class="classtag">Class</span>
<span class="classname">P4DepotFile</span>
<span class="classparent">< Object</span>
</td>
<td id="righttext">
<span class="requiretag">require</span>
<span class="modulename">"P4"</span>
</td>
</tr>
</table>
</div>
<h3>Description</h3>
Utility class providing easy access to the attributes of a file in a
Perforce depot. Currently only P4#run_filelog returns an array of
P4DepotFile objects. Each P4DepotFile object contains summary information
about the file, and a list of revisions (P4Revision objects) of that file.
<div class="classmethods">
<h3>Class Methods</h3>
<a name="#new"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">new</td>
<td> </td>
<td class="proto">
P4DepotFile.new( <i>aString</i> ) -> <i>aP4DepotFile</i>
</td>
</tr>
</table>
</div>
Constructs a new P4DepotFile object for the named depot file.
</div>
</div>
<div class="instancemethods">
<h3>Instance Methods</h3>
<a name="#depot_file"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">depot_file</td>
<td> </td>
<td class="proto">
<i>df</i>.depot_file -> <i>aString</i>
</td>
</tr>
</table>
</div>
Returns the name of the depot file this object refers to.
</div>
<a name="#each_revision"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">each_revision</td>
<td> </td>
<td class="proto">
<i>df</i>.each_revision { |<i>rev</i>| block } -> <i>revArray</i>
</td>
</tr>
</table>
</div>
Iterates over each revision of the depot file
</div>
<a name="#head_action"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_action</td>
<td> </td>
<td class="proto">
<i>df</i>.head_action -> <i>aString</i>
</td>
</tr>
</table>
</div>
Returns the name of the action that gave rise to the head revision.
</div>
<a name="#head_action-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_action=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_action = <i>aString</i> -> <i>aString</i>
</td>
</tr>
</table>
</div>
Set the name of the action that gave rise to the head revision.
</div>
<a name="#head_change"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_change</td>
<td> </td>
<td class="proto">
<i>df</i>.head_change -> <i>aNumber</i>
</td>
</tr>
</table>
</div>
Get the number of the change that gave rise to the head revision.
</div>
<a name="#head_change-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_change=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_change = <i>aNumber</i> -> <i>aNumber</i>
</td>
</tr>
</table>
</div>
Set the number of the change that gave rise to the head revision.
</div>
<a name="#head_rev"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_rev</td>
<td> </td>
<td class="proto">
<i>df</i>.head_rev -> <i>aNumber</i>
</td>
</tr>
</table>
</div>
Returns the revision number of the head revision.
</div>
<a name="#head_rev-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_rev=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_rev = <i>aNumber</i> -> <i>aNumber</i>
</td>
</td>
</tr>
</table>
</div>
Set the number of the head revision.
</div>
<a name="#head_time"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_time</td>
<td> </td>
<td class="proto">
<i>df</i>.head_time -> <i>aTime</i>
</td>
</tr>
</table>
</div>
Returns the time that the head revision was created.
</div>
<a name="#head_time-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_time=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_time = <i>aTime</i> -> <i>aTime</i>
</td>
</tr>
</table>
</div>
Set the time that the head revision was created.
</div>
<a name="#head_type"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_type</td>
<td> </td>
<td class="proto">
<i>df</i>.head_type -> <i>aString</i>
</td>
</tr>
</table>
</div>
Returns the Perforce type of the head revision.
</div>
<a name="#head_type-eq"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">head_type=</td>
<td> </td>
<td class="proto">
<i>df</i>.head_type = <i>aString</i> -> <i>aString</i>
</td>
</tr>
</table>
</div>
Sets the type of the head revision.
</div>
<a name="#new_revision"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">new_revision</td>
<td> </td>
<td class="proto">
<i>df</i>.new_revision -> <i>aP4Revision</i>
</td>
</tr>
</table>
</div>
Creates a new (empty) P4Revision object and adds it to the list of
revisions of the depot file. Returns the newly created P4Revision object
so that you can populate it.
</div>
<a name="#revisions"></a>
<div class="method">
<div class="methodheader">
<table width="100%">
<tr>
<td class="meth_name">revisions</td>
<td> </td>
<td class="proto">
<i>df</i>.revisions -> <i>aArray</i>
</td>
</tr>
</table>
</div>
Returns an array of revisions of the depot file
</div>
</div>
<h3>See Also</h3>
<div class="seealso">
<a href="P4.html">P4</a>
<a href="P4Exception.html">P4Exception</a>
<a href="P4Integration.html">P4Integration</a>
<a href="P4Revision.html">P4Revision</a>
<a href="P4Spec.html">P4::Spec</a>
</div>
</body>
</html>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #6 | 4680 | Tony Smith |
Make P4Ruby return new P4::Spec objects instead of plain old hashes when parse_forms mode is in use. A P4::Spec object is derived from Hash so should be backwards compatible with previous code. P4::Spec provides limited fieldname validation on forms and accessor methods for quick and easy access to the fields in the form. The accessor methods are all prefixed with '_' to avoid colliding with methods from the Hash parent class. This is a little ugly, but deriving from hash is a big win, so it's worth it. This change also fixes a minor bug found along the way. Spec parsing and formatting wouldn't work with labels, branches, depots and groups unless you'd previously run a P4::fetch_label( <label> ), P4::fetch_branch( <branch> ) etc. etc. This is because the spec parsing code internally runs one of these commands in order to grab the specdef from the server but it wasn't providing a spec name. i.e. it was using 'p4 client -o' and assuming that this would work for other types of spec too. It does, but not for all spec types. So, now the spec parsing code will use a bogus name for the spec types that require it. |
||
| #5 | 4653 | Tony Smith |
More documentation tweaks. Just makes the pages look more like the reference pages in the 'Pickaxe book' |
||
| #4 | 4652 | Tony Smith |
Doc update for P4Ruby. Rework the html and the CSS to make the docs a little easier on the eye and easier to use too. |
||
| #3 | 4255 | Tony Smith |
P4Ruby doc reformatting. Now uses CSS instead of 1x1 image and too many tables. Could no doubt be improved upon, but it's a start. |
||
| #2 | 2426 | Tony Smith | Doc beautifying for P4Ruby. | ||
| #1 | 1324 | Tony Smith |
P4/Ruby documentation update. Changed doc layout and added in docs for newly added methods and classes. |