Documentation

EasyBlogModelSubscription extends EasyBlogAdminModel
in package

Table of Contents

Properties

$searchables  : mixed
$_data  : mixed
$_pagination  : mixed
$_total  : mixed

Methods

__construct()  : mixed
addBlogSubscription()  : mixed
Add / Update an existing blog subscription
addSiteSubscription()  : mixed
export()  : mixed
Allow callers to export subscribers
getMembersAndSubscribers()  : mixed
getPagination()  : int
Method to get a pagination object for the categories
getSearchableItems()  : mixed
Get searchable columns
getSiteSubscribers()  : mixed
getSubscribers()  : mixed
Retrieves a list of subscribers for a particular coposite item
getSubscriptionId()  : mixed
Retrieves the subscription id
getTotalSiteSubscribers()  : mixed
Retrieve total number of subscribers on the site
getUserStateFromRequest()  : mixed
Gets the value of a user state variable.
isBlogSubscribed()  : mixed
Determines if the email is subscribed to the blog post
isSiteSubscribedEmail()  : mixed
isSiteSubscribedUser()  : mixed
massAssignSubscriber()  : mixed
notify()  : mixed
Notify subscriber
subscribe()  : mixed
Generic API to subscribe a user
subscriptionExist()  : mixed
Retrieve current email data whether it already subscribed
updateSiteSubscriptionEmail()  : mixed
bindTable()  : mixed
implodeValues()  : mixed
populateState()  : void
Stock method to auto-populate the model state.

Properties

$searchables

public mixed $searchables = array()

Methods

addBlogSubscription()

Add / Update an existing blog subscription

public addBlogSubscription(mixed $blogId, mixed $email[, mixed $userId = '0' ][, mixed $fullname = '' ]) : mixed
Parameters
$blogId : mixed
$email : mixed
$userId : mixed = '0'
$fullname : mixed = ''
Tags
since
4.0
access

public

addSiteSubscription()

public addSiteSubscription(mixed $email[, mixed $userId = '0' ][, mixed $fullname = '' ]) : mixed
Parameters
$email : mixed
$userId : mixed = '0'
$fullname : mixed = ''

export()

Allow callers to export subscribers

public export([mixed $type = 'site' ]) : mixed
Parameters
$type : mixed = 'site'
Tags
since
5.1
access

public

getMembersAndSubscribers()

public getMembersAndSubscribers() : mixed

getPagination()

Method to get a pagination object for the categories

public getPagination() : int
Tags
access

public

Return values
int

getSearchableItems()

Get searchable columns

public getSearchableItems(mixed $query) : mixed
Parameters
$query : mixed
Tags
since
5.2.0
access

public

getSiteSubscribers()

public getSiteSubscribers() : mixed

getSubscribers()

Retrieves a list of subscribers for a particular coposite item

public getSubscribers(mixed $type, mixed $uid) : mixed
Parameters
$type : mixed
$uid : mixed
Tags
since
5.0
access

public

getSubscriptionId()

Retrieves the subscription id

public getSubscriptionId(mixed $email, mixed $uid[, mixed $type = EBLOG_SUBSCRIPTION_SITE ]) : mixed
Parameters
$email : mixed
$uid : mixed
$type : mixed = EBLOG_SUBSCRIPTION_SITE
Tags
since
1.4
access

public

getTotalSiteSubscribers()

Retrieve total number of subscribers on the site

public getTotalSiteSubscribers() : mixed
Tags
since
4.0
access

public

getUserStateFromRequest()

Gets the value of a user state variable.

public getUserStateFromRequest(mixed $key, mixed $request[, mixed $default = null ][, mixed $type = 'none' ]) : mixed
Parameters
$key : mixed
$request : mixed
$default : mixed = null
$type : mixed = 'none'

isBlogSubscribed()

Determines if the email is subscribed to the blog post

public isBlogSubscribed(mixed $id, mixed $email[, mixed $userId = '0' ]) : mixed
Parameters
$id : mixed
$email : mixed
$userId : mixed = '0'
Tags
since
4.0
access

public

isSiteSubscribedEmail()

public isSiteSubscribedEmail(mixed $email) : mixed
Parameters
$email : mixed

isSiteSubscribedUser()

public isSiteSubscribedUser(mixed $userId, mixed $email) : mixed
Parameters
$userId : mixed
$email : mixed

massAssignSubscriber()

public massAssignSubscriber(mixed $file) : mixed
Parameters
$file : mixed

subscribe()

Generic API to subscribe a user

public subscribe(mixed $type, mixed $id, mixed $email, mixed $name[, mixed $userId = '0' ]) : mixed
Parameters
$type : mixed
$id : mixed
$email : mixed
$name : mixed
$userId : mixed = '0'
Tags
since
4.0
access

public

subscriptionExist()

Retrieve current email data whether it already subscribed

public subscriptionExist(mixed $email, mixed $uid[, mixed $type = EBLOG_SUBSCRIPTION_SITE ]) : mixed
Parameters
$email : mixed
$uid : mixed
$type : mixed = EBLOG_SUBSCRIPTION_SITE
Tags
since
5.1
access

public

updateSiteSubscriptionEmail()

public updateSiteSubscriptionEmail(mixed $sid, mixed $userid, mixed $email) : mixed
Parameters
$sid : mixed
$userid : mixed
$email : mixed

bindTable()

protected bindTable(mixed $tableName, mixed $result) : mixed
Parameters
$tableName : mixed
$result : mixed

implodeValues()

protected implodeValues(mixed $data) : mixed
Parameters
$data : mixed

populateState()

Stock method to auto-populate the model state.

protected populateState() : void
Tags
since
12.2

        
On this page

Search results