Foreign table joins by relation name alias

Author: sleeping-owl

CHANGELOG

@@ -1,6 +1,16 @@
 CHANGELOG
 =========
 
+2014-11-13, v1.0.1
+------------------
+
+* Foreign table joins by relation name alias:
+	```
+		Model::include('street')->where('street.id', '=', $id);
+		Model::include('street.type')->orderBy('type.id', 'asc');
+	```
+
+
 2014-11-12, v1.0.0
 ------------------
 

README.md

@@ -9,13 +9,48 @@ Model::with('other')->references('other')->orderBy('other.title', 'asc')->get();
  # this will make one sql-query with left join of 'other' relation
  # result object will be the same object
 
-Model::includes('other', 'another')->where('other.title', '=', 'my title')->get();
- # will be the same as Model::with('other', 'another')->references('other', 'another')->…
+Model::includes('first', 'second')->where('first.title', '=', 'my title')->get();
+ # will be the same as Model::with('first', 'second')->references('first', 'second')->…
 
-Model::with('other')->orderBy('field', 'asc')->get();
+Model::with('foreign')->orderBy('field', 'asc')->get();
  # this will work with default behaviour (perform 2 sql-queries)
 ```
 
+### Example
+
+#### New Behaviour
+
+```php
+StreetImage::includes('street')->first()
+```
+
+will perform the following sql-query:
+
+```sql
+select 
+	`street`.`<…>` as `__f__street.<…>`, 
+	`street_images`.* 
+from 
+	`street_images` 
+left join 
+	`streets` as `street` on `street`.`id` = `street_images`.`street_id` 
+order by `sort` asc 
+limit 1
+```
+
+#### Default Behaviour
+
+```php
+StreetImage::with('street')->first()
+```
+
+will perform the following sql-queries:
+
+```sql
+select `street_images`.* from `street_images` order by `sort` asc limit 1
+select `streets`.* from `streets` where `streets`.`id` in (?) order by `title` asc
+```
+
 ### Object Structure
 
 You will get the same object if you will use `includes()` method. For example:
@@ -64,20 +99,20 @@ StreetImage::includes('street.type', 'street.district')->first();
 will perform a following sql-query (*<…> will be replaced with all table columns*):
 
 ```sql
-select
-	`streets`.`<…>` as `_foreign_street.<…>`, 
-	`street_types`.`<…>` as `_foreign_street._foreign_type.<…>`, 
-	`districts`.`<…>` as `_foreign_street._foreign_district.<…>`, 
-	`street_images`.* 
+select 
+	`street`.`<…>` as `__f__street.<…>`,
+	 `type`.`<…>` as `__f__street.__f__type.<…>`,
+	 `district`.`<…>` as `__f__street.__f__district.<…>`,
+	 `street_images`.* 
 from 
 	`street_images` 
 left join 
-	`streets` on `streets`.`id` = `street_images`.`street_id` 
+	`streets` as `street` on `street`.`id` = `street_images`.`street_id` 
 left join 
-	`street_types` on `street_types`.`id` = `streets`.`street_type_id` 
+	`street_types` as `type` on `type`.`id` = `street`.`street_type_id` 
 left join 
