Class ilBuddySystemRelationRepository. More...

Collaboration diagram for ilBuddySystemRelationRepository:

Public Member Functions
	__construct ($usr_id)

	getDatabaseAdapter ()

	setDatabaseAdapter (ilDBInterface $db)

	getAll ()
	Reads all items from database. More...

	destroy ()

	save (ilBuddySystemRelation $relation)

Data Fields
const	TYPE_APPROVED = 'app'

const	TYPE_REQUESTED = 'req'

const	TYPE_IGNORED = 'ign'

Protected Attributes
	$db

	$usr_id

Private Member Functions
	getRelationByDatabaseRecord ($row)

	addToApprovedBuddies (ilBuddySystemRelation $relation)

	removeFromApprovedBuddies (ilBuddySystemRelation $relation)

	addToRequestedBuddies (ilBuddySystemRelation $relation, $ignored)

	removeFromRequestedBuddies (ilBuddySystemRelation $relation)

Detailed Description

Class ilBuddySystemRelationRepository.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 9 of file class.ilBuddySystemRelationRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelationRepository::__construct ( $usr_id )

Definition at line 28 of file class.ilBuddySystemRelationRepository.php.

References $DIC, and $usr_id.

         {
                 global $DIC;
 
                 $this->db     = $DIC['ilDB'];
                 $this->usr_id = $usr_id;
         }

Member Function Documentation

◆ addToApprovedBuddies()

ilBuddySystemRelationRepository::addToApprovedBuddies ( ilBuddySystemRelation $relation )

private

Parameters

ilBuddySystemRelation $relation

Definition at line 135 of file class.ilBuddySystemRelationRepository.php.

References array, ilBuddySystemRelation\getBuddyUserId(), ilBuddySystemRelation\getTimestamp(), and ilBuddySystemRelation\getUserId().

