flexcodesnet / emlakplatform
Emlak Platform Laravel Package
README
A Laravel package designed to simplify real estate platform integrations by providing flexible and reusable features.
API Documentation
You can explore the API documentation using Postman:
Alternatively, visit the documentation directly: API Documentation
Installation
You can install the package via composer:
composer require flexcodesnet/emlakplatform
Publish the package's configuration file:
php artisan vendor:publish --tag="emlak-platform"
Configuration
After publishing the configuration file, you can customize it in config/emlak-platform.php to match your application's requirements.
Usage
Important Note
To use any method you should include the Emlak PLatform Facade Class
use EmlakPlatform;
Functions
1. currencies()
Description: Fetches the list of available currencies from the API.
Example:
use EmlakFacade;
$currencies = EmlakFacade::currencies();
2. cities()
Description: Retrieves the list of cities available in the platform.
Example:
use EmlakFacade;
$cities = EmlakFacade::cities();
3. sitemap($query)
Description: Fetches the sitemap from the API based on the provided query parameters.
Example:
use EmlakFacade;
$query = ['type' => 'properties'];
$sitemap = EmlakFacade::sitemap($query);
4. propertiesFiltersQuery($query)
Description: Fetches property filters based on the given query parameters.
Example:
use EmlakFacade;
$query = ['city' => 'Beirut', 'type' => 'apartment'];
$filters = EmlakFacade::propertiesFiltersQuery($query);
5. places($query = [])
Description: Fetches a list of places based on the query parameters.
Example:
use EmlakFacade;
$query = ['city' => 'Beirut'];
$places = EmlakFacade::places($query);
6. preparePropertiesFilter($query = [])
Description: Prepares property filters based on the given query.
Example:
use EmlakFacade;
$query = ['city' => 'Beirut'];
$preparedFilters = EmlakFacade::preparePropertiesFilter($query);
7. prepareAdvancedPropertiesFilterApi($query = [])
Description: Fetches advanced property filters based on the query.
Example:
use EmlakFacade;
$query = ['city' => 'Beirut', 'budget' => '200000-500000'];
$advancedFilters = EmlakFacade::prepareAdvancedPropertiesFilterApi($query);
8. resales($page = 1, $query = [])
Description: Retrieves resale properties with pagination.
Example:
use EmlakFacade;
$query = ['city' => 'Beirut'];
$resales = EmlakFacade::resales(2, $query); // Fetch page 2
9. lands($page = 1, $query = [])
Description: Fetches land properties with pagination.
Example:
use EmlakFacade;
$query = ['size' => '500-1000'];
$lands = EmlakFacade::lands(1, $query); // Fetch page 1
10. projects($page = 1, $query = [])
Description: Retrieves project properties with pagination.
Example:
use EmlakFacade;
$query = ['status' => 'ongoing'];
$projects = EmlakFacade::projects(1, $query); // Fetch page 1
11. project($slug)
Description: Fetches detailed information about a specific project by its slug.
Example:
use EmlakFacade;
$slug = 'luxury-villas';
$project = EmlakFacade::project($slug);
12. resale($slug)
Description: Retrieves detailed information about a specific resale property by its slug.
Example:
use EmlakFacade;
$slug = 'beachside-apartment';
$resale = EmlakFacade::resale($slug);
13. land($slug)
Description: Fetches detailed information about a specific land property by its slug.
Example:
use EmlakFacade;
$slug = 'hillside-land';
$land = EmlakFacade::land($slug);
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Contributions are welcome! Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.