Download the PHP package domos/schema without Composer
On this page you can find all versions of the php package domos/schema. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package schema
Short Description Not ready for public use. domos/schema is the reference implementation of the domos real estate data schema written in PHP.
License proprietary
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package schema
domos/schema
© 2024 domos GmbH
[!WARNING] Not ready for public use yet. API surface is subject to change.
domos/schema is the reference implementation of the domos real estate data schema written in PHP.
Schema Documentation
Table of Contents
- Introduction
- Accessing Estate Data in WordPress
- Finding an Estate
- Accessing Estate Data in WordPress Templates
- Finding Multiple Estates
- Important Notes for Website Building
- Estate Management Operations (Internal Use)
- Core Models
- Estate
- Building
- Rentable
- Location Models
- Address
- Coordinates
- Location
- Media Models
- Image
- Media
- Video
- Scan
- CameraFeed
- Financial Models
- Money
- Price
- Web Expose Models
- WebExpose
- Block
- Utility Models
- Contact
- Certifications
Introduction
This document provides a comprehensive overview of the real estate data schema implemented in PHP. The schema is designed to represent various aspects of real estate properties, including buildings, rentable spaces, locations, media assets, and web exposures. It uses modern PHP features such as typed properties, enums, and interfaces to create a robust and flexible system for managing real estate data.
Accessing Estate Data in WordPress
The EstatePost class provides a bridge between the Estate data schema and WordPress, allowing you to retrieve and display estate information stored as WordPress posts. This section explains how to use the EstatePost class to access estate data within a WordPress environment, focusing on tasks relevant to building websites.
Finding an Estate
To retrieve an estate by its external ID:
Accessing Estate Data in WordPress Templates
When working with estate data in WordPress templates, you can use the EstatePost::fromPost() method to get the estate data from the current post:
This example demonstrates how to access and display various aspects of the estate data within a WordPress template.
Finding Multiple Estates
To retrieve multiple estates, you can use WordPress's WP_Query class in combination with EstatePost::fromPost():
This example shows how to query for multiple estates and display basic information for each.
Estate Management Operations (Internal Use)
The following operations are primarily for internal use and data management:
- Creating a new estate:
EstatePost::create($externalId, $estateData) - Updating an existing estate:
EstatePost::update($externalId, $updatedEstateData) - Deleting an estate:
EstatePost::delete($externalId) - Finding unneeded estates:
EstatePost::findUnneeded($activeIds)
These methods should be used with caution and typically within administrative interfaces or background processes, rather than in public-facing website code.
By using the EstatePost class, you can seamlessly integrate the real estate data schema with WordPress, allowing for easy retrieval and display of complex estate information on your WordPress site.
Core Models
Estate
The Estate class is the central model representing a real estate property.
| Property | Type | Description |
|---|---|---|
| id | string | Unique identifier |
| slug | string | URL-friendly identifier |
| name | string | Name of the estate |
| address | Address | Physical address of the estate |
| features | array | List of features and amenities |
| buildings | array | List of Building objects within the estate |
| texts | Texts | Descriptive content about the estate |
| media | Media | Images, videos, and 3D scans related to the estate |
| location | Location | Geographical location and nearby places |
| certifications | Certifications | Environmental and quality certifications |
| social | Social | Social media and contact information |
| expose | ?WebExpose | Web-based property exposure data |
Usage:
Building
The Building class represents a specific building within an estate.
| Property | Type | Description |
|---|---|---|
| id | string | Unique identifier |
| name | ?string | Name of the building |
| address | ?Address | Physical address of the building |
| area | ?float | Total area of the building in square meters |
| media | Media | Images, videos, and 3D scans related to the building |
| features | array | List of features and amenities specific to the building |
| rentables | array | List of Rentable spaces within the building |
Usage:
Rentable
The Rentable class represents a space that can be rented or sold within a building.
| Property | Type | Description |
|---|---|---|
| id | string | Unique identifier |
| name | ?string | Name of the rentable space |
| area | ?float | Area of the space in square meters |
| description | ?string | Detailed description of the space |
| transaction_type | TransactionType | Type of transaction (Rent or Sale) |
| price | ?Price | Pricing information for the space |
| spaces | array | List of Space objects within the rentable area |
| features | array | List of features and amenities specific to the rentable space |
| media | Rentable\Media | Images, videos, and 3D scans related to the rentable space |
Usage:
Location Models
Address
The Address class represents a physical address.
| Property | Type | Description |
|---|---|---|
| street | string | Street name |
| number | ?string | Street number |
| postal_code | ?string | Postal code |
| city | ?string | City name |
| country | ?string | Country code |
| coordinates | ?Coordinates | Geographical coordinates of the address |
| label | ?string | Custom label for the address |
Usage:
Coordinates
The Coordinates class represents geographic coordinates.
| Property | Type | Description |
|---|---|---|
| latitude | float | Latitude value |
| longitude | float | Longitude value |
Usage:
Location
The Location class represents the location of an estate, including nearby places.
| Property | Type | Description |
|---|---|---|
| places | array | List of nearby Place objects |
Usage:
Media Models
Image
The Image class represents an image asset.
| Property | Type | Description |
|---|---|---|
| src | string | Source URL of the image |
| alt | ?string | Alternative text for accessibility |
Usage:
Media
The Media class represents a collection of media assets for an estate.
| Property | Type | Description |
|---|---|---|
| thumbnail | ?Image | Thumbnail image for the estate |
| gallery | array | Collection of Image objects |
| logo | ?Image | Logo image for the estate |
| videos | array | Collection of Video objects |
| scans | array | Collection of Scan objects |
Usage:
Video
The Video class represents a video asset.
| Property | Type | Description |
|---|---|---|
| id | ?string | Unique identifier for the video |
| type | Video\Type | Type of video (e.g., Embed, Direct) |
| thumbnail_url | ?string | URL of the video thumbnail image |
Usage:
Scan
The Scan class represents a 3D scan or virtual tour.
| Property | Type | Description |
|---|---|---|
| id | ?string | Unique identifier for the scan |
| type | Scan\Type | Type of scan (e.g., Embed) |
| provider | ?string | Name of the scan provider |
Usage:
CameraFeed
The CameraFeed class represents a live camera feed.
| Property | Type | Description |
|---|---|---|
| id | ?string | Unique identifier for the camera feed |
| type | CameraFeed\Type | Type of camera feed (e.g., Embed) |
| provider | ?string | Name of the camera feed provider |
Usage:
Financial Models
Money
The Money class represents a monetary value.
| Property | Type | Description |
|---|---|---|
| amount | float | Numeric amount |
| currency | Currency | Currency of the amount |
Usage:
Price
The Price class represents the price of a rentable space.
| Property | Type | Description |
|---|---|---|
| base | Money | Base price |
| extra_costs | ?Money | Additional costs |
Usage:
Web Expose Models
WebExpose
The WebExpose class represents the structure for web-based property exposure.
| Property | Type | Description |
|---|---|---|
| sidebar_features | array | Features to display in the sidebar |
| pool_features | array | Features to display in the pool section |
| blocks | array | List of content Block objects |
Usage:
Block
The Block class is an abstract base class for various types of content blocks in the web expose.
| Property | Type | Description |
|---|---|---|
| id | ?string | Unique identifier for the block |
| type | BlockType | Type of the content block |
Usage (example with TextBlock):
Utility Models
Contact
The Contact class represents contact information.
| Property | Type | Description |
|---|---|---|
| name | string | Name of the contact |
| role | ?string | Role or position of the contact |
| ?string | Email address | |
| phone | ?string | Phone number |
| mobile | ?string | Mobile number |
| avatar | ?Image | Avatar image of the contact |
| address | ?Address | Physical address of the contact |
Usage:
Certifications
The Certifications class represents various certifications for an estate.
| Property | Type | Description |
|---|---|---|
| dgnb | ?DGNBCertification | DGNB (German Sustainable Building Council) certification level |
| co2_neutral | ?bool | Indicates if the estate is CO2 neutral |
Usage:
