API Docs for: 0.8.0
Show:

ArticleServiceV2 Class

Extends ContentObjectService
Defined in: include/service/entities/content/article_service_v2.js:30
Module: Services

Provides functions to interact with articles

Constructor

ArticleServiceV2

(
  • context
)

Defined in include/service/entities/content/article_service_v2.js:30

Parameters:

  • context Object
    • [contentSettings] Object optional
    • site String
    • onlyThisSite Boolean

Methods

_emit

(
  • event
  • data
  • cb
)
protected

Inherited from BaseObjectService: include/service/base_object_service.js:690

Parameters:

  • event String
  • data Object
  • cb Function

_get

(
  • id
  • [options]
  • cb
)
protected

Inherited from BaseObjectService: include/service/base_object_service.js:391

Parameters:

  • id String
  • [options] Object optional
  • cb Function

_retrieveOnUpdateAndMerge

(
  • dto
  • options
  • cb
)
private

Inherited from BaseObjectService: include/service/base_object_service.js:562

When an ID is available in the DTO the function attempts to retrieve the existing object. If it is not available a new object is created. The merge event is then called. After the merge is complete the callback is executed with the merged object.

Parameters:

  • dto Object
  • options Object
    • [isCreate] Boolean optional
  • cb Function

add

(
  • dto
  • [options]
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:427

Attempts to persist the DTO as an add. The function executes a series of events: 1) The format event is fired 2) When an ID is provided the object is retrieved from the database otherwise a new object is created. 3) The merge event is triggered 4) The validate event is triggered. If validation errors are detected the process halts and the function calls back with an error. 5) The beforeSave event is triggered 6) The object is persisted 7) The afterSave event is triggered

Parameters:

  • dto Object
  • [options] Object optional
  • cb Function
    A callback that takes two parameters. The first is an error, if occurred. The second is the object that matches the specified query

count

(
  • [options]
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:286

Executes a count of resources against the persistence layer. The function will callback with an array of results.

Parameters:

  • [options] Object optional
    • [where] Object optional
  • cb Function
    A callback that takes two parameters. The first is an error, if occurred. The second is the number of results that match the specified query

deleteById

(
  • id
  • options
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:635

Deletes an object by ID

Parameters:

  • id String
  • options Object
  • cb Function

deleteSingle

(
  • [options]
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:652

Deletes a single item based on the specified query in the options

Parameters:

  • [options] Object optional
    See BaseObjectService#getSingle
    • [where] Object optional
  • cb Function

(
  • context
  • service
  • cb
)
static

Defined in include/service/entities/content/article_service_v2.js:127

Parameters:

  • context Object
  • service ArticleServiceV2

    An instance of the service that triggered the event that called this handler

  • cb Function

    A callback that takes a single parameter: an error if occurred

(
  • context
  • cb
)
static

Defined in include/service/entities/content/article_service_v2.js:156

Parameters:

  • context Object
    • service ArticleServiceV2

      An instance of the service that triggered the event that called this handler

  • cb Function

    A callback that takes a single parameter: an error if occurred

gatherDataForRender

(
  • contentArray
  • cb
)

Inherited from ContentObjectService: include/service/entities/content/content_object_service.js:317

Parameters:

  • contentArray Array
  • cb Function

get

(
  • id
  • options
  • cb
)

Inherited from BaseObjectService but overwritten in include/service/entities/content/content_object_service.js:154

Parameters:

  • id String
  • options Object
    • [render=false] Boolean optional
    • [readMore=false] Boolean optional
  • cb Function

getAll

(
  • [options]
  • cb
)

Inherited from BaseObjectService but overwritten in include/service/entities/content/content_object_service.js:224

Parameters:

  • [options] Object optional
    • [where] Object optional
    • [select] Object optional
    • [order] Array optional
    • [limit] Integer optional
    • [offset] Integer optional
    • [render=false] Boolean optional
    • [readMore=true] Boolean optional
  • cb Function

getAllWithCount

(
  • [options]
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:313

Executes a query for resources against the persistence layer. The function will callback with an object that contains a total count and an array of results. The function will trigger the "getAll" event. Also note that there is hard limit on the number of results the returned.

Parameters:

  • [options] Object optional
    • [select] Object optional
    • [where] Object optional
    • [order] Array optional
    • [limit] Integer optional
    • [offset] Integer optional
  • cb Function
    A callback that takes two parameters. The first is an error, if occurred. The second is an object representing the results of the query.

getBySection

(
  • sectionId
  • [options]
  • cb
)

Defined in include/service/entities/content/article_service_v2.js:89

Retrieves articles based on the section

Parameters:

  • sectionId String | Object
  • [options] Object optional
  • cb Function

getContext

(
  • [data]
)
Object

Inherited from BaseObjectService: include/service/base_object_service.js:218

Retrieves a context object to be passed to event listeners

Parameters:

  • [data] String | Object | Number | Boolean optional

Returns:

Object:

getDrafts

(
  • [options]
  • cb
)

Inherited from ContentObjectService: include/service/entities/content/content_object_service.js:123

Parameters:

  • [options] Object optional
    • [where] Object optional
    • [select] Object optional
    • [order] Array optional
    • [limit] Integer optional
    • [offset] Integer optional
    • [render=false] Boolean optional
  • cb Function

getIdWhere

(
  • dto
)
Object

Inherited from BaseObjectService: include/service/base_object_service.js:617

Creates the where clause that creates a lookup by the key that indicates uniqueness for the collection

Parameters:

  • dto Object

Returns:

Object:

getMetaInfo

(
  • content
  • cb
)

Inherited from ContentObjectService: include/service/entities/content/content_object_service.js:367

Retrieves the SEO metadata for the specified content.

Parameters:

  • content Object
    The content to retrieve information for
  • cb Function
    A callback that takes two parameters. The first is an Error, if occurred. The second is an object that contains 4 properties: title - the SEO title, description - the SEO description, keywords - an array of SEO keywords that describe the content, thumbnail - a URI path to the thumbnail image

getPublished

(
  • [options]
  • cb
)

Inherited from ContentObjectService: include/service/entities/content/content_object_service.js:94

Parameters:

  • [options] Object optional
    • [where] Object optional
    • [select] Object optional
    • [order] Array optional
    • [limit] Integer optional
    • [offset] Integer optional
    • [render] Boolean optional
  • cb Function

getRenderer

() ArticleRenderer

Inherited from ContentObjectService but overwritten in include/service/entities/content/article_service_v2.js:80

Retrieves an instance of a content renderer

Returns:

ArticleRenderer:

getRenderOptions

(
  • options
)
Object

Inherited from ContentObjectService but overwritten in include/service/entities/content/article_service_v2.js:61

Provides the options for rendering

Parameters:

  • options Object

Returns:

Object:

getSingle

(
  • [options]
  • cb
)

Inherited from BaseObjectService but overwritten in include/service/entities/content/content_object_service.js:201

Parameters:

  • [options] Object optional
    • [select] Object optional
    • [where] Object optional
    • [order] Array optional
    • [offset] Integer optional
    • [readMore=false] Boolean optional
  • cb Function

getTopicsForContent

(
  • content
)
Array

Inherited from ContentObjectService but overwritten in include/service/entities/content/article_service_v2.js:117

Extracts an array of Topic IDs from the content that the content is associated with.

Parameters:

  • content Object

Returns:

Array:

An array of strings representing the Topic IDs

getType

() String

Inherited from BaseObjectService: include/service/base_object_service.js:209

Retrieves the object type supported by the service

Returns:

String: The object type supported

render

(
  • contentArray
  • [options]
  • cb
)

Inherited from ContentObjectService: include/service/entities/content/content_object_service.js:253

Parameters:

  • contentArray Array
  • [options] Object optional
    An optional argument to provide rendering settings.
    • [readMore] Boolean optional

      Specifies if content body layout should be truncated, and read more links rendered.

  • cb Function

save

(
  • dto
  • [options]
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:477

Attempts to persist the DTO. The function executes a series of events: 1) The format event is fired 2) When an ID is provided the object is retrieved from the database otherwise a new object is created. 3) The merge event is triggered 4) The validate event is triggered. If validation errors are detected the process halts and the function calls back with an error. 5) The beforeSave event is triggered 6) The object is persisted 7) The afterSave event is triggered

