API Docs for: 0.8.0
Show:

ArticleRenderer Class

Defined in: include/service/entities/content/article_renderer.js:27
Module: Services

Retrieves the necessary data as well as prepares the layout so a view loader can complete the render of content

Constructor

ArticleRenderer

(
  • context
)

Defined in include/service/entities/content/article_renderer.js:27

Parameters:

  • context Object
    • hostname String
    • site String
    • onlyThisSite Boolean
    • [userService] UserService optional

Methods

containsReadMoreFlag

(
  • content
)
Boolean

Defined in include/service/entities/content/article_renderer.js:453

Parameters:

  • content Object

Returns:

Boolean:

formatAutoBreak

(
  • content
  • context
)

Defined in include/service/entities/content/article_renderer.js:316

Parameters:

  • content Object
  • context Object

formatBylines

(
  • content
  • context
)

Defined in include/service/entities/content/article_renderer.js:148

Parameters:

  • content Object
  • context Object

formatComments

(
  • content
  • context
  • cb
)

Defined in include/service/entities/content/article_renderer.js:222

Parameters:

  • content Object
  • context Object
  • cb Function

formatLayout

(
  • content
  • context
)

Defined in include/service/entities/content/article_renderer.js:188

Parameters:

  • content Object
  • context Object

formatLayoutForReadMore

(
  • content
  • context
)

Defined in include/service/entities/content/article_renderer.js:380

Parameters:

  • content Object
  • context Object
    • readMore Boolean

formatMediaReferences

(
  • content
  • context
  • cb
)

Defined in include/service/entities/content/article_renderer.js:204

Parameters:

  • content Object
  • context Object
  • cb Function

formatTimestamp

(
  • content
  • context
)

Defined in include/service/entities/content/article_renderer.js:174

Parameters:

  • content Object
  • context Object

getCommenters

(
  • comments
  • contentSettings
  • cb
)

Defined in include/service/entities/content/article_renderer.js:252

Retrieves the commenters for an array of comments

Parameters:

  • comments Array

    Array of comment objects

  • contentSettings Object

    Content settings to use for processing

  • cb Function

    Callback function

getContentLinkPrefix

() String

Defined in include/service/entities/content/article_renderer.js:422

Returns:

String:

getLayout

(
  • content
)
String

Defined in include/service/entities/content/article_renderer.js:430

Retrieves the layout from the content object. Provides a mechanism to allow for layout parameter to have any name.

Parameters:

  • content Object

Returns:

String:

getReadMoreSpan

(
  • content
  • anchorContent
)
String

Defined in include/service/entities/content/article_renderer.js:399

Parameters:

  • content Object
  • anchorContent String

Returns:

String:

render

(
  • content
  • context
  • cb
)

Defined in include/service/entities/content/article_renderer.js:92

Parameters:

  • content Object
  • context Object
    • [authors] Object optional

      A hash of user objects representing the authors of the content to be rendered

    • contentSettings Object

      The content settings

    • contentCount Integer

      An integer representing the total number of content objects that will be processed for this request

    • [renderBylines=true] Boolean optional
    • [renderTimestamp=true] Boolean optional
    • [renderComments=true] Boolean optional
    • [readMore=false] Boolean optional
  • cb Function

setLayout

(
  • content
  • layout
)

Defined in include/service/entities/content/article_renderer.js:441

A workaround to allow this prototype to operate on articles and pages. The layout parameter is not the same. Until we introduce breaking changes this will have to do.

Parameters:

  • content Object
  • layout String

Properties

ANONYMOUS_COMMENTER

String private static

Defined in include/service/entities/content/article_renderer.js:83

READ_MORE_FLAG

String private static

Defined in include/service/entities/content/article_renderer.js:74

userService

UserService

Defined in include/service/entities/content/article_renderer.js:66

Instance of user service. No context is provided and therefore can only be used