P4_Connection_CommandException Class Reference

Exception to be thrown when an error occurs running a Perforce command. More...

Inheritance diagram for P4_Connection_CommandException:

List of all members.

Public Member Functions
	getConnection ()
	Get the perforce Connection instance if one is set.
	getResult ()
	Get the perforce result object if one is set.
	setConnection (P4_Connection_Interface $connection)
	Set the perforce Connection instance.
	setResult ($result)
	Set the perforce result object.

---

Detailed Description

Exception to be thrown when an error occurs running a Perforce command.

Holds the associated Connection instance and result object.

Copyright:

2011-2012 Perforce Software. All rights reserved

License:

Please see LICENSE.txt in top-level folder of this distribution.

Version:

2012.2/486814

---

Member Function Documentation

P4_Connection_CommandException::getConnection

(

)

Get the perforce Connection instance if one is set.

Returns:

P4_Connection_Interface the perforce Connection instance.

    {
        if (isset($this->_connection)) {
            return $this->_connection;
        }
    }

P4_Connection_CommandException::getResult

(

)

Get the perforce result object if one is set.

Returns:

P4_Result the perforce result object.

    {
        if (isset($this->_result)) {
            return $this->_result;
        }
    }

P4_Connection_CommandException::setConnection

(

P4_Connection_Interface $

connection

)

Set the perforce Connection instance.

Parameters:

P4_Connection_Interface

$connection

the perforce Connection instance.

    {
        $this->_connection = $connection;
    }

P4_Connection_CommandException::setResult

(

$

result

)

Set the perforce result object.

Parameters:

P4_Result

$result

the perforce result object.

    {
        if ($result instanceof P4_Result) {
            $this->_result = $result;
        }
    }

---

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

• CommandException.php