CommunityEventsController

class CommunityEventsController extends CommunityBaseController


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

Events Controller

Properties

$_modelInstances from CommunityBaseController
$_libraryInstances from CommunityBaseController
$_viewInstances from CommunityBaseController
$_name from CommunityBaseController
$my from CommunityBaseController

Methods

JObject
__construct()

Constructor.

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 void
addModelPath(mixed $path, string $prefix = '')

Adds to the stack of model paths in LIFO order.

from JController
static mixed
getInstance(string $prefix, array $config = array())

Method to get a singleton controller instance.

from JController
JController
addViewPath(mixed $path)

Add one or more view paths to the controller's stack, in LIFO order.

from JController
boolean
authorize(string $task) deprecated

Authorisation check

from JController
boolean
authorise(string $task)

Authorisation check

from JController
JController
display()

Displays the default events view

mixed
execute(string $task = '')

Execute a request

from CommunityBaseController
object
getModel(string $name = '', string $prefix = '', array $config = array())

Return the model object, responsible for all db manipulation. Singleton

from CommunityBaseController
string
getName()

Method to get the controller name

from CommunityBaseController
string
getTask()

Get the last task that is being performed or was most recently performed.

from JController
array
getTasks()

Gets the available tasks in the controller.

from JController
object
getView($viewName = 'frontpage', string $prefix = '', $viewType = '')

Return the view object, which will output the final html. The view object is a singleton

from CommunityBaseController
boolean
redirect()

Redirects the browser or returns false if no redirect is set.

from JController
JController
registerDefaultTask(string $method)

Register the default task to perform if a mapping is not found.

from JController
JController
registerTask(string $task, string $method)

Register (map) a task to a method in the class.

from JController
JController
unregisterTask(string $task)

Unregister (unmap) a task in the class.

from JController
void
setAccessControl(string $section, string $value = null) deprecated

Sets the access control levels.

from JController
string
setMessage(string $text, string $type = 'message')

Sets the internal message that is passed with a redirect

from JController
JController
setRedirect(string $url, string $msg = null, string $type = null)

Set a URL for browser redirection.

from JController
CommunityBaseController($config = array())

No description

from CommunityBaseController
_notify($cmd, $from, $to, $subject, $body, $template = '', $params = '')

Deprecated since 1.8.x

from CommunityBaseController
ajaxBlockUnregister()

A guest trying to use registered-only part of the system via ajax. Display a link to register

from CommunityBaseController
blockUserAccess()

Block user access to the controller method.

from CommunityBaseController
blockUnregister($uri = null)

No description

from CommunityBaseController
loadHelper($name)

No description

from CommunityBaseController
getLibrary($name = '', $prefix = '', $config = array())

No description

from CommunityBaseController
executeMobile($task = '')

No description

from CommunityBaseController
executeAjax($method, $ajaxArg)

Execute ajax request

from CommunityBaseController
ajaxBlock()

restrict blocked user to access owner details

from CommunityBaseController
ajaxRestrictBlockAdmin()

restrict user to block community admin

from CommunityBaseController
cacheClean($cacheId)

No description

from CommunityBaseController
inviteUsers($cid, $users, $emails, $message)

Responsible to return necessary contents to the Invitation library so that it can add the mails into the queue

editEventsWall($wallId)

No description

app()

Full application view

ajaxDisplayNearbyEvents($location)

No description

ajaxWarnEventDeletion($eventId)

Ajax function to prompt warning during group deletion

ajaxManageAdmin($memberId, $eventId, $task)

Ajax function to add new admin to the event

ajaxRequestInvite($eventId, $redirectUrl)

Ajax function to display the join event

ajaxIgnoreEvent($eventId)

A user decided to ignore this event. Once he 'ignore' an event. He cannot be invited or contacted by event admin

ajaxApproveInvite($memberId, $eventId)

Ajax function to approve a specific member when event admin or site admin tries to approve an invitation.

ajaxDeleteEvent($eventId, $step = 1)

Ajax function to delete a event

