P4_ConnectedInterface Interface Reference

Provides a common interface for connected models. More...

Inheritance diagram for P4_ConnectedInterface:

List of all members.

Public Member Functions
	__construct (P4_Connection_Interface $connection=null)
	Instantiate the model and set the connection to use.
	clearConnection ()
	Clear this model's connection.
	getConnection ()
	Get the Perforce connection used by this model.
	hasConnection ()
	Determine if this model has a connection to Perforce.
	setConnection (P4_Connection_Interface $connection)
	Set the Perforce connection to use when issuing Perforce commands for this instance.
Static Public Member Functions
static	getDefaultConnection ()
	Get the default Perforce connection to use.

---

Detailed Description

Provides a common interface for connected models.

Copyright:

2011-2012 Perforce Software. All rights reserved

License:

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

Version:

2012.2/486814

---

Constructor & Destructor Documentation

P4_ConnectedInterface::__construct

(

P4_Connection_Interface $

connection = null

)

Instantiate the model and set the connection to use.

Parameters:

P4_Connection_Interface

$connection

optional - a connection to use for this instance.

Implemented in P4_ConnectedAbstract.

---

Member Function Documentation

P4_ConnectedInterface::clearConnection

(

)

Clear this model's connection.

This is primarily for testing purposes.

Implemented in P4_ConnectedAbstract.

P4_ConnectedInterface::getConnection

(

)

Get the Perforce connection used by this model.

Returns:

P4_Connection_Interface the connection instance used by this model.

Implemented in P4_ConnectedAbstract.

static P4_ConnectedInterface::getDefaultConnection

(

)

[static]

Get the default Perforce connection to use.

Returns:

P4_Connection_Interface the default connection.

Implemented in P4_ConnectedAbstract.

P4_ConnectedInterface::hasConnection

(

)

Determine if this model has a connection to Perforce.

Returns:

bool true if the model has a connection to Perforce.

Implemented in P4_ConnectedAbstract.

P4_ConnectedInterface::setConnection

(

P4_Connection_Interface $

connection

)

Set the Perforce connection to use when issuing Perforce commands for this instance.

Parameters:

P4_Connection_Interface

$connection

the connection to use for this instance.

Returns:

P4_ModelAbstract provides fluent interface.

Implemented in P4_ConnectedAbstract.

---

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

• ConnectedInterface.php