Relationships table database service. More...

Public Member Functions
	__construct (protected Database $db, protected EntityTable $entities, protected MetadataTable $metadata, protected EventsService $events)
	Constructor. More...

	get (int $id)
	Get a relationship by its ID. More...

	delete (int $id)
	Delete a relationship by its ID. More...

	add (\ElggRelationship $relationship, bool $return_id=false)
	Create a relationship between two entities. More...

	check (int $guid_one, string $relationship, int $guid_two)
	Check if a relationship exists between two entities. More...

	remove (int $guid_one, string $relationship, int $guid_two)
	Delete a relationship between two entities. More...

	removeAll (int $guid, string $relationship='', bool $inverse_relationship=false, string $type='', bool $trigger_events=true)
	Removes all relationships originating from a particular entity. More...

	getEntitiesFromCount (array $options=[])
	Gets the number of entities by a the number of entities related to them in a particular way. More...

	rowToElggRelationship (\stdClass $row)
	Convert a database row to a new \ElggRelationship. More...

Public Attributes
const	RELATIONSHIP_COLUMN_LENGTH = 255

const	TABLE_NAME = 'entity_relationships'

const	DEFAULT_JOIN_ALIAS = 'r'

Protected Member Functions
	removeAllWithoutEvents (int $guid, string $relationship='', bool $inverse_relationship=false, string $type='')
	Removes all relationships originating from a particular entity. More...

	removeAllWithEvents (int $guid, string $relationship='', bool $inverse_relationship=false, string $type='')
	Removes all relationships originating from a particular entity. More...

Detailed Description

Relationships table database service.

Definition at line 21 of file RelationshipsTable.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

Database	$db	Elgg Database
EntityTable	$entities	Entity table
MetadataTable	$metadata	Metadata table
EventsService	$events	Events service

Definition at line 42 of file RelationshipsTable.php.

Member Function Documentation

◆ add()

Elgg\Database\RelationshipsTable::add	(	\ElggRelationship	$relationship,
		bool	$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

\ElggRelationship	$relationship	the relationship to create
bool	$return_id	Return the ID instead of bool?

Returns: bool|int

Exceptions

LengthException

Definition at line 98 of file RelationshipsTable.php.

◆ check()

Elgg\Database\RelationshipsTable::check	(	int	$guid_one,
		string	$relationship,
		int	$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_one	GUID of the subject entity of the relationship
string	$relationship	Type of the relationship
int	$guid_two	GUID of the target entity of the relationship

Returns: \ElggRelationship|false Depending on success

Definition at line 165 of file RelationshipsTable.php.

◆ delete()

Elgg\Database\RelationshipsTable::delete ( int $id )

Delete a relationship by its ID.

Parameters

int $id Relationship ID

Returns: bool

Definition at line 72 of file RelationshipsTable.php.

◆ get()

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

Get a relationship by its ID.

Parameters

int $id The relationship ID

Returns: \ElggRelationship|null

Definition at line 57 of file RelationshipsTable.php.

◆ getEntitiesFromCount()

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 $options An options array compatible with elgg_get_entities()

Returns: \ElggEntity[]|int|boolean If count, int. If not count, array. false on errors.

Definition at line 350 of file RelationshipsTable.php.

◆ remove()

Elgg\Database\RelationshipsTable::remove	(	int	$guid_one,
		string	$relationship,
		int	$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_one	GUID of the subject entity of the relationship
string	$relationship	Type of the relationship
int	$guid_two	GUID of the target entity of the relationship

Returns: bool

Definition at line 188 of file RelationshipsTable.php.

◆ removeAll()

Elgg\Database\RelationshipsTable::removeAll	(	int	$guid,
		string	$relationship = `''`,
		bool	$inverse_relationship = `false`,
		string	$type = `''`,
		bool	$trigger_events = `true`
	)

Removes all relationships originating from a particular entity.

Parameters

int	$guid	GUID of the subject or target entity (see $inverse)
string	$relationship	Type of the relationship (optional, default is all relationships)
bool	$inverse_relationship	Is $guid the target of the deleted relationships? By default, $guid is the subject of the relationships.
string	$type	The type of entity related to $guid (defaults to all)
bool	$trigger_events	Trigger the delete event for each relationship (default: true)

Returns: true

Definition at line 209 of file RelationshipsTable.php.

◆ removeAllWithEvents()

Elgg\Database\RelationshipsTable::removeAllWithEvents	(	int	$guid,
		string	$relationship = `''`,
		bool	$inverse_relationship = `false`,
		string	$type = `''`
	)

protected

Removes all relationships originating from a particular entity.

The does trigger the delete event for each relationship

Parameters

int	$guid	GUID of the subject or target entity (see $inverse)
string	$relationship	Type of the relationship (optional, default is all relationships)
bool	$inverse_relationship	Is $guid the target of the deleted relationships? By default, $guid is the subject of the relationships.
string	$type	The type of entity related to $guid (defaults to all)

Returns: true

Definition at line 273 of file RelationshipsTable.php.

◆ removeAllWithoutEvents()

Elgg\Database\RelationshipsTable::removeAllWithoutEvents	(	int	$guid,
		string	$relationship = `''`,
		bool	$inverse_relationship = `false`,
		string	$type = `''`
	)

protected

Removes all relationships originating from a particular entity.

This doesn't trigger the delete event for each relationship

Parameters

int	$guid	GUID of the subject or target entity (see $inverse)
string	$relationship	Type of the relationship (optional, default is all relationships)
bool	$inverse_relationship	Is $guid the target of the deleted relationships? By default, $guid is the subject of the relationships.
string	$type	The type of entity related to $guid (defaults to all)

Returns: true

Definition at line 230 of file RelationshipsTable.php.

◆ rowToElggRelationship()

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

Convert a database row to a new \ElggRelationship.

Parameters

\stdClass $row Database row from the relationship table

Returns: \ElggRelationship

Definition at line 365 of file RelationshipsTable.php.

Member Data Documentation

◆ DEFAULT_JOIN_ALIAS

const Elgg\Database\RelationshipsTable::DEFAULT_JOIN_ALIAS = 'r'

Definition at line 32 of file RelationshipsTable.php.

◆ RELATIONSHIP_COLUMN_LENGTH

const Elgg\Database\RelationshipsTable::RELATIONSHIP_COLUMN_LENGTH = 255

Definition at line 28 of file RelationshipsTable.php.

◆ TABLE_NAME

const Elgg\Database\RelationshipsTable::TABLE_NAME = 'entity_relationships'

Definition at line 30 of file RelationshipsTable.php.

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

engine/classes/Elgg/Database/RelationshipsTable.php

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ check()

◆ delete()

◆ get()

◆ getEntitiesFromCount()

◆ remove()

◆ removeAll()

◆ removeAllWithEvents()

◆ removeAllWithoutEvents()

◆ rowToElggRelationship()

Member Data Documentation

◆ DEFAULT_JOIN_ALIAS

◆ RELATIONSHIP_COLUMN_LENGTH

◆ TABLE_NAME