Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
CommentInterface Interface Reference
Inheritance diagram for CommentInterface:
CreditmemoCommentCreationInterface InvoiceCommentCreationInterface InvoiceCommentInterface ShipmentCommentCreationInterface ShipmentCommentInterface CommentCreation CommentCreation Comment CommentCreation Comment

Public Member Functions

 getComment ()
 
 setComment ($comment)
 
 getIsVisibleOnFront ()
 
 setIsVisibleOnFront ($isVisibleOnFront)
 

Data Fields

const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'
 
const COMMENT = 'comment'
 

Detailed Description

Interface CommentInterface

@api

Since
100.1.2

Definition at line 14 of file CommentInterface.php.

Member Function Documentation

◆ getComment()

getComment ( )

Gets the comment text.

Returns
string Comment.
Since
100.1.2

Implemented in Comment, Comment, CommentCreation, CommentCreation, and CommentCreation.

◆ getIsVisibleOnFront()

getIsVisibleOnFront ( )

Gets the is-visible-on-storefront flag value for the comment.

Returns
int Is-visible-on-storefront flag value.
Since
100.1.2

Implemented in Comment, Comment, CommentCreation, CommentCreation, and CommentCreation.

◆ setComment()

setComment (   $comment)

Sets the comment text.

Parameters
string$comment
Returns
$this
Since
100.1.2

Implemented in Comment, Comment, CommentCreation, CommentCreation, and CommentCreation.

◆ setIsVisibleOnFront()

setIsVisibleOnFront (   $isVisibleOnFront)

Sets the is-visible-on-storefront flag value for the comment.

Parameters
int$isVisibleOnFront
Returns
$this
Since
100.1.2

Implemented in Comment, Comment, CommentCreation, CommentCreation, and CommentCreation.

Field Documentation

◆ COMMENT

const COMMENT = 'comment'

Definition at line 24 of file CommentInterface.php.

◆ IS_VISIBLE_ON_FRONT

const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'

Definition at line 19 of file CommentInterface.php.


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