Diogenes_VCS_RCS Class Reference

Inheritance diagram for Diogenes_VCS_RCS:

[legend]Collaboration diagram for Diogenes_VCS_RCS:

[legend]List of all members.

Public Member Functions
	Diogenes_VCS_RCS (&$caller, $alias, $login, $init=false)
	rcsPath ($parent="", $entry="")
	rcsFile ($dir, $file)
	checkFile ($dir, $file)
	checkDir ($dir)
	checkout ($dir, $file, $rev, $output)
	commit ($dir, $file, $content, $message="")
	copy ($sdir, $sfile, $ddir, $dfile)
	del ($dir, $file)
	diff ($dir, $file, $r1, $r2)
	importWordFile ($dir, $htmlfile, $wordfile)
	importWordFile_wvHtml ($dir, $htmlfile, $wordfile)
	logEntries ($dir, $file)
	logParse ($dir, $file)
	move ($sdir, $sfile, $ddir, $dfile)
	newdir ($parent, $dir)
	dispDiff ($dir, $file, $r1, $r2)
	dispDir ($dir, $loc, $canedit)
	dispEntry ($dir, $loc, $file, $canedit)
	dispSize ($size)
Public Attributes
	$rcsdir
	$login

---

Detailed Description

This class handles Diogenes RCS operations.

Definition at line 28 of file RCS.php.

---

Member Function Documentation

Diogenes_VCS_RCS::Diogenes_VCS_RCS	(	&$	caller,
		$	alias,
		$	login,
		$	init = false
	)

The constructor.

Parameters:

	caller
	alias
	login	the current user's login
	init	should create this module?

Definition at line 41 of file RCS.php.

References Diogenes_VCS_Spool::$alias, Diogenes_VCS_Spool::$caller, $login, Diogenes_VCS_Spool::Diogenes_VCS_Spool(), and Diogenes_VCS_Spool::kill().

Referenced by Diogenes_VCS_CVS::Diogenes_VCS_CVS().

Here is the call graph for this function:

Diogenes_VCS_RCS::rcsPath	(	$	parent = "",
		$	entry = ""
	)

Return the path of an RCS "item" (file or directory).

Parameters:

	parent	parent directory (optional)
	entry	the item

Definition at line 70 of file RCS.php.

References Diogenes_VCS_Spool::checkPath().

Referenced by checkDir(), Diogenes_VCS_CVS::checkDir(), dispDir(), dispEntry(), newdir(), and rcsFile().

Here is the call graph for this function:

Diogenes_VCS_RCS::rcsFile	(	$	dir,
		$	file
	)

Return the path of an RCS file (something,v).

Parameters:

	dir	parent directory
	file	the RCS entry

Definition at line 81 of file RCS.php.

References rcsPath().

Referenced by checkFile(), checkout(), commit(), Diogenes_VCS_CVS::commit(), del(), diff(), logEntries(), and move().

Here is the call graph for this function:

Diogenes_VCS_RCS::checkFile	(	$	dir,
		$	file
	)

Check whether a file is registered in RCS.

Parameters:

	dir	parent directory
	file	the RCS entry

Definition at line 91 of file RCS.php.

References rcsFile().

Referenced by copy().

Here is the call graph for this function:

Diogenes_VCS_RCS::checkDir

(

$

dir

)

Perform sanity check on an RCS directory and the corresponding checkout in the spool

Parameters:

dir

Reimplemented in Diogenes_VCS_CVS.

Definition at line 101 of file RCS.php.

References rcsPath(), and Diogenes_VCS_Spool::spoolPath().

Referenced by commit(), copy(), and move().

Here is the call graph for this function:

Diogenes_VCS_RCS::checkout	(	$	dir,
		$	file,
		$	rev,
		$	output
	)

Do a checkout of an RCS item to a given location.

Parameters:

	dir	parent directory
	file	the RCS entry
	rev	the revision to check out
	output	the directory to which we want to perform the checkout

Definition at line 116 of file RCS.php.

References Diogenes_VCS_Spool::cmdExec(), Diogenes_VCS_Spool::cmdStatus(), Diogenes_VCS_Spool::info(), and rcsFile().

Here is the call graph for this function:

Diogenes_VCS_RCS::commit	(	$	dir,
		$	file,
		$	content,
		$	message = ""
	)

Commit an RCS item. Returns true for succes, false for an error.

Parameters:

	dir	parent directory
	file	the RCS entry
	content	the contents of the new revision
	message	the log message for this revision

Reimplemented in Diogenes_VCS_CVS.

Definition at line 137 of file RCS.php.

References checkDir(), Diogenes_VCS_Spool::cmdExec(), Diogenes_VCS_Spool::cmdStatus(), Diogenes_VCS_Spool::info(), Diogenes_VCS_Spool::log(), rcsFile(), and Diogenes_VCS_Spool::spoolPath().

Referenced by copy(), and importWordFile_wvHtml().

Here is the call graph for this function:

Diogenes_VCS_RCS::copy	(	$	sdir,
		$	sfile,
		$	ddir,
		$	dfile
	)

Make a copy of an RCS item to a given location.

Parameters:

	sdir	the source directory
	sfile	the source RCS entry
	ddir	the destination directory
	dfile	the destination RCS entry

Definition at line 206 of file RCS.php.

References checkDir(), checkFile(), commit(), Diogenes_VCS_Spool::info(), and Diogenes_VCS_Spool::spoolPath().

Here is the call graph for this function:

