Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: refactor URL expansion into a controller trait #351

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

build: refactor URL expansion into a controller trait #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e5469d
build: refactor URL expansion into a controller trait
Sasszem Jan 21, 2020
9031ec5
build: add code coverage ignore rule
Sasszem Jan 21, 2020
05c1605
fix: default disk for PublicUrl trait
Sasszem Jan 26, 2020
d7c6446
Merge branch 'master' into issue235
Sasszem Jan 26, 2020
d4d28f3
Revert "fix: default disk for PublicUrl trait"
Sasszem Jan 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions app/Http/Controllers/ColleaguesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@

class ColleaguesController extends Controller
{
use PublicUrl;
const DISK = 'colleagues_images';

public function listColleagues(Request $request)
{
$colleagues = Colleagues::orderBy('name')->get();
Expand All @@ -20,11 +23,6 @@ public function listColleagues(Request $request)
return $colleagues;
}

private static function _publicUrl($file, $disk = 'colleagues_images')
{
return asset(\Storage::disk($disk)->url($file));
}

private static function _expandUrls($colleague)
{
if ($colleague instanceof Colleagues) {
Expand Down
7 changes: 2 additions & 5 deletions app/Http/Controllers/PostsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ class PostsController extends Controller
{
_after as _after_original;
}
use PublicUrl;
const DISK = 'posts_images';
const PAGESIZE = 20;

public function byId(Request $request)
Expand Down Expand Up @@ -210,11 +212,6 @@ private static function _expandUrls($post)
return $post;
}

private static function _publicUrl($file, $disk = 'posts_images')
{
return asset(\Storage::disk($disk)->url($file));
}

private static function _makeThumbnail($posts, $enabled = true)
{
$result = $posts->paginate(self::PAGESIZE);
Expand Down
14 changes: 14 additions & 0 deletions app/Http/Controllers/PublicUrl.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace App\Http\Controllers;

/**
* @codeCoverageIgnore
*/
trait PublicUrl
{
private static function _publicUrl($file, $disk = self::DISK)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole code works, my only concern here is that nothing enforces the class using this trait to have a DISK property. Do you have any better idea how to enforce the consuming class to have the property this needs? If not feel free to merge this PR as is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, defining a property in the trait would be the best, if we could override it - sadly, it is not simply possible...
https://stackoverflow.com/questions/32571920/overriding-doctrine-trait-properties
I think I might be able to move the trait usage into the controller base class, which I subclass in every other controller...

Copy link
Contributor Author

@Sasszem Sasszem Jan 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about that instead?
A default for a default...
Nope, it won't work, as we will still get an error due to constant self::DISK not existing.
I do not see any nice way to solve this, but I do not think that it is a big issue.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, then feel free to merge this

{
return asset(\Storage::disk($disk)->url($file));
}
}