ilGeoLocationDBRepository Class Reference

Inheritance diagram for ilGeoLocationDBRepository:

Collaboration diagram for ilGeoLocationDBRepository:

Public Member Functions
	__construct (\ilDBInterface $a_db)
	createGeoLocation (string $a_title, float $a_latitude, float $a_longitude, \DateTimeImmutable $a_expiration_timestamp)
	Create a new geo location entry. More...
	getGeoLocationById (int $a_id)
	Get a single geo location, identified by its id. More...
	getGeoLocationsByCoordinates (float $a_latitude, float $a_longitude)
	Example for reading an array of geo locations which have a given attribute. More...
	ifGeoLocationExistsById (int $a_id)
	Example for checking if geo location with a certain id exists. More...
	ifAnyGeoLocationExistsByCoordinates (float $a_latitude, float $a_longitude)
	Example for checking if a geo location (one or more) with a given attribute exists. More...
	updateGeoLocation (ilGeoLocation $a_obj)
	Example for updating all attributes of a given geo location. More...
	updateGeoLocationTimestampByCoordinates (float $a_searched_latitude, float $a_searched_longitude, \DateTimeImmutable $a_update_timestamp)
	Example for updating multiple objects at once. More...
	deleteGeoLocation (int $a_id)
	Example for deleting single geo location identified by its id. More...
	deleteGeoLocationsByCoordinates (float $a_latitude, float $a_longitude)
	Example for a condition based deletion of multiple geo locations. More...
	deleteExpiredGeoLocations ()
	Example for a condition based deletion of multiple geo locations. More...
	createGeoLocation (string $a_title, float $a_latitude, float $a_longitude, \DateTimeImmutable $a_expiration_timestamp)
	Create a new geo location entry. More...
	getGeoLocationById (int $a_id)
	Get a single geo location, identified by its id. More...
	getGeoLocationsByCoordinates (float $a_latitude, float $a_longitude)
	Example for reading an array of geo locations which have a given attribute. More...
	ifGeoLocationExistsById (int $a_id)
	Example for checking if geo location with a certain id exists. More...
	ifAnyGeoLocationExistsByCoordinates (float $a_latitude, float $a_longitude)
	Example for checking if a geo location (one or more) with a given attribute exists. More...
	updateGeoLocation (ilGeoLocation $a_obj)
	Example for updating all attributes of a given geo location. More...
	updateGeoLocationTimestampByCoordinates (float $a_searched_latitude, float $a_searched_longitude, \DateTimeImmutable $a_update_timestamp)
	Example for updating multiple objects at once. More...
	deleteGeoLocation (int $a_id)
	Example for deleting single geo location identified by its id. More...
	deleteGeoLocationsByCoordinates (float $a_latitude, float $a_longitude)
	Example for a condition based deletion of multiple geo locations. More...
	deleteExpiredGeoLocations ()
	Example for a condition based deletion of multiple geo locations. More...

Data Fields
const	TABLE_NAME = 'geo_location'

Detailed Description

Definition at line 3 of file ilGeoLocationDBRepository.php.

Constructor & Destructor Documentation

__construct()

ilGeoLocationDBRepository::__construct

(

\ilDBInterface

$a_db

)

Definition at line 7 of file ilGeoLocationDBRepository.php.

        {
                $this->db = $a_db;
        }

Member Function Documentation

createGeoLocation()

ilGeoLocationDBRepository::createGeoLocation	(	string	$a_title,
		float	$a_latitude,
		float	$a_longitude,
		\DateTimeImmutable	$a_expiration_timestamp
	)

Create a new geo location entry.

Implements ilGeoLocationRepository.

Definition at line 12 of file ilGeoLocationDBRepository.php.

          : ilGeoLocation
        {
                // Get next free id for object
                $id = $this->db->nextId($this->db->quoteIdentifier(self::TABLE_NAME));
 
                // Insert in database
                $this->db->insert($this->db->quoteIdentifier(self::TABLE_NAME), array(
                        'id' => array('integer', $id),
                        'title' => array('text', $a_title),
                        'latitude' => array('float', $a_latitude),
                        'longitude' => array('float', $a_longitude),
                        'expiration_timestamp' => array('timestamp', $a_expiration_timestamp->getTimestamp())
                ));
 
                // Return the new created object or just the id
                return new ilGeoLocation(
                        $id,
                        $a_title,
                        $a_latitude,
                        $a_longitude,
                        $a_expiration_timestamp
                );
        }

