Subscriber

contentbox.models.subscriptions

Class Subscriber

lucee.Component
    contentbox.models.BaseEntityMethods
      contentbox.models.BaseEntity
        contentbox.models.subscriptions.Subscriber

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

Class Attributes:

entityname : cbSubscriber

cacheuse : read-write

table : cb_subscribers

synchronized : false

cachename : cbSubscriber

accessors : false

persistent : true

Property Summary
type	property	default	serializable	required
`date`	createdDate access = public returntype = any notnull = true ormtype = timestamp update = false index = idx_createDate		`true`	`false`
`any`	isDeleted access = public dbdefault = 0 returntype = any notnull = true ormtype = boolean index = idx_deleted sqltype = bit	`false`	`true`	`false`
`date`	modifiedDate access = public returntype = any notnull = true ormtype = timestamp index = idx_modifiedDate		`true`	`false`
`any`	subscriberEmail access = public returntype = any notnull = true index = idx_subscriberEmail length = 255		`true`	`false`
`any`	subscriberID access = public fieldtype = id returntype = any params = { allocationSize = 1, sequence = 'subscriberID_seq' } generator = native setter = no		`true`	`false`
`any`	subscriberToken access = public returntype = any notnull = true		`true`	`false`
`array`	subscriptions access = public inverse = true fieldtype = one-to-many returntype = any cascade = all-delete-orphan orderby = createdDate batchsize = 25 singularname = subscription fkcolumn = FK_subscriberID cfc = contentbox.models.subscriptions.BaseSubscription lazy = extra		`true`	`false`

Method Summary
`any`	addSubscription(any subscription)
`any`	getMemento([any excludes=''], [boolean showSubscriptions='true']) Get memento representation.
`string`	getSubscriberEmail()
`string`	getSubscriberID()
`string`	getSubscriberToken()
`string`	getSubscriptions()
`struct`	getSubscriptionsByContentType() Returns a slim representation of subscriptions by type.
`boolean`	hasSubscription([any subscription])
`void`	preInsert()
`boolean`	removeSubscription(any subscription)
`any`	setSubscriberEmail(any subscriberEmail)
`any`	setSubscriberToken(any subscriberToken)
`any`	setSubscriptions(array subscriptions)

Methods inherited from class `contentbox.models.BaseEntity`
getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate

Methods inherited from class `contentbox.models.BaseEntityMethods`
getBaseMemento, getDisplayCreatedDate, getDisplayModifiedDate, init, isLoaded, preUpdate

Methods inherited from class `lucee.Component`
None

Property Detail

createdDate

property date createdDate

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - timestamp; update - false; index - idx_createDate; serializable - true

isDeleted

property any isDeleted = [false]

Attributes:: access - public; required - false; dbdefault - 0; returntype - any; notnull - true; ormtype - boolean; index - idx_deleted; serializable - true; sqltype - bit

modifiedDate

property date modifiedDate

Attributes:: access - public; required - false; returntype - any; notnull - true; ormtype - timestamp; index - idx_modifiedDate; serializable - true

subscriberEmail

property any subscriberEmail

Attributes:: access - public; required - false; returntype - any; notnull - true; index - idx_subscriberEmail; length - 255; serializable - true

subscriberID

property any subscriberID

Attributes:: access - public; required - false; fieldtype - id; returntype - any; params - { allocationSize = 1, sequence = 'subscriberID_seq' }; generator - native; serializable - true; setter - no

subscriberToken

property any subscriberToken

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

subscriptions

property array subscriptions

Attributes:: access - public; required - false; inverse - true; fieldtype - one-to-many; returntype - any; cascade - all-delete-orphan; orderby - createdDate; batchsize - 25; singularname - subscription; fkcolumn - FK_subscriberID; serializable - true; cfc - contentbox.models.subscriptions.BaseSubscription; lazy - extra

Method Detail

addSubscription

public any addSubscription(any subscription)

Parameters:: subscription

getMemento

public any getMemento([any excludes=''], [boolean showSubscriptions='true'])

Get memento representation

Parameters:: excludes - Property excludes; showSubscriptions - Show the subscriptions

getSubscriberEmail

public string getSubscriberEmail()

getSubscriberID

public string getSubscriberID()

getSubscriberToken

public string getSubscriberToken()

getSubscriptions

public string getSubscriptions()

getSubscriptionsByContentType

public struct getSubscriptionsByContentType()

Returns a slim representation of subscriptions by type

hasSubscription

public boolean hasSubscription([any subscription])

Parameters:: subscription

preInsert

public void preInsert()

Overrides:: preInsert in class BaseEntityMethods

removeSubscription

public boolean removeSubscription(any subscription)

Parameters:: subscription

setSubscriberEmail

public any setSubscriberEmail(any subscriberEmail)

Parameters:: subscriberEmail

setSubscriberToken

public any setSubscriberToken(any subscriberToken)

Parameters:: subscriberToken

setSubscriptions

public any setSubscriptions(array subscriptions)

Parameters:: subscriptions