ajaxUnblockGuest($userid, $eventid)

Unblock this user for this event

ajaxBlockGuest($userid, $eventid)

Block this user from this event

ajaxRemoveGuest($userid, $eventid)

AJAX remove user from event

ajaxConfirmRemoveGuest($userid, $eventid)

Ajax remove guest confirmation prompt

ajaxConfirmBlockGuest($userid, $eventid)

AJAX confirm block guest

ajaxConfirmUnblockGuest($userid, $eventid)

AJAX confirm unblock guest

ajaxJoinInvitation($eventId)

Ajax function to join an event invitation

ajaxRejectInvitation($eventId)

Ajax function to reject an event invitation

reportEvent($link, $message, $eventId)

Method is called from the reporting library. Function calls should be registered here.

unpublishEvent($eventId)

No description

export()

No description

ignore()

A user decided to ignore an event Banned used cannot be ignored

void
requestInvite()

Method is used to receive POST requests from specific user that wants to join a event

myevents()

No description

myinvites()

No description

pastevents()

No description

saveImport()

No description

import()

Method to display import event form

create()

No description

ajaxCreate($postData, $objResponse)

No description

none
edit()

Controller method responsible to display the edit task.

created()

A new event has been created

announce()

Send an email announcement to members

false
save($event)

Method to save the group

printpopup()

No description

none
sendmail()

Controller method responsible to display the sendmail task

viewevent()

No description

viewguest()

No description

invitefriends()

Show Invite

updatestatus()

Responsible to update a specific user's rsvp

search()

No description

uploadAvatar()

No description

triggerEvents($eventName, $args, $target = null)

No description

ajaxSaveWall(message $message, uniqueId $uniqueId)

Ajax function to save a new wall entry

ajaxRemoveWall($wallId)

No description

ajaxGetCalendar($month, $year)

No description

ajaxGetEvents($day, $month, $year)

No description

ajaxUpdateStatus($eventId, $status)

No description

ajaxShowMap()

No description

ajaxAddFeatured($eventId)

No description

ajaxRemoveFeatured($eventId)

No description

Details

at line 86
JObject __construct()

Constructor.

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 JController at line 156
static void addModelPath(mixed $path, string $prefix = '')

Adds to the stack of model paths in LIFO order.

Parameters

mixed $path The directory (string), or list of directories (array) to add.
string $prefix A prefix for models

Return Value

void

in JController at line 212
static mixed getInstance(string $prefix, array $config = array())

Method to get a singleton controller instance.

Parameters

string $prefix The prefix for the controller.
array $config An array of optional constructor options.

Return Value

mixed JController derivative class or JException on error.

in JController at line 427
JController addViewPath(mixed $path)

Add one or more view paths to the controller's stack, in LIFO order.

Parameters

mixed $path The directory (string) or list of directories (array) to add.

Return Value

JController This object to support chaining.

in JController at line 445
boolean authorize(string $task) deprecated

deprecated 12.1 Use JAuthorise

Authorisation check

Parameters

string $task The ACO Section Value to check access on

Return Value

boolean True if authorised

in JController at line 461
boolean authorise(string $task)

Authorisation check

Parameters

string $task The ACO Section Value to check access on.

Return Value

boolean True if authorised

at line 964
JController display()

Displays the default events view

Return Value

JController A JController object to support chaining.

in CommunityBaseController at line 206
mixed execute(string $task = '')

Execute a request

Parameters

string $task The task to perform. If no matching task is found, the '__default' task is executed, if defined.

Return Value

mixed The value returned by the called method, false in error case.

in CommunityBaseController at line 176
object getModel(string $name = '', string $prefix = '', array $config = array())

Return the model object, responsible for all db manipulation. Singleton

Parameters

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

Return Value

object The model.

in CommunityBaseController at line 29
string getName()

Method to get the controller name

The dispatcher name is set 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 dispatcher

in JController at line 761
string getTask()

Get the last task that is being performed or was most recently performed.

Return Value

