Elgg  Version 3.0
Public Member Functions | Protected Attributes | List of all members
Elgg\Database\RelationshipsTable Class Reference

WARNING: API IN FLUX. More...

Public Member Functions

 __construct (Database $db, EntityTable $entities, MetadataTable $metadata, EventsService $events)
 Constructor. More...
 
 get ($id)
 Get a relationship by its ID. More...
 
 getRow ($id)
 Get a database row from the relationship table. More...
 
 delete ($id, $call_event=true)
 Delete a relationship by its ID. More...
 
 add ($guid_one, $relationship, $guid_two, $return_id=false)
 Create a relationship between two entities. More...
 
 check ($guid_one, $relationship, $guid_two)
 Check if a relationship exists between two entities. More...
 
 remove ($guid_one, $relationship, $guid_two)
 Delete a relationship between two entities. More...
 
 removeAll ($guid, $relationship="", $inverse_relationship=false, $type= '')
 Removes all relationships originating from a particular entity. More...
 
 getAll ($guid, $inverse_relationship=false)
 Get all the relationships for a given GUID. More...
 
 getEntitiesFromCount (array $options=[])
 Gets the number of entities by a the number of entities related to them in a particular way. More...
 
 rowToElggRelationship ($row)
 Convert a database row to a new . More...
 

Protected Attributes

 $db
 
 $entities
 
 $metadata
 
 $events
 

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Definition at line 20 of file RelationshipsTable.php.

Constructor & Destructor Documentation

Elgg\Database\RelationshipsTable::__construct ( Database  $db,
EntityTable  $entities,
MetadataTable  $metadata,
EventsService  $events 
)

Constructor.

Parameters
Database$dbElgg Database
EntityTable$entitiesEntity table
MetadataTable$metadataMetadata table
EventsService$eventsEvents service

Definition at line 52 of file RelationshipsTable.php.

Member Function Documentation

Elgg\Database\RelationshipsTable::add (   $guid_one,
  $relationship,
  $guid_two,
  $return_id = false 
)

Create a relationship between two entities.

E.g. friendship, group membership, site membership.

This function lets you make the statement "$guid_one is a $relationship of $guid_two". In the statement, $guid_one is the subject of the relationship, $guid_two is the target, and $relationship is the type.

Parameters
int$guid_oneGUID of the subject entity of the relationship
string$relationshipType of the relationship
int$guid_twoGUID of the target entity of the relationship
bool$return_idReturn the ID instead of bool?
Returns
bool|int
Exceptions

Definition at line 128 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::check (   $guid_one,
  $relationship,
  $guid_two 
)

Check if a relationship exists between two entities.

If so, the relationship object is returned.

This function lets you ask "Is $guid_one a $relationship of $guid_two?"

Parameters
int$guid_oneGUID of the subject entity of the relationship
string$relationshipType of the relationship
int$guid_twoGUID of the target entity of the relationship
Returns
|false Depending on success

Definition at line 188 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::delete (   $id,
  $call_event = true 
)

Delete a relationship by its ID.

Parameters
int$idRelationship ID
bool$call_eventCall the delete event before deleting
Returns
bool

Definition at line 98 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::get (   $id)

Get a relationship by its ID.

Parameters
int$idThe relationship ID
Returns
|false False if not found

Definition at line 66 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::getAll (   $guid,
  $inverse_relationship = false 
)

Get all the relationships for a given GUID.

Parameters
int$guidGUID of the subject or target entity (see $inverse)
bool$inverse_relationshipIs $guid the target of the deleted relationships? By default $guid is the subject of the relationships.
Returns
[]

Definition at line 285 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::getEntitiesFromCount ( array  $options = [])

Gets the number of entities by a the number of entities related to them in a particular way.

This is a good way to get out the users with the most friends, or the groups with the most members.

Parameters
array$optionsAn options array compatible with elgg_get_entities()
Returns
[]|int|boolean If count, int. If not count, array. false on errors.

Definition at line 307 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::getRow (   $id)

Get a database row from the relationship table.

Parameters
int$idThe relationship ID
Returns
|false False if no row found

Definition at line 82 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::remove (   $guid_one,
  $relationship,
  $guid_two 
)

Delete a relationship between two entities.

This function lets you say "$guid_one is no longer a $relationship of $guid_two."

Parameters
int$guid_oneGUID of the subject entity of the relationship
string$relationshipType of the relationship
int$guid_twoGUID of the target entity of the relationship
Returns
bool

Definition at line 220 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::removeAll (   $guid,
  $relationship = "",
  $inverse_relationship = false,
  $type = '' 
)

Removes all relationships originating from a particular entity.

Parameters
int$guidGUID of the subject or target entity (see $inverse)
string$relationshipType of the relationship (optional, default is all relationships)
bool$inverse_relationshipIs $guid the target of the deleted relationships? By default, $guid is the subject of the relationships.
string$typeThe type of entity related to $guid (defaults to all)
Returns
true

Definition at line 240 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::rowToElggRelationship (   $row)

Convert a database row to a new .

Parameters
\stdClass$rowDatabase row from the relationship table
Returns
|false

Definition at line 322 of file RelationshipsTable.php.

Member Data Documentation

Elgg\Database\RelationshipsTable::$db
protected

Definition at line 27 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::$entities
protected

Definition at line 32 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::$events
protected

Definition at line 42 of file RelationshipsTable.php.

Elgg\Database\RelationshipsTable::$metadata
protected

Definition at line 37 of file RelationshipsTable.php.


The documentation for this class was generated from the following file: