I have 4 models that are relevant.
Company
Location
Customer
ThirdPartyLinkClick
Company.php
public function locations() {
return $this->hasMany('App\Location');
}
Location.php
public function customers() {
return $this->hasMany('App\Customer');
}
public function linkClicks() {
return $this->hasManyThrough('App\ThirdPartyLinkClick', 'App\Customer');
}
Customer.php
public function linkClicks() {
return $this->hasMany('App\ThirdPartyLinkClick');
}
There is no issue when acquiring the count of link clicks for all customers when on a single Location.
I can simply do: $this->linkClicks->count(); which creates a query where it does a WHERE IN (1,2,3,4, etc) query
However, on a Company page, I want to also get this count, but avoid an n+1
Right now, my model method on Company.php is
public function getTotalClicksToReviewSites() {
$locations = $this->locations;
$clicks = 0;
foreach ($locations as $location) {
$clicks += $location->linkClicks->count();
}
return $clicks;
}
This creates duplicate queries where it checks location_id on each query. There will be a query for every location rather than checking a group of id's in a WHERE IN statement.
How can I do an eloquent query that will use a single query to gather this data? I only need the count.
You need to use eager loading.
$companies = Company::with('locations', 'locations.linkClicks')->get();
This prevents n + 1 query problem, so, to get te total of linkClicks for each company youur function will work or simply you can do.
$companies = Company::with('locations', 'locations.linkClicks')
->get()
->map(function ($company) {
$company->linkClicksCount = $company->locations->sum(function ($location) {
return $location->linkClicks->count();
});
return $company;
});
The output should be something like this (a new property linkClicksCount added on each company).
[
{"id": 1, "name": "Company 1", "linkClicksCount": 9, "locations": [], ...},
{"id": 2, "name": "Company 2", "linkClicksCount": 3, "locations": [], ...},
...
]
Related
I want to get all projects, and foreach project I want to get a property for example is_liked which indicates that if the current_user (I've his Id) has liked this project or not.
User Model
class User extends Model
{
public function projects()
{
return $this->hasMany(Project::class);
}
public function favorite_projects()
{
return $this->belongsToMany(Project::class, 'favorite_projects', 'user_id', 'project_id')->withTimestamps();
}
}
Project Model
class Project extends Model
{
public function user()
{
return $this->belongsTo(User::class);
}
}
User Table
- id
- name
Project Table
- id
- user_id
- title
favorite_projects table
- user_id
- project_id
What is the best way to get this done ? the data I want to get is something like this:
[
{
"id": 1,
"user_id": 3,
"title": "my title",
"is_liked": true
}
]
Note: the current_user->id might or might not be same as the project->user_id.
$projects = DB::table('projects')
->join('favorite_projects', 'favorite_projects.project_id', '=', 'projects.id')
->select('projects.*', 'favorite_projects.*')
->where('projects.user_id', Auth::id())
->get();
This join statement allows you to join 2 tables together and for each project that is being favorited by the user, you will see the favorite record attached with the record.
Perform a dd($projects) after that SQL query and see what the result is like, and then for each result, you set $project['is_liked'] accordingly.
To keep it simple, let's take an example of stackoverflow's questions page where there is a paginated list of questions and each question has some tags attached to it.
A Tag model is in Many to Many relation with Question model i.e.
A tag can be assigned to many questions.
A question can be assigned to many tags.
For this relation I created an relational model named QuestionTag (and table for it) that has the relation with both Tag and Question. Then I used laravel's hasManyThrough relation to get a list of tags assigned to a question through the QuestionTag model as such:
class QuestionTag extends Model
{
public function question()
{
return $this->belongsTo(Question::class, 'question_id', 'id');
}
public function tag()
{
return $this->belongsTo(Tag::class, 'tag_id', 'id');
}
}
class Question extends Model
{
public function tags()
{
return $this->hasManyThrough(Tag::class, QuestionTag::class, 'question_id', 'id', 'id', 'tag_id');
}
}
And I created QuestionResource for returning the expected paginated results of questions as such:
QuestionResource
class QuestionResource extends JsonResource
{
public function toArray($request)
{
return [
'id' => $this->id,
'subject' => $this->subject,
'body' => $this->body,
'tags' => $this->tags // this will call the has many through relations as expected.
];
}
}
Result
{
"current_page": 1,
"data": [
{
"id": 1,
"subject": "Lorem ipsum dolor sir amet!",
"body": "...",
tags: [
{
"id": 1,
"name": "tag1",
},
// ...and so on
]
},
// ...and so on
],
"first_page_url": "http://127.0.0.1:8000/uv1/questions?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://127.0.0.1:8000/uv1/questions?page=1",
"next_page_url": null,
"path": "http://127.0.0.1:8000/uv1/questions",
"per_page": "15",
"prev_page_url": null,
"to": 5,
"total": 5
}
At last, on the index function, I returned the paginated list of questions from the QuestionController's index function as such:
public function index(Request $request)
{
$perPage = $request->input('perPage') ?? 15;
// execute the query.
$crawlers = Question::paginate($perPage);
return QuestionResource::collection($crawlers);
}
It returned what I wanted but when I increased the per_page size to 100 or more, it is returning this error:
Allowed memory size of 134217728 bytes exhausted (tried to allocate 20480 bytes)
I found many solutions that suggests to increase the memory in php.ini(memory_limit = 2048M) but it feels like we are bruteforcing to acheive the outcome. There will be some point when again the memory_limit will fail to return the same when I keep on increasing the per_page size.
Is there any optimal way in laravel to get the same expected result(instead of above mentioned error) with the desired output without increasing the memory size?
I used Inner Join to achieve this and used MySQL's JSON_ARRAYAGG(JSON_OBJECT()) along with it in SELECT statement to create a concatenated json string of tags and later convert it to json array using php json_decode(). Little tacky but it returned the result fast and I could load thousands of records within milliseconds.
My QuestionController now looks like this:
public function index(Request $request)
{
$perPage = $request->input('perPage') ?? 15;
// execute the query.
$crawlers = Question::query()
->select(['questions.*', DB::raw('JSON_ARRAYAGG(JSON_OBJECT("id", `tags`.`id`, "name", `tags`.`name`)) AS `tags`')])
->join('question_tags', 'questions.id', 'question_tags.question_id')
->join('tags', 'question_tags.tag_id', 'tags.id')
->groupBy('questions.id')
->paginate($perPage);
return QuestionResource::collection($crawlers);
}
And I removed the join relations from the models and changed my QuestionResource as such:
class QuestionResource extends JsonResource
{
public function toArray($request)
{
return [
'id' => $this->id,
'subject' => $this->subject,
'body' => $this->body,
'tags' => json_decode($this->tags ?? '[]', false, 512, JSON_THROW_ON_ERROR), // convert string JSON to array
];
}
}
Currently, I've implemented this approach but I'm still open to better solutions. :)
I want this object only if it has all the necessary relationships.
At the moment my code:
StudentController
$student = Student::with('inscriptions','inscriptions.classroom')
->find($request->user()->id);
Student
public function inscriptions()
{
return $this->hasMany('App\InscribedStudent');
}
InscribedStudent - Note: "Registration Open"
public function classroom()
{
return $this->hasOne('App\Classroom', 'id')->where('registration_open', true);
}
Json Return When haven't registration opened
{
"inscriptions": [
{
"id": 1,
"student_id": 1,
"classroom_id": 1,
"deleted_at": null,
"created_at": "2019-07-04 23:34:48",
"updated_at": "2019-07-04 23:34:48",
"classroom": null
}
]
}
I want to do something like that, because I don't need the object InscribedStudent if I haven't a classroom.
public function inscriptions()
{
return $this->hasMany('App\InscribedStudent')
->hasOne('App\Classroom', 'id')
->where('registration_open', true);
}
You can use has() or whereHas() to check that the classroom exists.
https://laravel.com/docs/5.8/eloquent-relationships#querying-relationship-existence
// this will only get students that have a classroom through inscriptions
$students = Student::has('incriptions.classroom')
->with('inscriptions.classroom')
->get();
// this will get students, but only fetch inscriptions if there is a classroom
$students = Student::with(['inscriptions' => function($inscriptionQuery) {
$inscriptionQuery->has('classroom')->with('classroom');
}])
->get();
You can also make a custom scope on the Student model if you want to use that instead.
// this will only get students that have a classroom through inscriptions
public function scopeHasClassroom($query)
{
$query->has('inscriptions.classroom')
->with('inscriptions.classroom');
}
// this will get students, but only fetch inscriptions if there is a classroom
public function scopeHasClassroom($query)
{
$query->with(['inscriptions' => function($inscriptionQuery) {
$inscriptionQuery->has('classroom')->with('classroom');
}]);
}
Then you can call the custom scope like this:
$students = Student::hasClassroom()->get();
https://laravel.com/docs/5.8/eloquent#query-scopes
I'm building an api using eager loading so i can simply return the user model with its deep relations and it automatically be converted as json. Here's the set up.
users
id
..
clients
id
..
user_clients
id
user_id
client_id
..
campaigns
id
..
client_campaigns
id
client_id
campaign_id
..
campaign_activities
id
campaign_id
..
client_campaign_activity_templates
id
campaign_activity_id
client_id *(templates are unique per client)*
..
I've setup the models' relationships.
User
public function clients() {
return $this->belongsToMany('App\Client','user_clients');
}
Client
public function campaigns() {
return $this->belongsToMany('App\Campaign','client_campaigns');
}
Campaign
public function activities() {
return $this->hasMany('App\CampaignActivity');
}
CampaignActivity
public function templates() {
return $this->hasMany('App\ClientCampaignActivityTemplate')
}
I have a simple api endpoint to provide a JSON of a User object including its deep relations using eager loading.
public function getLoggedInUser(Request $request) {
return \App\User::with('clients.campaigns.activities.templates')->find($request->user()->id);
}
Testing this using postman, I can get the user including its deep relations.
{
"user": {
"id": 1,
"name": "user1",
"clients": [
{
"id": 1,
"name": "client1",
"campaigns": [
{
"id": 1,
"name": "campaign1",
"activities": [
{
"id": 1,
"name": "activity1",
"templates": [
{
"id": 1,
"name": "template1 for client1",
"client_id": 1,
"body": "this is a template.",
}, {
"id": 2,
"name": "template1 for client2",
"client_id": 2,
"body": "This is a template for client2"
}
]
}, {
"id": 2,
"name": "activity2",
"templates": []
}, {
"id": 3,
"name": "activity3",
"templates": []
}
]
}
]
}
]
}
}
However, on the user->clients->campaigns->activities->templates level, it will list all the templates for that activity. I know based on the code of the relationships of the models above that it's supposed to behave like that.
So the question is How would you filter the templates to filter for both campaign_activity_id and client_id?
I've been experimenting on how to filter the templates so it will only list templates for that activity AND for that client as well. I have a working solution but it's N+1, I'd prefer eloquent approach if possible. I've been scouring with other questions, answers and comments for a closely similar problem, but I had no luck, hence I'm posting this one and seek for your thoughts. Thank you
I think what you need are eager loading constraints.
public function getLoggedInUser(Request $request) {
return \App\User::with('clients.campaigns.activities.templates',
function($query) use($request) {
$client_ids = Client::whereHas('users', function($q) use($request){
$q->where('id', $request->user()->id);
})->pluck('id');
$query->whereIn('templates.client_id', $client_ids);
})->find($request->user()->id);
}
Not tested but it should only require one additional query.
What I am doing is: define a constraint for your eager loading, namely only show those templates that have a client_id that is in the list (pluck) of Client IDs with a relation to the User.
Try using closures to filter through related models:
$users = App\User::with([
'clients' => function ($query) {
$query->where('id', $id);
},
'clients.campaigns' => function ($query) {
$query->where('id', $id);
}
])->get();
Here's my working solution, but I'm still interested if you guys have a better approach of doing this.
On the CampaignActivity model, I added a public property client_id and modified the relationship code to
CampaignActivity
public $client_id = 0
public function templates() {
return $this->hasMany('App\ClientCampaignActivityTemplate')->where('client_id', $this->client_id);
}
and on my controller, limit the eager loading to activities only (actually, there are more sqls executed using eager loading[9] in this case vs just iterating[7], and also eager loading doesn't make sense anymore because we're iterating lol)
public function getLoggedInUser(Request $request) {
foreach ($user->clients as $client)
foreach( $client->campaigns as $campaign)
foreach ($campaign->activities as $activity) {
$activity->client_id = $client->id;
$activity->templates; //to load the values
}
return $user;
}
Problem details:
I have three models
a Directorate with id and name fields,
an Employee with id and name fields and
a Telephone with id, tel, employee_id, directorate_id, description and type fields. The employee_id may be nullable, that is there are telephones stored in database with employee_id = null
The models are related as follows:
an employee may have many telephones
a directorate, may have many telephones
class Directorate extends Model
{
public function telephones()
{
return $this->hasMany(Telephone::class);
}
public function employees()
{
return $this->hasMany(Employee::class);
}
}
class Employee extends Model
{
public function telephones()
{
return $this->hasMany(Telephone::class);
}
public function directorate()
{
return $this->belongTo(Directorate::class);
}
}
class Telephone extends Model
{
public function employee()
{
return $this->belongsTo(Employee::class);
}
public function directorate()
{
return $this->belongsTo(Directorate::class);
}
}
Question:
I want to fetch a Collection of all the Telephone models that belong to a specific Directorate, that have employee_id = null and also having their directorate relation eager loaded. In addition, from that resulting collection of Telephone models, I need only some of the models' fields, that is id, tel and description
Tries
What I tried so far was the following:
I created a query scope in the Telephone model:
public function scopeHaveNoEmployeeId($query)
{
return $query->where('telephones.employee_id', '=', null);
}
In my controller
$myTelephones = Telephone::with('directorate')
->haveNoEmployeeId()
->where('directorate_id', $directorateId)
->get(['id', 'tel', 'description']);
However what I am receiving are the requested fields of the filtered models without the relation eager loaded, for instance:
[
{
"id": 79,
"tel": "0648136867",
"directorate": null
},
{
"id": 380,
"tel": "0223796011",
"directorate": null
}
]
I tried also to lazy eager load the relation afterwards but with no luck.
Finally I noticed that if I request all the Telephone models fields, the relation will eager load as I request. For example:
$myTelephones = Telephone::with('directorate')
->haveNoEmployeeId()
->where('directorate_id', $directorateId)
->get();
Then as a result:
[
{
"id": 79,
"tel": "0648136867",
"directorate": {
"id": 23
"name": "Some name"
}
},
{
"id": 380,
"tel": "0223796011",
"directorate": {
"id": 23
"name": "Some name"
}
}
]
Your telephone does not have any relationship with the directorate model.
put this in your Telephone model.
public function directorate()
{
return $this->belongsTo(Directorate::class);
}
Actually, after digging into Laravel's details for a while, I noticed that my initial question was out of context and somewhat silly. I was first eager loaded a relationship and then fatuously I filtered out the relationship by not including it in get() parameters. I had just to do the following:
$myTelephones = Telephone::with('directorate')
->haveNoEmployeeId()
->where('directorate_id', $directorateId)
->get(['id', 'tel', 'description', 'directorate']);