string The task that is being performed or was most recently performed.

in JController at line 772
array getTasks()

Gets the available tasks in the controller.

Return Value

array Array[i] of task names.

in CommunityBaseController at line 139
object getView($viewName = 'frontpage', string $prefix = '', $viewType = '')

Return the view object, which will output the final html. The view object is a singleton

Parameters

$viewName
string $prefix The class prefix. Optional.
$viewType

Return Value

object Reference to the view or an error.

in JController at line 857
boolean redirect()

Redirects the browser or returns false if no redirect is set.

Return Value

boolean False if no redirect exists.

in JController at line 875
JController registerDefaultTask(string $method)

Register the default task to perform if a mapping is not found.

Parameters

string $method The name of the method in the derived class to perform if a named task is not found.

Return Value

JController A JController object to support chaining.

in JController at line 891
JController registerTask(string $task, string $method)

Register (map) a task to a method in the class.

Parameters

string $task The task.
string $method The name of the method in the derived class to perform for this task.

Return Value

JController A JController object to support chaining.

in JController at line 908
JController unregisterTask(string $task)

Unregister (unmap) a task in the class.

Parameters

string $task The task.

Return Value

JController This object to support chaining.

in JController at line 958
void setAccessControl(string $section, string $value = null) deprecated

deprecated 12.1 Use JAccess

Sets the access control levels.

Parameters

string $section The ACO section (eg, the component).
string $value The ACO section value (if using a constant value).

Return Value

void

See also

Jaccess

in JController at line 973
string setMessage(string $text, string $type = 'message')

Sets the internal message that is passed with a redirect

Parameters

string $text Message to display on redirect.
string $type Message type (since 11.1). Optional, defaults to 'message'.

Return Value

string Previous message

in JController at line 1013
JController setRedirect(string $url, string $msg = null, string $type = null)

Set a URL for browser redirection.

Parameters

string $url URL to redirect to.
string $msg Message to display on redirect. Optional, defaults to value set internally by controller, if any.
string $type Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.

Return Value

JController This object to support chaining.

in CommunityBaseController at line 33
CommunityBaseController($config = array())

Parameters

$config

in CommunityBaseController at line 44
_notify($cmd, $from, $to, $subject, $body, $template = '', $params = '')

Deprecated since 1.8.x

Parameters

$cmd
$from
$to
$subject
$body
$template
$params

in CommunityBaseController at line 54
ajaxBlockUnregister()

A guest trying to use registered-only part of the system via ajax. Display a link to register

in CommunityBaseController at line 78
blockUserAccess()

Block user access to the controller method.

in CommunityBaseController at line 95
blockUnregister($uri = null)

Parameters

$uri

in CommunityBaseController at line 145
loadHelper($name)

Parameters

$name

in CommunityBaseController at line 149
getLibrary($name = '', $prefix = '', $config = array())

Parameters

$name
$prefix
$config

in CommunityBaseController at line 365
executeMobile($task = '')

Parameters

$task

in CommunityBaseController at line 421
executeAjax($method, $ajaxArg)

Execute ajax request

Parameters

$method
$ajaxArg

in CommunityBaseController at line 441
ajaxBlock()

restrict blocked user to access owner details

in CommunityBaseController at line 460
ajaxRestrictBlockAdmin()

restrict user to block community admin

in CommunityBaseController at line 476
cacheClean($cacheId)

Parameters

$cacheId

at line 22
inviteUsers($cid, $users, $emails, $message)

Responsible to return necessary contents to the Invitation library so that it can add the mails into the queue

Parameters

$cid
$users
$emails
$message

at line 91
editEventsWall($wallId)

Parameters

$wallId

at line 119
app()

Full application view

at line 131
ajaxDisplayNearbyEvents($location)

Parameters

$location

at line 177
ajaxWarnEventDeletion($eventId)

Ajax function to prompt warning during group deletion

Parameters

$eventId

at line 202
ajaxManageAdmin($memberId, $eventId, $task)

Ajax function to add new admin to the event

Parameters

