class CommunityFriendsController extends CommunityBaseController


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

Properties

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

Methods

__construct(array $config = array())

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.

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

Method to get a singleton controller instance.

addViewPath(mixed $path)

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

boolean
authorize(string $task) deprecated

Authorisation check

boolean
authorise(string $task)

Authorisation check

display()

Typical view method for MVC based architecture

mixed
execute(string $task = '')

Execute a request

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

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

string
getName()

Method to get the controller name

string
getTask()

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

array
getTasks()

Gets the available tasks in the controller.

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

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

boolean
redirect()

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

registerDefaultTask(string $method)

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

registerTask(string $task, string $method)

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

unregisterTask(string $task)

Unregister (unmap) a task in the class.

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

Sets the access control levels.

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

Sets the internal message that is passed with a redirect

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

Set a URL for browser redirection.

CommunityBaseController($config = array())

No description

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

Deprecated since 1.8.x

ajaxBlockUnregister()

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

blockUserAccess()

Block user access to the controller method.

blockUnregister($uri = null)

No description

loadHelper($name)

No description

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

No description

executeMobile($task = '')

No description

executeAjax($method, $ajaxArg)

Execute ajax request

ajaxBlock()

restrict blocked user to access owner details

ajaxRestrictBlockAdmin()

restrict user to block community admin

cacheClean($cacheId)

No description

ajaxIphoneFriends()

No description

edit()

No description

friends()

View all friends. Could be current user, if $_GET['id'] is not defined otherise, show your own friends

friendsearch()

Search Within Friends

invite()

Show the user invite window

online()

No description

news()

No description

sent()

List down all request that you've sent but not approved by the other side yet

add()

Add new friend

remove()

No description

deleteSent()

Method to cancel a friend request

ajaxRejectRequest($requestId)

Ajax function to reject a friend request

ajaxApproveRequest($requestId)

Ajax function to approve a friend request

ajaxSaveFriend($postVars)

No description

ajaxInvite()

Show internal invite Internal invite is more like an internal messaging system

ajaxFrindImport()

Show import friends from other account

ajaxCancelRequest($friendsId)

Displays a dialog to the user if he / she really wants to cancel the friend request

ajaxConnect($friendId)

Show the connection request box

ajaxConfirmFriendRemoval($friendId)

No description

ajaxBlockFriend($id)

No description

ajaxRemoveFriend($id)

No description

pending()

List down all connection request waiting for user to approve

browse()

Browse the active user's friends

search()

No description

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

No description

blockUser()

Block user

delete($id)

No description

block($id)

No description

mutualFriends()

No description

Details

in JController at line 292
JObject __construct(array $config = array())

Constructor.

Parameters

array $config An optional associative array of configuration settings. Recognized key values include 'name', 'defaulttask', 'modelpath', and 'view_path' (this list is not meant to be comprehensive).

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 50
JController display()

Typical view method for MVC based architecture

This function is provide as a default implementation, in most cases you will need to override it in your own controllers.

Return Value

JController A JController object to support chaining.

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.

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.

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.

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.

CommunityBaseController($config = array())

Parameters

$config

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

Deprecated since 1.8.x

Parameters

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

ajaxBlockUnregister()

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

blockUserAccess()

Block user access to the controller method.

blockUnregister($uri = null)

Parameters

$uri

loadHelper($name)

Parameters

$name

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

Parameters

$name
$prefix
$config

executeMobile($task = '')

Parameters

$task

executeAjax($method, $ajaxArg)

Execute ajax request

Parameters

$method
$ajaxArg

ajaxBlock()

restrict blocked user to access owner details

ajaxRestrictBlockAdmin()

restrict user to block community admin

cacheClean($cacheId)

Parameters

$cacheId

at line 17
ajaxIphoneFriends()

at line 41
edit()

at line 60
friends()

View all friends. Could be current user, if $_GET['id'] is not defined otherise, show your own friends

at line 92
friendsearch()

Search Within Friends

at line 141
invite()

Show the user invite window

at line 270
online()

at line 277
news()

at line 286
sent()

List down all request that you've sent but not approved by the other side yet

at line 309
add()

Add new friend

at line 366
remove()

at line 390
deleteSent()

Method to cancel a friend request

at line 428
ajaxRejectRequest($requestId)

Ajax function to reject a friend request

Parameters

$requestId

at line 496
ajaxApproveRequest($requestId)

Ajax function to approve a friend request

Parameters

$requestId

at line 588
ajaxSaveFriend($postVars)

Parameters

$postVars

at line 658
ajaxInvite()

Show internal invite Internal invite is more like an internal messaging system

at line 666
ajaxFrindImport()

Show import friends from other account

at line 674
ajaxCancelRequest($friendsId)

Displays a dialog to the user if he / she really wants to cancel the friend request

Parameters

$friendsId

at line 706
ajaxConnect($friendId)

Show the connection request box

Parameters

$friendId

at line 812
ajaxConfirmFriendRemoval($friendId)

Parameters

$friendId

at line 856
ajaxBlockFriend($id)

Parameters

$id

at line 889
ajaxRemoveFriend($id)

Parameters

$id

at line 930
pending()

List down all connection request waiting for user to approve

at line 997
browse()

Browse the active user's friends

at line 1024
triggerFriendEvents($eventName, $args, $target = null)

Parameters

$eventName
$args
$target

at line 1045
blockUser()

Block user

at line 1061
delete($id)

Parameters

$id

at line 1108
block($id)

Parameters

$id

at line 1126
mutualFriends()