contentbox.models.comments

Class Comment

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.comments.Comment

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am a Comment Entity

Class Attributes:
  • entityname : cbComment
  •  
  • cacheuse : read-write
  •  
  • table : cb_comment
  •  
  • synchronized : false
  •  
  • cachename : cbComment
  •  
  • batchsize : 25
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    any author


    • access = public
    • returntype = any
    • notnull = true
    • length = 100
    true false
    any authorEmail


    • access = public
    • returntype = any
    • column = authorEmail
    • notnull = true
    • length = 255
    true false
    any authorIP


    • access = public
    • returntype = any
    • column = authorIP
    • notnull = true
    • length = 100
    true false
    any authorURL


    • access = public
    • returntype = any
    • column = authorURL
    • notnull = false
    • length = 255
    true false
    any commentID


    • access = public
    • fieldtype = id
    • returntype = any
    • column = commentID
    • ormtype = string
    • update = false
    • generator = uuid
    • length = 36
    true false
    any content


    • access = public
    • returntype = any
    • notnull = true
    • ormtype = text
    true false
    date createdDate


    • access = public
    • returntype = any
    • column = createdDate
    • notnull = true
    • ormtype = timestamp
    • update = false
    • persistent = true
    true false
    any isApproved


    • access = public
    • returntype = any
    • column = isApproved
    • notnull = true
    • ormtype = boolean
    • index = idx_contentComment,idx_approved
    false true false
    any isDeleted


    • access = public
    • returntype = any
    • column = isDeleted
    • notnull = true
    • ormtype = boolean
    • persistent = true
    false true false
    any markdown


    • access = public
    • returntype = any
    • inject = provider:Processor@cbmarkdown
    • persistent = false
    true false
    date modifiedDate


    • access = public
    • returntype = any
    • column = modifiedDate
    • notnull = true
    • ormtype = timestamp
    • persistent = true
    true false
    any relatedContent


    • access = public
    • fieldtype = many-to-one
    • returntype = any
    • fetch = join
    • notnull = true
    • index = idx_contentComment
    • fkcolumn = FK_contentID
    • cfc = contentbox.models.content.BaseContent
    • lazy = true
    true false
    Constructor Summary
    init()
    Method Summary
    string getAuthor()
    string getAuthorEmail()
    string getAuthorIP()
    string getAuthorURL()
    string getCommentID()
    string getContent()
    string getDisplayContent()
         Render the comment using markdown and encoding it for HTML output.
    string getIsApproved()
    string getMarkdown()
    any getParentSlug()
         Get parent slug from either the page it belongs or the entry it belongs to.
    any getParentTitle()
         Get parent title from either the page it belongs or the entry it belongs to.
    string getRelatedContent()
    struct getRelatedContentSnapshot()
         Build a snapshot of the related content.
    boolean hasRelatedContent([any relatedContent])
    any setAuthor(any author)
    any setAuthorEmail(any authorEmail)
    any setAuthorIP(any authorIP)
    any setAuthorURL(any authorURL)
    any setCommentID(any commentID)
    any setContent(any content)
    any setIsApproved(any isApproved)
    any setMarkdown(any markdown)
    any setRelatedContent(any relatedContent)
     
    Methods inherited from class contentbox.models.BaseEntity
    getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    appendToMemento, appendToMementoProfile, arrayWrap, getDisplayCreatedDate, getDisplayModifiedDate, getEntityName, getId, includeMixin, isLoaded, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    author

    property any author

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    length - 100
    serializable - true

    authorEmail

    property any authorEmail

    Attributes:
    access - public
    required - false
    returntype - any
    column - authorEmail
    notnull - true
    length - 255
    serializable - true

    authorIP

    property any authorIP

    Attributes:
    access - public
    required - false
    returntype - any
    column - authorIP
    notnull - true
    length - 100
    serializable - true

    authorURL

    property any authorURL

    Attributes:
    access - public
    required - false
    returntype - any
    column - authorURL
    notnull - false
    length - 255
    serializable - true

    commentID

    property any commentID

    Attributes:
    access - public
    required - false
    fieldtype - id
    returntype - any
    column - commentID
    ormtype - string
    update - false
    generator - uuid
    length - 36
    serializable - true

    content

    property any content

    Attributes:
    access - public
    required - false
    returntype - any
    notnull - true
    ormtype - text
    serializable - true

    createdDate

    property date createdDate

    Attributes:
    access - public
    required - false
    returntype - any
    column - createdDate
    notnull - true
    ormtype - timestamp
    update - false
    persistent - true
    serializable - true

    isApproved

    property any isApproved = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    column - isApproved
    notnull - true
    ormtype - boolean
    index - idx_contentComment,idx_approved
    serializable - true

    isDeleted

    property any isDeleted = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    column - isDeleted
    notnull - true
    ormtype - boolean
    persistent - true
    serializable - true

    markdown

    property any markdown

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:Processor@cbmarkdown
    persistent - false
    serializable - true

    modifiedDate

    property date modifiedDate

    Attributes:
    access - public
    required - false
    returntype - any
    column - modifiedDate
    notnull - true
    ormtype - timestamp
    persistent - true
    serializable - true

    relatedContent

    property any relatedContent

    Attributes:
    access - public
    required - false
    fieldtype - many-to-one
    returntype - any
    fetch - join
    notnull - true
    index - idx_contentComment
    fkcolumn - FK_contentID
    serializable - true
    cfc - contentbox.models.content.BaseContent
    lazy - true

    Method Detail

    getAuthor

    public string getAuthor()


    getAuthorEmail

    public string getAuthorEmail()


    getAuthorIP

    public string getAuthorIP()


    getAuthorURL

    public string getAuthorURL()


    getCommentID

    public string getCommentID()


    getContent

    public string getContent()


    getDisplayContent

    public string getDisplayContent()

    Render the comment using markdown and encoding it for HTML output


    getIsApproved

    public string getIsApproved()


    getMarkdown

    public string getMarkdown()


    getParentSlug

    public any getParentSlug()

    Get parent slug from either the page it belongs or the entry it belongs to.


    getParentTitle

    public any getParentTitle()

    Get parent title from either the page it belongs or the entry it belongs to.


    getRelatedContent

    public string getRelatedContent()


    getRelatedContentSnapshot

    public struct getRelatedContentSnapshot()

    Build a snapshot of the related content


    hasRelatedContent

    public boolean hasRelatedContent([any relatedContent])

    Parameters:
    relatedContent

    setAuthor

    public any setAuthor(any author)

    Parameters:
    author

    setAuthorEmail

    public any setAuthorEmail(any authorEmail)

    Parameters:
    authorEmail

    setAuthorIP

    public any setAuthorIP(any authorIP)

    Parameters:
    authorIP

    setAuthorURL

    public any setAuthorURL(any authorURL)

    Parameters:
    authorURL

    setCommentID

    public any setCommentID(any commentID)

    Parameters:
    commentID

    setContent

    public any setContent(any content)

    Parameters:
    content

    setIsApproved

    public any setIsApproved(any isApproved)

    Parameters:
    isApproved

    setMarkdown

    public any setMarkdown(any markdown)

    Parameters:
    markdown

    setRelatedContent

    public any setRelatedContent(any relatedContent)

    Parameters:
    relatedContent