contentbox.models.subscriptions

Class Subscriber

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by 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
    • column = createdDate
    • notnull = true
    • ormtype = timestamp
    • update = false
    • persistent = true
    true false
    any isDeleted


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


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


    • access = public
    • returntype = any
    • column = subscriberEmail
    • notnull = true
    • index = idx_subscriberEmail
    • length = 255
    true false
    any subscriberID


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


    • access = public
    • returntype = any
    • column = subscriberToken
    • notnull = true
    • ormtype = string
    • length = 255
    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 = true
    true false
    Constructor Summary
    init()
    Method Summary
    any addSubscription(any subscription)
    struct getInfoSnapshot()
         Utility method to get a snapshot of this object.
    string getSubscriberEmail()
    string getSubscriberID()
    string getSubscriberToken()
    string getSubscriptions()
    struct getSubscriptionsByContentType()
         Returns a slim representation of subscriptions by type.
    array getSubscriptionsSnapshot()
         Build a snapshot of subscriptions this subscriber has.
    boolean hasSubscription([any subscription])
    void preInsert()
         Before insert create the user subscription token.
    boolean removeSubscription(any subscription)
    any setSubscriberEmail(any subscriberEmail)
    any setSubscriberID(any subscriberID)
    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
    appendToMemento, appendToMementoProfile, arrayWrap, getDisplayCreatedDate, getDisplayModifiedDate, getEntityName, getId, includeMixin, isLoaded, preUpdate
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    createdDate

    property date createdDate

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

    isDeleted

    property any isDeleted = [false]

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

    modifiedDate

    property date modifiedDate

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

    subscriberEmail

    property any subscriberEmail

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

    subscriberID

    property any subscriberID

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

    subscriberToken

    property any subscriberToken

    Attributes:
    access - public
    required - false
    returntype - any
    column - subscriberToken
    notnull - true
    ormtype - string
    length - 255
    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 - true

    Method Detail

    addSubscription

    public any addSubscription(any subscription)

    Parameters:
    subscription

    getInfoSnapshot

    public struct getInfoSnapshot()

    Utility method to get a snapshot of this object


    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


    getSubscriptionsSnapshot

    public array getSubscriptionsSnapshot()

    Build a snapshot of subscriptions this subscriber has


    hasSubscription

    public boolean hasSubscription([any subscription])

    Parameters:
    subscription

    preInsert

    public void preInsert()

    Before insert create the user subscription token

    Overrides:
    preInsert in class BaseEntityMethods

    removeSubscription

    public boolean removeSubscription(any subscription)

    Parameters:
    subscription

    setSubscriberEmail

    public any setSubscriberEmail(any subscriberEmail)

    Parameters:
    subscriberEmail

    setSubscriberID

    public any setSubscriberID(any subscriberID)

    Parameters:
    subscriberID

    setSubscriberToken

    public any setSubscriberToken(any subscriberToken)

    Parameters:
    subscriberToken

    setSubscriptions

    public any setSubscriptions(array subscriptions)

    Parameters:
    subscriptions