Referenced by save().

         {
                 $this->db->replace(
                         'buddylist',
                         array(
                                 'usr_id'       => array('integer', $relation->getUserId()),
                                 'buddy_usr_id' => array('integer', $relation->getBuddyUserId())
                         ),
                         array(
                                 'ts' => array('integer', $relation->getTimestamp())
                         )
                 );
 
                 $this->db->replace(
                         'buddylist',
                         array(
                                 'usr_id'       => array('integer', $relation->getBuddyUserId()),
                                 'buddy_usr_id' => array('integer', $relation->getUserId())
                         ),
                         array(
                                 'ts' => array('integer', $relation->getTimestamp())
                         )
                 );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToRequestedBuddies()

ilBuddySystemRelationRepository::addToRequestedBuddies	(	ilBuddySystemRelation	$relation,
			$ignored
	)

private

Parameters

ilBuddySystemRelation	$relation
boolean	$ignored

Definition at line 182 of file class.ilBuddySystemRelationRepository.php.

References array, ilBuddySystemRelation\getBuddyUserId(), ilBuddySystemRelation\getTimestamp(), and ilBuddySystemRelation\getUserId().

Referenced by save().

         {
                 $this->db->replace(
                         'buddylist_requests',
                         array(
                                 'usr_id'       => array('integer', $relation->getUserId()),
                                 'buddy_usr_id' => array('integer', $relation->getBuddyUserId())
                         ),
                         array(
                                 'ts'      => array('integer', $relation->getTimestamp()),
                                 'ignored' => array('integer', (int)$ignored)
                         )
                 );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ destroy()

ilBuddySystemRelationRepository::destroy ( )

Definition at line 117 of file class.ilBuddySystemRelationRepository.php.

References array.

         {
                 $this->db->queryF(
                         "DELETE FROM buddylist WHERE usr_id = %s OR buddy_usr_id = %s",
                         array('integer', 'integer'),
                         array($this->usr_id, $this->usr_id)
                 );
 
                 $this->db->queryF(
                         "DELETE FROM buddylist_requests WHERE usr_id = %s OR buddy_usr_id = %s",
                         array('integer', 'integer'),
                         array($this->usr_id, $this->usr_id)
                 );
         }

◆ getAll()

ilBuddySystemRelationRepository::getAll ( )

Reads all items from database.

Returns: ilBuddySystemRelation[]

Definition at line 56 of file class.ilBuddySystemRelationRepository.php.

References $res, $row, $usr_id, array, and getRelationByDatabaseRecord().

         {
                 $relations = array();
 
                 $res = $this->db->queryF(
                         "
                         SELECT usr_id, buddy_usr_id, ts, %s rel_type FROM buddylist WHERE usr_id = %s
                         UNION
                         SELECT usr_id, buddy_usr_id, ts, (CASE WHEN ignored = 1 THEN %s ELSE %s END) rel_type FROM buddylist_requests WHERE usr_id = %s OR buddy_usr_id = %s
                         ",
                         array(
                                 'text', 'integer', 'text', 'text', 'integer', 'integer'
                         ),
                         array(
                                 self::TYPE_APPROVED, $this->usr_id, self::TYPE_IGNORED, self::TYPE_REQUESTED, $this->usr_id, $this->usr_id
                         )
                 );
 
                 while($row = $this->db->fetchAssoc($res))
                 {
                         $relation = $this->getRelationByDatabaseRecord($row);
                         $relation->setUserId($row['usr_id']);
                         $relation->setBuddyUserId($row['buddy_usr_id']);
                         $relation->setTimestamp($row['ts']);
                         $relation->setIsOwnedByRequest($relation->getUserId() == $this->usr_id);
                         $key = $this->usr_id == $relation->getUserId() ? $relation->getBuddyUserId() : $relation->getUserId();
                         $relations[$key] = $relation;
                 }
 
                 return $relations;
         }

Here is the call graph for this function:

◆ getDatabaseAdapter()

ilBuddySystemRelationRepository::getDatabaseAdapter ( )

Returns: ilDBInterface

Definition at line 39 of file class.ilBuddySystemRelationRepository.php.

References $db.

         {
                 return $this->db;
         }

◆ getRelationByDatabaseRecord()

ilBuddySystemRelationRepository::getRelationByDatabaseRecord ( $row )

private

Parameters

$row

Returns: ilBuddySystemRelation

Definition at line 92 of file class.ilBuddySystemRelationRepository.php.

References $row.

Referenced by getAll().

         {
                 if(self::TYPE_APPROVED == $row['rel_type'])
                 {
                         $relation = new ilBuddySystemRelation(new ilBuddySystemLinkedRelationState());
                         return $relation;
                 }
                 else
                 {
                         if(self::TYPE_IGNORED == $row['rel_type'])
                         {
                                 $relation = new ilBuddySystemRelation(new ilBuddySystemIgnoredRequestRelationState());
                                 return $relation;
                         }
                         else
                         {
                                 $relation = new ilBuddySystemRelation(new ilBuddySystemRequestedRelationState());
                                 return $relation;
                         }
                 }
         }

Here is the caller graph for this function:

◆ removeFromApprovedBuddies()

ilBuddySystemRelationRepository::removeFromApprovedBuddies ( ilBuddySystemRelation $relation )

private

Parameters

ilBuddySystemRelation $relation

Definition at line 163 of file class.ilBuddySystemRelationRepository.php.

References array, ilBuddySystemRelation\getBuddyUserId(), and ilBuddySystemRelation\getUserId().

Referenced by save().

         {
                 $this->db->manipulateF(
                         "DELETE FROM buddylist WHERE usr_id = %s AND buddy_usr_id = %s",
                         array('integer', 'integer'),
                         array($relation->getUserId(), $relation->getBuddyUserId())
                 );
 
                 $this->db->manipulateF(
                         "DELETE FROM buddylist WHERE buddy_usr_id = %s AND usr_id = %s",
                         array('integer', 'integer'),
                         array($relation->getUserId(), $relation->getBuddyUserId())
                 );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromRequestedBuddies()

ilBuddySystemRelationRepository::removeFromRequestedBuddies ( ilBuddySystemRelation $relation )

private

Parameters

ilBuddySystemRelation $relation

Definition at line 200 of file class.ilBuddySystemRelationRepository.php.

References array, ilBuddySystemRelation\getBuddyUserId(), and ilBuddySystemRelation\getUserId().

Referenced by save().

         {
                 $this->db->manipulateF(
                         "DELETE FROM buddylist_requests WHERE usr_id = %s AND buddy_usr_id = %s",
                         array('integer', 'integer'),
                         array($relation->getUserId(), $relation->getBuddyUserId())
                 );
 
                 $this->db->manipulateF(
                         "DELETE FROM buddylist_requests WHERE buddy_usr_id = %s AND usr_id = %s",
                         array('integer', 'integer'),
                         array($relation->getUserId(), $relation->getBuddyUserId())
                 );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilBuddySystemRelationRepository::save ( ilBuddySystemRelation $relation )

Parameters

ilBuddySystemRelation $relation

Definition at line 218 of file class.ilBuddySystemRelationRepository.php.

References $ilDB, addToApprovedBuddies(), addToRequestedBuddies(), ilBuddySystemRelation\isIgnored(), ilBuddySystemRelation\isLinked(), ilBuddySystemRelation\isRequested(), removeFromApprovedBuddies(), removeFromRequestedBuddies(), ilBuddySystemRelation\wasIgnored(), ilBuddySystemRelation\wasLinked(), and ilBuddySystemRelation\wasRequested().

         {
                 $ilAtomQuery = $this->db->buildAtomQuery();
                 $ilAtomQuery->addTableLock('buddylist_requests');
                 $ilAtomQuery->addTableLock('buddylist');
 
                 $ilAtomQuery->addQueryCallable(function(ilDBInterface $ilDB) use ($relation) {
                         if($relation->isLinked())
                         {
                                 $this->addToApprovedBuddies($relation);
                         }
                         else if($relation->wasLinked())
                         {
                                 $this->removeFromApprovedBuddies($relation);
                         }
 
                         if($relation->isRequested())
                         {
                                 $this->addToRequestedBuddies($relation, false);
                         }
                         else if($relation->isIgnored())
                         {
                                 $this->addToRequestedBuddies($relation, true);
                         }
                         else if($relation->wasRequested() || $relation->wasIgnored())
                         {
                                 $this->removeFromRequestedBuddies($relation);
                         }
                 });
 
                 $ilAtomQuery->run();
         }

Here is the call graph for this function:

◆ setDatabaseAdapter()

ilBuddySystemRelationRepository::setDatabaseAdapter ( ilDBInterface $db )

Parameters

ilDBInterface $db

Definition at line 47 of file class.ilBuddySystemRelationRepository.php.

References $db.

         {
                 $this->db = $db;
         }

Field Documentation

◆ $db

ilBuddySystemRelationRepository::$db

protected

Definition at line 18 of file class.ilBuddySystemRelationRepository.php.

Referenced by getDatabaseAdapter(), and setDatabaseAdapter().

◆ $usr_id

int ilBuddySystemRelationRepository::$usr_id

protected

Definition at line 23 of file class.ilBuddySystemRelationRepository.php.

Referenced by __construct(), and getAll().

◆ TYPE_APPROVED

const ilBuddySystemRelationRepository::TYPE_APPROVED = 'app'

Definition at line 11 of file class.ilBuddySystemRelationRepository.php.

◆ TYPE_IGNORED

const ilBuddySystemRelationRepository::TYPE_IGNORED = 'ign'

Definition at line 13 of file class.ilBuddySystemRelationRepository.php.

◆ TYPE_REQUESTED

const ilBuddySystemRelationRepository::TYPE_REQUESTED = 'req'

Definition at line 12 of file class.ilBuddySystemRelationRepository.php.

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

Services/Contact/BuddySystem/classes/class.ilBuddySystemRelationRepository.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToApprovedBuddies()

◆ addToRequestedBuddies()

◆ destroy()

◆ getAll()

◆ getDatabaseAdapter()

◆ getRelationByDatabaseRecord()

◆ removeFromApprovedBuddies()

◆ removeFromRequestedBuddies()

◆ save()

◆ setDatabaseAdapter()

Field Documentation

◆ $db

◆ $usr_id

◆ TYPE_APPROVED

◆ TYPE_IGNORED

◆ TYPE_REQUESTED