References $id.

deleteExpiredGeoLocations()

ilGeoLocationDBRepository::deleteExpiredGeoLocations

(

)

Example for a condition based deletion of multiple geo locations.

Implements ilGeoLocationRepository.

Definition at line 169 of file ilGeoLocationDBRepository.php.

        {
                // Set up delete query
                $query = 'DELETE FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                        ' WHERE expiration_timestamp < ' . $this->db->quote(time(), 'timestamp');
 
                // Execute delete query
                $this->db->manipulate($query);
        }

deleteGeoLocation()

ilGeoLocationDBRepository::deleteGeoLocation

(

int

$a_id

)

Example for deleting single geo location identified by its id.

Implements ilGeoLocationRepository.

Definition at line 148 of file ilGeoLocationDBRepository.php.

        {
                // Set up delete query
                $query = 'DELETE FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                ' WHERE id = ' . $this->db->quote($a_id, 'integer');
 
                // Execute delete query
                $this->db->manipulate($query);
        }

deleteGeoLocationsByCoordinates()

ilGeoLocationDBRepository::deleteGeoLocationsByCoordinates	(	float	$a_latitude,
		float	$a_longitude
	)

Example for a condition based deletion of multiple geo locations.

Implements ilGeoLocationRepository.

Definition at line 158 of file ilGeoLocationDBRepository.php.

        {
                // Set up delete query
                $query = 'DELETE FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                        ' WHERE latitude < ' . $this->db->quote($a_latitude, 'float') .
                        ' AND longitude = ' . $this->db->quote($a_longitude, 'float');
 
                // Execute delete query
                $this->db->manipulate($query);
        }

getGeoLocationById()

ilGeoLocationDBRepository::getGeoLocationById

(

int

$a_id

)

Get a single geo location, identified by its id.

Implements ilGeoLocationRepository.

Definition at line 41 of file ilGeoLocationDBRepository.php.

                                                      : ilGeoLocation
        {
                // Set up SQL-Statement
                $query = 'SELECT title, latitude, longitude, expiration_timestamp' .
                                ' FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                                ' WHERE id = ' . $this->db->quote($a_id, 'integer');
 
                // Execute query
                $result = $this->db->query($query);
 
                // Fetch row for returning
                if($row = $this->db->fetchAssoc($result))
                {
                        // Create object out of fetched data and return it
                        return new ilGeoLocation(
                                $a_id,
                                $row['title'],
                                (float)$row['latitude'],
                                (float)$row['longitude'],
                                new DateTimeImmutable($row['expiration_timestamp'])
                        );
                }
 
                throw new \InvalidArgumentException("Unknown id for geolocation: $a_id");
        }

getGeoLocationsByCoordinates()

ilGeoLocationDBRepository::getGeoLocationsByCoordinates	(	float	$a_latitude,
		float	$a_longitude
	)

Example for reading an array of geo locations which have a given attribute.

Returns

ilGeoLocation[]

Implements ilGeoLocationRepository.

Definition at line 67 of file ilGeoLocationDBRepository.php.

                                                                                            : array
        {
                // Set up SQL-Statement
                $query = 'SELECT title, expiration_timestamp' .
                                ' FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                                ' WHERE latitude = ' . $this->db->quote($a_latitude, 'float') .
                                ' AND longitude = ' . $this->db->quote($a_longitude, 'float');
 
                // Execute query
                $result = $this->db->query($query);
 
                // Fill array with all matching objects
                $locations = array();
                while($row = $this->db->fetchAssoc($result))
                {
                        // Create object and add it to list
                        $locations[] = new ilGeoLocation(
                                (int)$row['id'],
                                $row['title'],
                                $a_latitude,
                                $a_longitude,
                                new DateTimeImmutable($row['expiration_timestamp'])
                        );
                }
 
                // Return list of objects (might be empty if no object was found)
                return $locations;
        }