-	`districts` on `districts`.`id` = `streets`.`district_id` 
-order by `sort` asc
+	`districts` as `district` on `district`.`id` = `street`.`district_id` 
+order by `sort` asc 
 limit 1
 ```
 instead of performing 4 sql-queries by default Eloquent behaviour:

composer.json

@@ -1,22 +1,28 @@
 {
-    "name": "sleeping-owl/with-join",
-    "description": "Package to convert Eloquent BelongsTo subqueries into one query with left join.",
-	"keywords": ["laravel", "activerecord", "eloquent", "with", "join"],
+	"name": "sleeping-owl/with-join",
+	"description": "Package to convert Eloquent BelongsTo subqueries into one query with left join.",
+	"keywords": [
+		"laravel",
+		"activerecord",
+		"eloquent",
+		"with",
+		"join"
+	],
 	"license": "MIT",
-    "authors": [
-        {
-            "name": "Sleeping Owl",
-            "email": "owl.sleeping@yahoo.com"
-        }
-    ],
-    "require": {
-        "php": ">=5.4.0",
-        "illuminate/support": "4.2.*"
-    },
-    "autoload": {
-        "psr-0": {
-            "SleepingOwl\\WithJoin": "src/"
-        }
-    },
-    "minimum-stability": "stable"
+	"authors": [
+		{
+			"name": "Sleeping Owl",
+			"email": "owl.sleeping@yahoo.com"
+		}
+	],
+	"require": {
+		"php": ">=5.4.0",
+		"illuminate/support": "4.2.*"
+	},
+	"autoload": {
+		"psr-0": {
+			"SleepingOwl\\WithJoin": "src/"
+		}
+	},
+	"minimum-stability": "stable"
 }

src/SleepingOwl/WithJoin/WithJoinEloquentBuilder.php

@@ -3,9 +3,16 @@
 use Cache;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\Relation;
 
 class WithJoinEloquentBuilder extends Builder
 {
+
+	/**
+	 * @var string
+	 */
+	public static $prefix = '__f__';
+
 	/**
 	 * @var array
 	 */
@@ -46,8 +53,9 @@ protected function isNestedRelation($relation)
 
 	/**
 	 * @param $name
+	 * @param Relation $relation
 	 */
-	protected function addNestedRelations($name, BelongsTo $relation)
+	protected function addNestedRelations($name, Relation $relation)
 	{
 		$nestedRelations = $this->nestedRelations($name);
 		if (count($nestedRelations) <= 0) return;
@@ -56,23 +64,41 @@ protected function addNestedRelations($name, BelongsTo $relation)
 		foreach ($nestedRelations as $nestedName => $nestedConstraints)
 		{
 			$relation = $class->$nestedName();
-			$this->addJoinToQuery($nestedName, $class->getTable(), $relation, $name . '._foreign_');
+			$this->addJoinToQuery($nestedName, $name, $relation, $name . '.' . static::$prefix);
 		}
 	}
 
 	/**
-	 * @param $name
-	 * @param BelongsTo $relation
+	 * @param $joinTableAlias
+	 * @param $currentTableAlias
+	 * @param BelongsTo|Relation $relation
+	 * @param string $columnsPrefix
 	 */
-	protected function addJoinToQuery($name, $currentTable, BelongsTo $relation, $prefix = '')
+	protected function addJoinToQuery($joinTableAlias, $currentTableAlias, Relation $relation, $columnsPrefix = '')
 	{
-		$foreignTable = $relation->getRelated()->getTable();
-		$columns = $this->getColumns($foreignTable);
-		$this->query->leftJoin($foreignTable, $foreignTable . '.' . $relation->getOtherKey(), '=', $currentTable . '.' . $relation->getForeignKey());
+		$joinTableName = $relation->getRelated()->getTable();
+
+		$joinTable = implode(' as ', [
+			$joinTableName,
+			$joinTableAlias
+		]);
+		$joinLeftCondition = implode('.', [
+			$joinTableAlias,
+			$relation->getOtherKey()
+		]);
+		$joinRightCondition = implode('.', [
+			$currentTableAlias,
+			$relation->getForeignKey()
+		]);
+
+		$this->query->leftJoin($joinTable, $joinLeftCondition, '=', $joinRightCondition);
+
+		$columns = $this->getColumns($joinTableName);
+		$prefix = static::$prefix . $columnsPrefix . $joinTableAlias . '.';
 		foreach ($columns as $column)
 		{
-			$this->selectFromQuery($foreignTable, $column, '_foreign_' . $prefix . $name . '.' . $column);
-		};
+			$this->selectFromQuery($joinTableAlias, $column, $prefix . $column);
+		}
 	}
 
 	/**

src/SleepingOwl/WithJoin/WithJoinTrait.php

@@ -13,7 +13,7 @@ trait WithJoinTrait
 	public function newFromBuilder($attributes = [])
 	{
 		$attributes = (array) $attributes;
-		$prefix = '_foreign_';
+		$prefix = WithJoinEloquentBuilder::$prefix;
 		$foreignData = [];
 		foreach ($attributes as $key => $value)
 		{