$memberId
$eventId
$task

at line 257
ajaxRequestInvite($eventId, $redirectUrl)

Ajax function to display the join event

Parameters

$eventId
$redirectUrl

at line 304
ajaxIgnoreEvent($eventId)

A user decided to ignore this event. Once he 'ignore' an event. He cannot be invited or contacted by event admin

Parameters

$eventId

at line 345
ajaxApproveInvite($memberId, $eventId)

Ajax function to approve a specific member when event admin or site admin tries to approve an invitation.

Parameters

$memberId
$eventId

at line 409
ajaxDeleteEvent($eventId, $step = 1)

Ajax function to delete a event

Parameters

$eventId
$step

at line 565
ajaxUnblockGuest($userid, $eventid)

Unblock this user for this event

Parameters

$userid
$eventid

at line 625
ajaxBlockGuest($userid, $eventid)

Block this user from this event

Parameters

$userid
$eventid

at line 679
ajaxRemoveGuest($userid, $eventid)

AJAX remove user from event

Parameters

$userid
$eventid

at line 723
ajaxConfirmRemoveGuest($userid, $eventid)

Ajax remove guest confirmation prompt

Parameters

$userid
$eventid

at line 767
ajaxConfirmBlockGuest($userid, $eventid)

AJAX confirm block guest

Parameters

$userid
$eventid

at line 790
ajaxConfirmUnblockGuest($userid, $eventid)

AJAX confirm unblock guest

Parameters

$userid
$eventid

at line 812
ajaxJoinInvitation($eventId)

Ajax function to join an event invitation

Parameters

$eventId

at line 883
ajaxRejectInvitation($eventId)

Ajax function to reject an event invitation

Parameters

$eventId

at line 931
reportEvent($link, $message, $eventId)

Method is called from the reporting library. Function calls should be registered here.

return String Message that will be displayed to user upon submission.

Parameters

$link
$message
$eventId

at line 949
unpublishEvent($eventId)

Parameters

$eventId

at line 985
export()

at line 1014
ignore()

A user decided to ignore an event Banned used cannot be ignored

at line 1059
void requestInvite()

Method is used to receive POST requests from specific user that wants to join a event

Return Value

void

at line 1139
myevents()

at line 1157
myinvites()

at line 1170
pastevents()

at line 1180
saveImport()

at line 1291
import()

Method to display import event form

at line 1350
create()

at line 1447
ajaxCreate($postData, $objResponse)

Parameters

$postData
$objResponse

at line 1665
none edit()

Controller method responsible to display the edit task.

Return Value

none

at line 1715
created()

A new event has been created

at line 1728
announce()

Send an email announcement to members

at line 1754
false save($event)

Method to save the group

Parameters

$event

Return Value

false if create fail, return the group id if create is successful

at line 2002
printpopup()

at line 2031
none sendmail()

Controller method responsible to display the sendmail task

Return Value

none

at line 2110
viewevent()

at line 2121
viewguest()

at line 2175
invitefriends()

Show Invite

at line 2256
updatestatus()

Responsible to update a specific user's rsvp

at line 2403
uploadAvatar()

at line 2548
triggerEvents($eventName, $args, $target = null)

Parameters

$eventName
$args
$target

at line 2573
ajaxSaveWall(message $message, uniqueId $uniqueId)

Ajax function to save a new wall entry

Parameters

message $message A message that is submitted by the user
uniqueId $uniqueId The unique id for this group

at line 2676
ajaxRemoveWall($wallId)

Parameters

$wallId

at line 2732
ajaxGetCalendar($month, $year)

Parameters

$month
$year

at line 2745
ajaxGetEvents($day, $month, $year)

Parameters

$day
$month
$year

at line 2784
ajaxUpdateStatus($eventId, $status)

Parameters

$eventId
$status

at line 2894
ajaxShowMap()

at line 2902
ajaxAddFeatured($eventId)

Parameters

$eventId

at line 2948
ajaxRemoveFeatured($eventId)

Parameters

$eventId