ilGeoLocationRepository Interface Reference

This code is just an example for the Repository Pattern! It is a basic interface to the 'ilGeoLocation*Repository'-classes. More...

Inheritance diagram for ilGeoLocationRepository:

Collaboration diagram for ilGeoLocationRepository:

Public Member Functions
	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)
	Exaple 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...

Detailed Description

This code is just an example for the Repository Pattern! It is a basic interface to the 'ilGeoLocation*Repository'-classes.

Classes, which implement this interface persist/read/update an object of the class ilGeoLocation to/from either a database, a file or something else. Due to this conditions, this interface is as abstract as possible and should not contain any database or filesystem specific methods.

Definition at line 12 of file ilGeoLocationRepository.php.

Member Function Documentation

createGeoLocation()

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

Create a new geo location entry.

Implemented in ilGeoLocationDBRepository, and ilGeoLocationFileMockRepository.

deleteExpiredGeoLocations()

ilGeoLocationRepository::deleteExpiredGeoLocations

(

)

Example for a condition based deletion of multiple geo locations.

Implemented in ilGeoLocationFileMockRepository, and ilGeoLocationDBRepository.

deleteGeoLocation()

ilGeoLocationRepository::deleteGeoLocation

(

int

$a_id

)

Exaple for deleting single geo location identified by its id.

Implemented in ilGeoLocationFileMockRepository, and ilGeoLocationDBRepository.

deleteGeoLocationsByCoordinates()

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

Example for a condition based deletion of multiple geo locations.

Implemented in ilGeoLocationFileMockRepository, and ilGeoLocationDBRepository.

getGeoLocationById()

ilGeoLocationRepository::getGeoLocationById

(

int

$a_id

)

Get a single geo location, identified by its id.

Implemented in ilGeoLocationDBRepository, and ilGeoLocationFileMockRepository.

getGeoLocationsByCoordinates()

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

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

Returns

ilGeoLocation[]

Implemented in ilGeoLocationDBRepository, and ilGeoLocationFileMockRepository.

ifAnyGeoLocationExistsByCoordinates()

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

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

Implemented in ilGeoLocationDBRepository, and ilGeoLocationFileMockRepository.

ifGeoLocationExistsById()

ilGeoLocationRepository::ifGeoLocationExistsById

(

int

$a_id

)

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

Implemented in ilGeoLocationDBRepository, and ilGeoLocationFileMockRepository.

updateGeoLocation()

ilGeoLocationRepository::updateGeoLocation

(

ilGeoLocation

$a_obj

)

Example for updating all attributes of a given geo location.

Implemented in ilGeoLocationDBRepository, and ilGeoLocationFileMockRepository.

updateGeoLocationTimestampByCoordinates()

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

Example for updating multiple objects at once.

Implemented in ilGeoLocationFileMockRepository, and ilGeoLocationDBRepository.

---

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

• docs/development/code-examples/repository-pattern/00_base_classes/ilGeoLocationRepository.php