P4Cms_Content_EnhancedDecoratorInterface Interface Reference

Provides a contract for decorators to be enhanced for use with content records: More...

Inheritance diagram for P4Cms_Content_EnhancedDecoratorInterface:

List of all members.

Public Member Functions
	getContentRecord ()
	Get the associated content record (if set).
	setContentRecord ($content)
	Set the associated content record for this element.

---

Detailed Description

Provides a contract for decorators to be enhanced for use with content records:

• Specifies methods to associate a decorator with a content record. This is useful when rendering display decorators for arbitrary elements as it allows decorators to access the content record and pull out other information (e.g. a view link when decorating a title element).

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_Content_EnhancedDecoratorInterface::getContentRecord

(

)

Get the associated content record (if set).

Returns:

null|P4Cms_Content the associated content record or null if none set.

Implemented in Content_Form_Decorator_ContentIcon, and Content_Form_Decorator_ContentLink.

P4Cms_Content_EnhancedDecoratorInterface::setContentRecord

(

$

content

)

Set the associated content record for this element.

Parameters:

P4Cms_Content

$content

the associated content record for this element.

Implemented in Content_Form_Decorator_ContentIcon, and Content_Form_Decorator_ContentLink.

---

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

• EnhancedDecoratorInterface.php