Parameters:

  • dto Object
  • [options] Object optional
    • [isCreate] Boolean optional
  • cb Function
    A callback that takes two parameters. The first is an error, if occurred. The second is the object that matches the specified query

setSectionClause

(
  • where
)
static

Defined in include/service/entities/content/article_service_v2.js:321

Parameters:

  • where Object

setTopicClause

(
  • where
)
static

Defined in include/service/entities/content/article_service_v2.js:331

Parameters:

  • where Object

update

(
  • dto
  • [options]
  • cb
)

Inherited from BaseObjectService: include/service/base_object_service.js:452

Attempts to persist the DTO as an update. The function executes a series of events: 1) The format event is fired 2) When an ID is provided the object is retrieved from the database otherwise a new object is created. 3) The merge event is triggered 4) The validate event is triggered. If validation errors are detected the process halts and the function calls back with an error. 5) The beforeSave event is triggered 6) The object is persisted 7) The afterSave event is triggered

Parameters:

  • dto Object
  • [options] Object optional
  • cb Function
    A callback that takes two parameters. The first is an error, if occurred. The second is the object that matches the specified query

validate

(
  • context
  • cb
)
static

Defined in include/service/entities/content/article_service_v2.js:190

Parameters:

  • context Object
    • data Object

      The DTO that was provided for persistence

    • validationErrors Array
    • service ArticleServiceV2

      An instance of the service that triggered the event that called this handler

  • cb Function

    (Error) A callback that takes a single parameter: an error if occurred

validateHeadline

(
  • context
  • cb
)

Inherited from ContentObjectService: include/service/entities/content/content_object_service.js:492

Validates that a headline is provided and is unique

Parameters:

  • context Object
    • data Object
    • validationErrors Array
  • cb Function
    (Error)

Returns:

:

Properties

dao

DAO

Inherited from BaseObjectService: include/service/base_object_service.js:60

An instance of DAO to be used to interact with the persistence layer

TYPE

String private static

Defined in include/service/entities/content/article_service_v2.js:51

type

String

Inherited from BaseObjectService: include/service/base_object_service.js:53

Represents the name of the collection to interact with