class CommunityModelEvents extends JCCModel implements CGeolocationSearchInterface, CNotificationsInterface


Located at : UKNOWVA_ROOT/components/com_community/models/events.php

Properties

object $_pagination Configuration data
object $total Configuration data
int $membersCount member count data

Methods

__construct(array $config = array())

Constructor

from JModel
string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static array
addIncludePath(mixed $path = '', string $prefix = '')

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

from JModel
static void
addTablePath(mixed $path)

Adds to the stack of model table paths in LIFO order.

from JModel
static mixed
getInstance(string $type, string $prefix = '', array $config = array())

Returns a Model object, always creating it

from JModel
getDbo()

Method to get the database connector object

from JModel
string
getName()

Method to get the model name

from JModel
object
getState(string $property = null, mixed $default = null)

Method to get model state variables

from JModel
getTable(string $name = '', string $prefix = 'Table', array $options = array())

Method to get a table object, load it if necessary.

from JModel
void
setDbo(object $db)

Method to set the database connector object

from JModel
mixed
setState(string $property, mixed $value = null)

Method to set model state variables

from JModel
JCCModel()

No description

from JCCModel
getNotes()

No description

from JCCModel
getSample()

No description

from JCCModel
store()

No description

from JCCModel
CommunityModelEvents()

Constructor

integer
getPagination()

Method to get a pagination object for the events

array
getTotalGroupEvents(int $groupId)

Method to retrieve total events for a specific group

array
getGroupEvents($groupId, $limit)

Method to retrieve events for a specific group

getEvents($categoryId = null, $userId = null, $sorting = null, $search = null, $hideOldEvent = true, $showOnlyOldEvent = false, $pending = null, $advance = null, $type = CEventHelper::ALL_TYPES, $contentid, $limit = null)

Returns an object of events which the user has registered.

type
getEventIds($userId)

Return an array of ids the user responded to

getEventsCount($userId)

Return the number of groups count for specific user

getEventsCreationCount($userId)

Return the number of groups cretion count for specific user

int
getMembersCount(string $id)

Returns the count of the members of a specific group

getCategories($type = CEventHelper::PROFILE_TYPE, $catId = COMMUNITY_ALL_CATEGORIES)

Loads the categories

getCategoriesCount()

Returns the category's group count

getCategoryName(string $categoryId)

Returns the category name of the specific category

isEventExist($title, $location, $startdate, $enddate, $id)

Check if the given group name exist.

deleteGroupWall($gid)

Delete group's wall

searchWithin($address, $distance)

caller should verify that the address is valid

getPending($userId)

Get the pending invitations

isInvitedMe($invitationId, $userId, $eventId)

Check if I was invited and if yes return true If Event Id is provided, will return the invitation informations

getFriendsCount($userid, $eventid)

Return the count of the user's friend of a specific event

getInviteListByName($namePrefix, $userid, $cid, $limitstart, $limit = 8)

No description

getTitle($eventid)

Return the title of the event id

countPending($id)

Count total pending event invitations.

getMonthlyEvents($month, $year)

No description

getThumbAvatar($id, $thumb) deprecated

No description

getEventsSearchTotal()

Return events search total

getTotalNotifications($userId)

Returns a list of pending event invites

Details

in JModel at line 202
JObject __construct(array $config = array())

Constructor

Parameters

array $config An array of configuration options (name, state, dbo, tablepath, ignorerequest).

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

in JModel at line 84
static array addIncludePath(mixed $path = '', string $prefix = '')

Add a directory where JModel should search for models. You may either pass a string or an array of directories.

Parameters

mixed $path A path or array[sting] of paths to search.
string $prefix A prefix for models.

Return Value

array An array with directory elements. If prefix is equal to '', all directories are returned.

in JModel at line 123
static void addTablePath(mixed $path)

Adds to the stack of model table paths in LIFO order.

Parameters

mixed $path The directory as a string or directories as an array to add.

Return Value

void

in JModel at line 161
static mixed getInstance(string $type, string $prefix = '', array $config = array())

Returns a Model object, always creating it

Parameters

string $type The model type to instantiate
string $prefix Prefix for the model class name. Optional.
array $config Configuration array for model. Optional.

Return Value

mixed A model object or false on failure

in JModel at line 327
JDatabase getDbo()

Method to get the database connector object

Return Value

JDatabase JDatabase connector object

in JModel at line 341
string getName()

