jn-devops/properties

Homeful Properties Package

v1.5.15 2025-03-06 09:18 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^10.0||^11.0
• jn-devops/common: ^1.1
• jn-devops/products: ^1.0
• jn-devops/property: ^1.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• spatie/laravel-ray: ^1.35

MIT

• Lester B. Hurtado

• laravel
• properties
• Homeful

README

Description

The Homeful Property Package is designed to manage real estate properties, including attributes, associated projects, and product mappings. It provides structured data models for properties and projects, enabling efficient data handling for property listings and transactions.

This package provides:

• Property attribute management
• Project association and housing type categorization
• Product SKU linking for inventory tracking
• Market segment classification for property valuation

Features

🏠 Property Management

• Define essential property attributes such as block, lot, phase, and building details
• Assign unit type, floor area, and house specifications (e.g., roof style, veranda, balcony)

🏗 Project Association

• Link properties to specific projects using project codes
• Store project details such as name, location, address, and company affiliation

📦 Product Integration

• Associate properties with product SKUs
• Maintain a direct relationship between properties and inventory management

🏡 Housing & Market Segments

• Categorize properties under different Housing Types (Single Detached, Condominium, etc.)
• Classify properties under Market Segments (Socialized, Economic, etc.)

Installation

To install via Composer, run:

composer require jn-devops/property

Usage

🔹 Creating a Property Instance

use Homeful\Properties\Models\Property;

$property = Property::create([
    'code' => 'PROP001',
    'name' => 'Sample Property',
    'type' => 'Residential',
    'cluster' => 'Cluster A',
    'phase' => 'Phase 1',
    'block' => 'Block 2',
    'lot' => 'Lot 5',
    'floor_area' => 60.0,
    'lot_area' => 80.0,
    'unit_type' => 'Townhouse',
]);

🔹 Associating a Property with a Project

use Homeful\Properties\Models\Project;

$project = Project::create([
    'code' => 'PROJ001',
    'name' => 'Sunrise Estates',
    'location' => 'Sta. Rosa City, Laguna',
    'company_code' => 'RLI'
]);

$property->project()->associate($project);
$property->save();

🔹 Linking a Product SKU

use Homeful\Products\Models\Product;

$product = Product::create([
    'sku' => 'PROD123',
    'name' => 'Modern House Model'
]);

$property->product()->associate($product);
$property->save();

🔹 Retrieving Property Data

use Homeful\Properties\Data\PropertyData;

$propertyData = PropertyData::fromModel($property);

Testing

Run the tests with:

composer test

Author

• Lester B. Hurtado
  Email: [e-mail]
  GitHub: jn-devops

License

This package is open-source software licensed under the MIT License. See the License File for details.