ilGeoLocationFileMockRepository Class Reference

Inheritance diagram for ilGeoLocationFileMockRepository:

Collaboration diagram for ilGeoLocationFileMockRepository:

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 a geo location (one or more) with a given attribute 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)
	Update 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)
	Delete 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)
	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...

Protected Member Functions
	readFileAndReturnAsList ($file)
	Protected function. More...
	writeGeoLocationListToFile ($file, $list)
	Protected function. More...

Detailed Description

Definition at line 3 of file ilGeoLocationFileMockRepository.php.

Member Function Documentation

createGeoLocation()

ilGeoLocationFileMockRepository::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 9 of file ilGeoLocationFileMockRepository.php.

      : ilGeoLocation {
        // Generate a random object id. This should just work fine for development
        $generated_id = rand(1, 100000);
        $file = fopen('mocked_geolocation_data.txt', FILE_APPEND);
 
        // Create a csv-string for object data for the file
        $write_string = "$generated_id;$a_title;$a_latitude;$a_longitude;$a_expiration_timestamp\n";
 
        // Write new object to file
        fwrite($file, $write_string);
        fclose($file);
 
        return new ilGeoLocation(
            $generated_id,
            $a_title,
            $a_latitude,
            $a_longitude,
            $a_expiration_timestamp
        );
    }

deleteExpiredGeoLocations()

ilGeoLocationFileMockRepository::deleteExpiredGeoLocations

(

)

Example for a condition based deletion of multiple geo locations.

Implements ilGeoLocationRepository.

Definition at line 202 of file ilGeoLocationFileMockRepository.php.

    {
        // Read all geo locations from file
        $file = fopen('mocked_geolocation_data.txt', 'r');
        $geo_locations = $this->readFileAndReturnAsList($file);
        fclose($file);
 
        // Filter out expired objects
        $now = new DateTimeImmutable();
        foreach ($geo_locations as $key => $row) {
            // Check if current row contains an expired timestamp
            // Note: This is an example but it needs to be tested if differences can be calculated like this
            $dt = new DateTimeImmutable($row[4]);
            if ($now->diff($dt)->s >= 0) {
                unset($geo_locations[$key]);
            }
        }
 
        // Write objects back to file
        $file = fopen('mocked_geolocation_data.txt', 'w');
        $this->writeGeoLocationListToFile($file, $geo_locations);
        fclose($file);
    }

deleteGeoLocation()

ilGeoLocationFileMockRepository::deleteGeoLocation

(

int

$a_id

)

Delete single geo location identified by its id.

Implements ilGeoLocationRepository.

Definition at line 157 of file ilGeoLocationFileMockRepository.php.

    {
        $file = fopen('mocked_geolocation_data.txt', 'r');
        $geo_locations = $this->readFileAndReturnAsList($file);
        fclose($file);
 
        // Delete searched object from list
        foreach ($geo_locations as $key => $row) {
            // Check if current row has searched id
            if ($row[0] == $a_id) {
                unset($geo_locations[$key]);
            }
        }
 
        // Write back all geo locations to file
        $file = fopen('mocked_geolocation_data.txt', 'w');
        $this->writeGeoLocationListToFile($file, $geo_locations);
        fclose($file);
    }

deleteGeoLocationsByCoordinates()

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

Example for a condition based deletion of multiple geo locations.

Implements ilGeoLocationRepository.

Definition at line 177 of file ilGeoLocationFileMockRepository.php.

    {
        // Read all geo locations from file
        $file = fopen('mocked_geolocation_data.txt', 'r');
        $geo_locations = $this->readFileAndReturnAsList($file);
        fclose($file);
 
        // Filter out expired objects
        $now = new DateTimeImmutable();
        foreach ($geo_locations as $key => $row) {
            // Check if current row has searched attributes
            if ($row[2] == $a_latitude && $row[3] == $a_longitude) {
                unset($geo_locations[$key]);
            }
        }
 
        // Write objects back to file
        $file = fopen('mocked_geolocation_data.txt', 'w');
        $this->writeGeoLocationListToFile($file, $geo_locations);
        fclose($file);
    }

getGeoLocationById()

ilGeoLocationFileMockRepository::getGeoLocationById

(

int

$a_id

)

Get a single geo location, identified by its id.

Implements ilGeoLocationRepository.

Definition at line 38 of file ilGeoLocationFileMockRepository.php.

                                                  : ilGeoLocation
    {
        $file = fopen('mocked_geolocation_data.txt', 'r');
 
        // Go line by line through the file and return object if it was found
        while ($row = fgetcsv($file)) {
            if ($row[0] == $a_id) {
                return new ilGeoLocation((int) $a_id, $row[1], (float) $row[2], (float) $row[3], new DateTimeImmutable($row[4]));
            }
        }
 
        throw new \InvalidArgumentException("Unknown id for geolocation: $a_id");
    }