Method to get the model name

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

Return Value

string The name of the model

in JModel at line 365
object getState(string $property = null, mixed $default = null)

Method to get model state variables

Parameters

string $property Optional parameter name
mixed $default Optional default value

Return Value

object The property where specified, the state object where omitted

in JModel at line 388
JTable getTable(string $name = '', string $prefix = 'Table', array $options = array())

Method to get a table object, load it if necessary.

Parameters

string $name The table name. Optional.
string $prefix The class prefix. Optional.
array $options Configuration array for model. Optional.

Return Value

JTable A JTable object

in JModel at line 427
void setDbo(object $db)

Method to set the database connector object

Parameters

object $db &$db A JDatabase based object

Return Value

void

in JModel at line 441
mixed setState(string $property, mixed $value = null)

Method to set model state variables

Parameters

string $property The name of the property.
mixed $value The value of the property to set or null.

Return Value

mixed The previous value of the property or null if not set.

in JCCModel at line 13
JCCModel()

in JCCModel at line 18
getNotes()

in JCCModel at line 22
getSample()

in JCCModel at line 28
store()

at line 47
CommunityModelEvents()

Constructor

at line 71
integer getPagination()

Method to get a pagination object for the events

Return Value

integer

at line 82
array getTotalGroupEvents(int $groupId)

Method to retrieve total events for a specific group

Parameters

int $groupId The unique group id.

Return Value

array $result An array of result.

at line 101
array getGroupEvents($groupId, $limit)

Method to retrieve events for a specific group

Parameters

$groupId
$limit

Return Value

array $result An array of result.

at line 171
getEvents($categoryId = null, $userId = null, $sorting = null, $search = null, $hideOldEvent = true, $showOnlyOldEvent = false, $pending = null, $advance = null, $type = CEventHelper::ALL_TYPES, $contentid, $limit = null)

Returns an object of events which the user has registered.

Parameters

$categoryId
$userId
$sorting
$search
$hideOldEvent
$showOnlyOldEvent
$pending
$advance
$type
$contentid
$limit

at line 390
type getEventIds($userId)

Return an array of ids the user responded to

Parameters

$userId

Return Value

type

at line 421
getEventsCount($userId)

Return the number of groups count for specific user

Parameters

$userId

at line 446
getEventsCreationCount($userId)

Return the number of groups cretion count for specific user

Parameters

$userId

at line 471
int getMembersCount(string $id)

Returns the count of the members of a specific group

Parameters

string $id Group's id.

Return Value

int Count of members

at line 498
getCategories($type = CEventHelper::PROFILE_TYPE, $catId = COMMUNITY_ALL_CATEGORIES)

Loads the categories

Parameters

$type
$catId

at line 557
getCategoriesCount()

Returns the category's group count

at line 588
getCategoryName(string $categoryId)

Returns the category name of the specific category

Parameters

string $categoryId Category Id

at line 611
isEventExist($title, $location, $startdate, $enddate, $id)

Check if the given group name exist.

if id is specified, only search for those NOT within $id

Parameters

$title
$location
$startdate
$enddate
$id

at line 641
deleteGroupWall($gid)

Delete group's wall

param string id The id of the group.

Parameters

$gid

at line 663
searchWithin($address, $distance)

caller should verify that the address is valid

Parameters

$address
$distance

at line 720
getPending($userId)

Get the pending invitations

Parameters

$userId

at line 757
isInvitedMe($invitationId, $userId, $eventId)

Check if I was invited and if yes return true If Event Id is provided, will return the invitation informations

Parameters

$invitationId
$userId
$eventId

at line 799
getFriendsCount($userid, $eventid)

Return the count of the user's friend of a specific event

Parameters

$userid
$eventid

at line 820
getInviteListByName($namePrefix, $userid, $cid, $limitstart, $limit = 8)

Parameters

$namePrefix
$userid
$cid
$limitstart
$limit

at line 878
getTitle($eventid)

Return the title of the event id

Parameters

$eventid

at line 896
countPending($id)

Count total pending event invitations.

Parameters

$id

at line 923
getMonthlyEvents($month, $year)

Parameters

$month
$year

at line 943
getThumbAvatar($id, $thumb) deprecated

deprecated Since 2.0

Parameters

$id
$thumb

at line 955
getEventsSearchTotal()

Return events search total

at line 967
getTotalNotifications($userId)

Returns a list of pending event invites

Parameters

$userId