Perforce Chronicle 2012.2/486814
API Documentation

P4Cms_Record_EnhancedElementInterface Interface Reference

Provides a contract for form elements to be enhanced for use with records: More...

Inheritance diagram for P4Cms_Record_EnhancedElementInterface:
Content_Form_Element_File Content_Form_Element_ImageFile

List of all members.

Public Member Functions

 populateFromRecord (P4Cms_Record $record)
 Set the element value from the given record.
 populateRecord (P4Cms_Record $record)
 Set the element value on the given record.

Detailed Description

Provides a contract for form elements to be enhanced for use with records:

  • Specifies a method to populate a record from a form element which allows the element to make decisions and modify other aspects of the record object (e.g. set metadata).
  • Specifies a method to populate the form element from a record with the benefit of reading other aspects of the record.
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

P4Cms_Record_EnhancedElementInterface::populateFromRecord ( P4Cms_Record record)

Set the element value from the given record.

Allows for decision making and consideration of other aspects of the record.

Parameters:
P4Cms_Record$recordthe record to read the value from
Returns:
P4Cms_Record_EnhancedElementInterface provides fluent interface

Implemented in Content_Form_Element_File.

P4Cms_Record_EnhancedElementInterface::populateRecord ( P4Cms_Record record)

Set the element value on the given record.

Allows for decision making and modification of other aspects of the record (such as setting metadata).

Parameters:
P4Cms_Record$recordthe record to set the value on
Returns:
P4Cms_Record_EnhancedElementInterface provides fluent interface

Implemented in Content_Form_Element_File, and Content_Form_Element_ImageFile.


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