Diogenes_VCS_Spool Class Reference

Inheritance diagram for Diogenes_VCS_Spool:

[legend]List of all members.

Public Member Functions
	Diogenes_VCS_Spool (&$caller, $alias)
	cmdExec ($cmd)
	cmdStatus ()
	info ($msg)
	kill ($msg)
	log ($action, $data)
	checkPath ($parent, $entry, $fatal=true)
	exportHtmlString ($html)
	importHtmlString ($html)
	spoolPath ($parent="", $entry="")
Public Attributes
	$alias
	$datadir
	$cmd_call
	$cmd_output
	$cmd_return
	$caller

---

Detailed Description

This class handles Diogenes spool operations.

Definition at line 24 of file Spool.php.

---

Member Function Documentation

Diogenes_VCS_Spool::Diogenes_VCS_Spool	(	&$	caller,
		$	alias
	)

The constructor.

Parameters:

	caller	the caller
	alias	the alias to work on

Definition at line 50 of file Spool.php.

References $alias, and $caller.

Referenced by Diogenes_VCS_RCS::Diogenes_VCS_RCS().

Diogenes_VCS_Spool::cmdExec

(

$

cmd

)

Execute a shell command and store information about it.

Parameters:

$cmd

the command to execute

Definition at line 62 of file Spool.php.

Referenced by Diogenes_VCS_RCS::checkout(), Diogenes_VCS_RCS::commit(), Diogenes_VCS_CVS::commit(), Diogenes_VCS_RCS::diff(), Diogenes_VCS_CVS::diff(), Diogenes_VCS_CVS::Diogenes_VCS_CVS(), Diogenes_VCS_RCS::importWordFile_wvHtml(), Diogenes_VCS_RCS::logEntries(), Diogenes_VCS_CVS::logEntries(), and Diogenes_VCS_CVS::newdir().

Diogenes_VCS_Spool::cmdStatus

(

)

Return information about the last command that was executed.

Definition at line 76 of file Spool.php.

Referenced by Diogenes_VCS_RCS::checkout(), Diogenes_VCS_RCS::commit(), Diogenes_VCS_CVS::commit(), Diogenes_VCS_CVS::Diogenes_VCS_CVS(), and Diogenes_VCS_RCS::importWordFile_wvHtml().

Diogenes_VCS_Spool::info

(

$

msg

)

Report an information.

Parameters:

msg

Definition at line 93 of file Spool.php.

Referenced by Diogenes_VCS_RCS::checkout(), Diogenes_VCS_RCS::commit(), Diogenes_VCS_CVS::commit(), Diogenes_VCS_RCS::copy(), Diogenes_VCS_RCS::del(), Diogenes_VCS_RCS::diff(), Diogenes_VCS_CVS::diff(), Diogenes_VCS_CVS::Diogenes_VCS_CVS(), Diogenes_VCS_RCS::dispEntry(), Diogenes_VCS_RCS::importWordFile(), Diogenes_VCS_RCS::importWordFile_wvHtml(), and Diogenes_VCS_RCS::move().

Diogenes_VCS_Spool::kill

(

$

msg

)

Die with a given error message.

Parameters:

msg

Definition at line 102 of file Spool.php.

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

Diogenes_VCS_Spool::log	(	$	action,
		$	data
	)

Record an action to the log.

Parameters:

	action
	data

Definition at line 112 of file Spool.php.

Referenced by Diogenes_VCS_RCS::commit(), Diogenes_VCS_CVS::commit(), Diogenes_VCS_RCS::del(), and Diogenes_VCS_RCS::logParse().

Diogenes_VCS_Spool::checkPath	(	$	parent,
		$	entry,
		$	fatal = true
	)

Check that a path is valid.

Parameters:

	parent	parent directory
	entry	the item
	fatal	should we consider a failure to be fatal?

Definition at line 123 of file Spool.php.

References kill().

Referenced by Diogenes_VCS_RCS::rcsPath(), and spoolPath().

Here is the call graph for this function:

Diogenes_VCS_Spool::exportHtmlString

(

$

html

)

Add missing tags to a Diogenes page to make it a proper HTML file

Parameters:

html

See also:

importHtmlString

Definition at line 139 of file Spool.php.

Diogenes_VCS_Spool::importHtmlString

(

$

html

)

Makes a Diogenes page from a proper HTML file, that is return everything inside the "body" tags.

Parameters:

html

See also:

exportHtmlString

Definition at line 155 of file Spool.php.

Referenced by Diogenes_VCS_RCS::importWordFile_wvHtml().

Diogenes_VCS_Spool::spoolPath	(	$	parent = "",
		$	entry = ""
	)

Return the path of a spool "item" (file or directory).

Parameters:

	parent	parent directory (optional)
	entry	the item

Definition at line 197 of file Spool.php.

References checkPath().

Referenced by Diogenes_VCS_RCS::checkDir(), Diogenes_VCS_CVS::checkDir(), Diogenes_VCS_RCS::commit(), Diogenes_VCS_CVS::commit(), Diogenes_VCS_RCS::copy(), Diogenes_VCS_RCS::del(), Diogenes_VCS_CVS::diff(), Diogenes_VCS_CVS::Diogenes_VCS_CVS(), Diogenes_VCS_RCS::dispEntry(), Diogenes_VCS_CVS::logEntries(), Diogenes_VCS_RCS::move(), Diogenes_VCS_RCS::newdir(), and Diogenes_VCS_CVS::newdir().

Here is the call graph for this function:

---

Member Data Documentation

Diogenes_VCS_Spool::$alias

The barrel we are running on

Definition at line 26 of file Spool.php.

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

Diogenes_VCS_Spool::$datadir

Absolute directory location for the barrel's spool.

Definition at line 28 of file Spool.php.

Diogenes_VCS_Spool::$cmd_call

The last command that was executed.

Definition at line 31 of file Spool.php.

Diogenes_VCS_Spool::$cmd_output

The output of the last command that was executed.

Definition at line 34 of file Spool.php.

Diogenes_VCS_Spool::$cmd_return

The return value of the last command.

Definition at line 37 of file Spool.php.

Diogenes_VCS_Spool::$caller

The caller. It needs to define the 3 following methods :

See also:

info, kill, log

Definition at line 43 of file Spool.php.

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

---

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

• Spool.php

---