getGeoLocationsByCoordinates()

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

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

Implements ilGeoLocationRepository.

Definition at line 55 of file ilGeoLocationFileMockRepository.php.

                                                                                        : array
    {
        $file = fopen('mocked_geolocation_data.txt', 'r');
        $geo_locations = array();
 
        // Go line by line through the file and add searched objects to list
        while ($row = fgetcsv($file)) {
            if ($row[2] == $a_latitude && $row[3] == $a_longitude) {
                $geo_locations[] = new ilGeoLocation((int) $row[0], $row[1], (float) $row[2], (float) $row[3], new DateTimeImmutable($row[4]));
            }
        }
 
        return $geo_locations;
    }

ifAnyGeoLocationExistsByCoordinates()

ilGeoLocationFileMockRepository::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 91 of file ilGeoLocationFileMockRepository.php.

                                                                                               : bool
    {
        $file = fopen('mocked_geolocation_data.txt', 'r');
 
        // Go line by line through the file and search for given attributes
        while ($row = fgetcsv($file)) {
            if ($row[2] == $a_latitude && $row[3] == $a_longitude) {
                return true;
            }
        }
 
        return false;
    }

ifGeoLocationExistsById()

ilGeoLocationFileMockRepository::ifGeoLocationExistsById

(

int

$a_id

)

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

Implements ilGeoLocationRepository.

Definition at line 73 of file ilGeoLocationFileMockRepository.php.

                                                       : bool
    {
        $file = fopen('mocked_geolocation_data.txt', 'r');
 
        // Go line by line through the file and search for given id
        while ($row = fgetcsv($file)) {
            if ($row[0] == $a_id) {
                return true;
            }
        }
 
        return false;
    }

readFileAndReturnAsList()

ilGeoLocationFileMockRepository::readFileAndReturnAsList (   $file )

protected

Protected function.

Just for development purpose

Definition at line 229 of file ilGeoLocationFileMockRepository.php.

    {
        $geo_locations = array();
        while ($row = fgetcsv($file)) {
            $geo_locations[] = $row;
        }
        return $geo_locations;
    }

updateGeoLocation()

ilGeoLocationFileMockRepository::updateGeoLocation

(

ilGeoLocation

$a_obj

)

Update all attributes of a given geo location.

Implements ilGeoLocationRepository.

Definition at line 108 of file ilGeoLocationFileMockRepository.php.

    {
        // Read entire file
        $file = fopen('mocked_geolocation_data.txt', 'r');
        $geo_locations = $this->readFileAndReturnAsList($file);
        fclose($file);
 
        // Update searched object in list
        foreach ($geo_locations as $key => $row) {
            if ($row[0] == $a_obj->getId()) {
                $row[1] = $a_obj->getTitle();
                $row[2] = $a_obj->getLatitude();
                $row[3] = $a_obj->getLongitude();
                $row[4] = $a_obj->getExpirationAsTimestamp();
            }
        }
 
        // Write back all geo locations to file
        $file = fopen('mocked_geolocation_data.txt', 'w');
        $this->writeGeoLocationListToFile($file, $geo_locations);
        fclose($file);
    }

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

Here is the call graph for this function:

updateGeoLocationTimestampByCoordinates()

ilGeoLocationFileMockRepository::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 134 of file ilGeoLocationFileMockRepository.php.

    {
        // Read entire file
        $file = fopen('mocked_geolocation_data.txt', 'r');
        $geo_locations = $this->readFileAndReturnAsList($file);
        fclose($file);
 
        // Update searched objects in list
        foreach ($geo_locations as $key => $row) {
            if ($row[2] == $a_searched_latitude && $row[3] == $a_searched_longitude) {
                $row[4] = $a_update_timestamp->getTimestamp();
            }
        }
 
        // Write back all geo locations to file
        $file = fopen('mocked_geolocation_data.txt', 'w');
        $this->writeGeoLocationListToFile($file, $geo_locations);
        fclose($file);
    }

writeGeoLocationListToFile()

ilGeoLocationFileMockRepository::writeGeoLocationListToFile (   $file,   $list  )

protected

Protected function.

Just for development purpose

Definition at line 241 of file ilGeoLocationFileMockRepository.php.

    {
        foreach ($list as $obj_data) {
            // implode(';', $list) . "\n"; // <- this way might also work
            $write_string = $obj_data[0] . ';' . $obj_data[1] . ';' . $obj_data[2] . ';' . $obj_data[3] . ';' . $obj_data[4] . "\n";
            fwrite($file, $write_string . "\n");
        }
    }

---

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

• docs/development/code-examples/repository-pattern/02_mock_for_developement/ilGeoLocationFileMockRepository.php