ifAnyGeoLocationExistsByCoordinates()

ilGeoLocationDBRepository::ifAnyGeoLocationExistsByCoordinates	(	float	$a_latitude,
		float	$a_longitude
	)

Example for checking if a geo location (one or more) with a given attribute exists.

Implements ilGeoLocationRepository.

Definition at line 109 of file ilGeoLocationDBRepository.php.

                                                                                                   : bool
        {
                // Set up SQL-Statement
                $query = 'SELECT EXISTS(SELECT 1 FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                                 ' WHERE latitude = ' . $this->db->quote($a_latitude, 'float') .
                                 ' AND longitude = ' . $this->db->quote($a_longitude, 'float') . ") AS count";
                // Execute statement
                $result = $this->db->query($query);
 
                // Return if any object was found
                return $result['count'] == 1;
        }

ifGeoLocationExistsById()

ilGeoLocationDBRepository::ifGeoLocationExistsById

(

int

$a_id

)

Example for checking if geo location with a certain id exists.

Implements ilGeoLocationRepository.

Definition at line 96 of file ilGeoLocationDBRepository.php.

                                                           : bool
        {
                // Set up SQL-Statement
                $query = 'SELECT EXISTS(SELECT 1 FROM ' . $this->db->quoteIdentifier(self::TABLE_NAME) .
                                ' WHERE id = ' . $this->db->quote($a_id, 'integer') . ") AS count";
 
                // Execute statement
                $result = $this->db->query($query);
 
                // Return true if object was found
                return $result['count'] == 1;
        }

updateGeoLocation()

ilGeoLocationDBRepository::updateGeoLocation

(

ilGeoLocation

$a_obj

)

Example for updating all attributes of a given geo location.

Implements ilGeoLocationRepository.

Definition at line 122 of file ilGeoLocationDBRepository.php.

        {
                // Update of one entire geo location object
                $this->db->update($this->db->quoteIdentifier(self::TABLE_NAME),
                        // Update columns (in this case all except for id):
                        array('title' => array($a_obj->getTitle(), 'text')),
                        array('latitude' => array($a_obj->getLatitude(), 'float')),
                        array('longitude' => array($a_obj->getLongitude(), 'float')),
                        array('expiration_timestamp' => array($a_obj->getExpirationAsTimestamp(), 'timestamp')),
                        // Where (in this case only the object with the given id):
                        array('id' => array($a_obj->getId(), 'int'))
                );
        }

References ilGeoLocation\getExpirationAsTimestamp(), ilGeoLocation\getId(), ilGeoLocation\getLatitude(), ilGeoLocation\getLongitude(), and ilGeoLocation\getTitle().

Here is the call graph for this function:

updateGeoLocationTimestampByCoordinates()

ilGeoLocationDBRepository::updateGeoLocationTimestampByCoordinates	(	float	$a_searched_latitude,
		float	$a_searched_longitude,
		\DateTimeImmutable	$a_update_timestamp
	)

Example for updating multiple objects at once.

Implements ilGeoLocationRepository.

Definition at line 136 of file ilGeoLocationDBRepository.php.

        {
                // Update for single attribute of a set of geo location objects
                $this->db->update($this->db->quoteIdentifier(self::TABLE_NAME),
                        // Update columns (in this case only the timestamp):
                        array('expiration_timestamp' => array('timestamp', $a_update_timestamp->getTimestamp())),
                        // Where (in this case every object on the given location):
                        array('latitude' => array($a_searched_latitude, 'float'),
                                  'longitude' => array($a_searched_longitude, 'float'))
                );
        }

Field Documentation

TABLE_NAME

const ilGeoLocationDBRepository::TABLE_NAME = 'geo_location'

Definition at line 5 of file ilGeoLocationDBRepository.php.

---

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

• docs/development/code-examples/repository-pattern/01_simple_example/ilGeoLocationDBRepository.php