Diogenes_VCS_RCS::del	(	$	dir,
		$	file
	)

Delete an RCS file and its corresponding spool entry.

Parameters:

	dir	parent directory
	file	the RCS entry

Definition at line 236 of file RCS.php.

References Diogenes_VCS_Spool::info(), Diogenes_VCS_Spool::log(), rcsFile(), and Diogenes_VCS_Spool::spoolPath().

Here is the call graph for this function:

Diogenes_VCS_RCS::diff	(	$	dir,
		$	file,
		$	r1,
		$	r2
	)

Retrieve differences between two version of a file.

Parameters:

	dir	parent directory
	file	the RCS entry
	r1	the first revision
	r2	the second revision

Reimplemented in Diogenes_VCS_CVS.

Definition at line 251 of file RCS.php.

References Diogenes_VCS_Spool::cmdExec(), Diogenes_VCS_Spool::info(), and rcsFile().

Referenced by dispDiff().

Here is the call graph for this function:

Diogenes_VCS_RCS::importWordFile	(	$	dir,
		$	htmlfile,
		$	wordfile
	)

Converts a Word document to HTML and commits the resulting HTML and images.

Parameters:

	dir
	htmlfile
	wordfile

Definition at line 267 of file RCS.php.

References Diogenes_VCS_Spool::info().

Here is the call graph for this function:

Diogenes_VCS_RCS::importWordFile_wvHtml	(	$	dir,
		$	htmlfile,
		$	wordfile
	)

Converts a Word document to HTML using wvHtml and commits the resulting HTML and images.

Parameters:

	dir
	htmlfile
	wordfile

Definition at line 295 of file RCS.php.

References Diogenes_VCS_Spool::cmdExec(), Diogenes_VCS_Spool::cmdStatus(), commit(), Diogenes_VCS_Spool::importHtmlString(), and Diogenes_VCS_Spool::info().

Here is the call graph for this function:

Diogenes_VCS_RCS::logEntries	(	$	dir,
		$	file
	)

Returns raw log entries for an RCS item.

Parameters:

	dir	parent directory
	file	the RCS entry

Reimplemented in Diogenes_VCS_CVS.

Definition at line 344 of file RCS.php.

References Diogenes_VCS_Spool::cmdExec(), and rcsFile().

Referenced by logParse().

Here is the call graph for this function:

Diogenes_VCS_RCS::logParse	(	$	dir,
		$	file
	)

Parse the log entries for an RCS item into an array.

Parameters:

	dir	parent directory
	file	the RCS entry

Definition at line 356 of file RCS.php.

References Diogenes_VCS_Spool::log(), and logEntries().

Referenced by dispEntry().

Here is the call graph for this function:

Diogenes_VCS_RCS::move	(	$	sdir,
		$	sfile,
		$	ddir,
		$	dfile
	)

Move an RCS item to a given location.

Parameters:

	sdir	the source directory
	sfile	the source RCS entry
	ddir	the destination directory
	dfile	the destination RCS entry

Definition at line 391 of file RCS.php.

References checkDir(), Diogenes_VCS_Spool::info(), rcsFile(), and Diogenes_VCS_Spool::spoolPath().

Here is the call graph for this function:

Diogenes_VCS_RCS::newdir	(	$	parent,
		$	dir
	)

Add a new RCS-managed directory.

Parameters:

	parent	the parent directory
	dir	the directory to add

Reimplemented in Diogenes_VCS_CVS.

Definition at line 454 of file RCS.php.

References rcsPath(), and Diogenes_VCS_Spool::spoolPath().

Here is the call graph for this function:

Diogenes_VCS_RCS::dispDiff	(	$	dir,
		$	file,
		$	r1,
		$	r2
	)

Retrieve differences between two version of a file and prepare for output.

Parameters:

	dir	parent directory
	file	the RCS entry
	r1	the first revision
	r2	the second revision

Definition at line 468 of file RCS.php.

References diff().

Here is the call graph for this function:

Diogenes_VCS_RCS::dispDir	(	$	dir,
		$	loc,
		$	canedit
	)

Return an RCS-managed directory.

Parameters:

	dir	the directory
	loc	the visible location for the directory
	canedit	can we edit files in this directory?

Definition at line 517 of file RCS.php.

References dispEntry(), and rcsPath().

Here is the call graph for this function:

Diogenes_VCS_RCS::dispEntry	(	$	dir,
		$	loc,
		$	file,
		$	canedit
	)

Returns an RCS "item" (file or directory).

Parameters:

	dir	parent directory
	loc	visible location for parent directory
	file	the RCS "item"
	canedit	can we edit files this entry?

Definition at line 542 of file RCS.php.

References dispSize(), Diogenes_VCS_Spool::info(), logParse(), rcsPath(), and Diogenes_VCS_Spool::spoolPath().

Referenced by dispDir().

Here is the call graph for this function:

Diogenes_VCS_RCS::dispSize

(

$

size

)

Format a file size for display.

Parameters:

size

the size, in bytes

Definition at line 604 of file RCS.php.

Referenced by dispEntry().

---

Member Data Documentation

Diogenes_VCS_RCS::$rcsdir

Absolute directory location for the barrel's RCS files.

Definition at line 30 of file RCS.php.

Diogenes_VCS_RCS::$login

The username

Definition at line 33 of file RCS.php.

Referenced by Diogenes_VCS_CVS::Diogenes_VCS_CVS(), and Diogenes_VCS_RCS().

---

The documentation for this class was generated from the following file:

• RCS.php

---