Perforce Chronicle 2012.2/486814
API Documentation

P4_ModelInterface Interface Reference

Provides a common interface for models that utilize fields. More...

Inheritance diagram for P4_ModelInterface:
P4_ModelAbstract P4_File P4_SpecAbstract P4_Protections P4_Spec_PluralAbstract P4_Triggers P4_Typemap P4_Branch P4_Change P4_Client P4_Depot P4_Group P4_Job P4_Label P4_Stream P4_User

List of all members.

Public Member Functions

 getFields ()
 Return array with all model fields.
 getValue ($field)
 Return value of given field of the model.
 hasField ($field)
 Check if given field is valid model field.
 toArray ()
 Get the model data as an array.

Detailed Description

Provides a common interface for models that utilize fields.

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_ModelInterface::getFields ( )

Return array with all model fields.

Returns:
array

Implemented in P4_File, and P4_SpecAbstract.

P4_ModelInterface::getValue ( field)

Return value of given field of the model.

Parameters:
string$fieldmodel field to retrieve
Returns:
mixed

Implemented in P4_File, P4_Job, and P4_SpecAbstract.

P4_ModelInterface::hasField ( field)

Check if given field is valid model field.

Parameters:
string$fieldmodel field to check
Returns:
boolean

Implemented in P4_File, and P4_SpecAbstract.

P4_ModelInterface::toArray ( )

Get the model data as an array.

Returns:
array the model data as an array.

Implemented in P4_ModelAbstract.


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