Best posts made by armababy

Okay, this is how i added media to a custom module on creation.

Note: replace <module_name> with your module name

1. Create file <module_name>/Http/apiRoutes.php

2. Add route in apiRoutes.php something that would makes sense for your module dealing with media. Route i created was get('<module_name>/media/file', ['as' => 'api.<module_name>.media.file', 'uses' => 'MediaController@file']);

3. Create file <module_name>/Http/Controllers/Api/MediaController.php add this as content MediaController.php

4. Tell asgard that you added apiRoute.php in <module_name>/Providers/RouteServiceProvider.php in method getApiRoute add return __DIR__ . '/../Http/apiRoutes.php';

5. Create file <module_name>/Resources/views/admin/media/file-link.blade.php add this as content file-link.blade.php this is basically edited file of original Media module copy (we use this only for single(have not done for multiple yet) media on creation after that we'll use Media module) .

6. Include new media file in your create view (usually <module_name>/Resources/views/admin/<entity>/create.blade.php), place this where you want your thumbnail and browse button to appear @include('<module_name>::admin.media.file-link', ['zone' => '<zone_name>']) you can also pass a thumbName if you want anything other than mediaThumb returned along with zone ['zone' => '<zone_name>', 'thumbName' => '<my_custom_thumb_size>'] this basically will display media you choose and store its ID.

7. This step has quite a bit information so i'll try my best to make some sense Once you hit submit you will go to the store method of your controller (assuming you pass all validation in FormRequest). So in the store method we will gather mediaId and zoneId passed by our view on creation and manually link media with entity since by this point we will have entityId.
   So in your EntityController.php (lets say <module_name>/Http/Controllers/Admin/GameControll.php) add relevant parts from here <entity>Controller.php, the main thing is to create your entity before and then link it with media module. I'm sure theres some parts that could be done more elegantly, but this is my development code so.

There's many <module_name>, <entity>, <entity_name> etc. so watch out
Post any questions if in case i forgot something or you didn't get me at some point.

After all of this you can follow official documentation for media module, because nothing changes onEdit and so on.

Value Object in general are usually small immutable class that is used in Domain-Driven Design.
It's usually used to address some sort of primitive work with data and being immutable(no setters) you can only change values on it upon creation, so you can discard it anytime or create new one any time you need.
Kind of hard to explain in full, you'll just have to read it up (this one explains it very good and provides examples DDD VO).

Basically you can do all of this in your controller, but that would be considered bad design.
AsgardCms has similar approach in type of Presenters, basically you can achieve same effect.

Lets say we have module for user profile and we need to do work on email. For one simple function you would use Accessors & Mutators of laravel (for example combine first name and last name).

final class EmailAddress
{
   private $address;

   public function __construct($address)
   {
       if (!filter_var($address, FILTER_VALIDATE_EMAIL)) {
           throw new InvalidArgumentException(sprintf('"%s" is not a valid email', $address));
       }

       $this->address = $address;
   }

   public function __toString()
   {
       return $this->address;
   }

   public function equals(EmailAddress $address)
   {
       return strtolower((string) $this) === strtolower((string) $address);
   }
}

// Allow email only if it's new one
$oldUserEmail = new EmailAdrress('myoldemail@example.com');
$newUserEmail = new EmailAdrress('mynewemail@example.com');
$emailsEqual = $newUserEmail->equals($oldUserEmail); // false

I know it's quite rough, but can be used for many good things.

There's currently no way out of the box.

I did thumbnails on creation for my module, you would probably need to extend blog classes to do that without messing up your future updates.
If you need some info on how i can share with my implementation for custom module.

@cuongdev It does meet filesize requirements?

@cuongdev php as default comes with upload_max_filesize 2M if i recall correctly, no idea how it worked for you

Never used single language project, but you could try by setting hideDefaultLocaleInURL = true in config/laravellocalization.php that would probably redirect all localized urls to nonlocalized.

This has been reported as issue #176

The fix would be to rename $thumbnail variable in Modules/Media/Resources/views/admin/fields/file-link.blade.php to anything that you would not use as zone name. For example mediaThumbSize or whatever until fix has been pushed.

By default for all POST, PUT, or DELETE requests you are required to supply csrf token.
There's couple ways to go about it, but lets do correct one it this situation.

Method 1:
Most obvious would be supply your ajax call with csrf token (chose one of two):

<form>
{{ csrf_field() }}
or
<input type="hidden" name="_token" value="<?php echo csrf_token(); ?>">
</form>

Then you would capture it in your script using name _token:

var _token = $("input[name='_token']").val();

At this point you want to supply _token variable with your ajax data.

$.ajax({
.....
data: {
     '_token': _token,
},
.....
});

Method 2:
If you do a lot of ajax work you could rather store token in main layout of your view in meta tag like:
<meta name="csrf-token" content="{{ csrf_token() }}" />

And then in your script before you invoke ajax:

$.ajaxSetup({
        headers: {
            'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
        }
    });

Now every ajax will include csrf token.

Also there are other ways to deal with it including removing route from csrf middleware or disabling it all together, but those would be last resort ways. More details on CSRF Protection

@DjordjeR Nah just a regular Laravel way of doing it, blade, controllers etc.
There's certain things that some Asgard modules expose to frontend by default that you can use.

For example blog module has PublicController that has view methods for all posts and single post, you can access them by creating view folder blog and blade file index.blade.php and view.blade.php that would allow you to use those in frontend without touching any code.

I guess you would want to scout trough modules that you are interested for frontend and see what view they expect and what variables they present.

You can always browse trough asgardcms.com source code to see any tips and how did nWidart did his frontend.

@motchju Forum uses MarkDown to style things

@deben
Basically you would create backend module, then you create 1 controller in that module for backend(generator will make one for each of your entities - lets say Slider).
From there you just have to integrate media module and any other fields in your CRUD controller.

As Media module only works with already existing data in database, for Create/Store method in your controller you would just create slider - specify any translations, texts, orders, visibility and so on.

In your migrations don't store any information about actuall images, Media module will do that.
After you create your Slider entry you go and integrate Media module in your Edit/Update method
First you would specify relation as described here
Then you would get thumbnails(they are called like that in module but you can ignore name, they just media) in your display method as described here

After those two steps you would use already made functionality of laravel and asgrad to display images, then apply any javascript and styles in your frontend theme.

If you have any specific question i can help you, it's very broad question now. For example what to do in controller etc.

@zedee
Since you want total separation you would want to send csrf token with your json data and then when you post you send it back.
Something like this implementation.

I think you shouldn't abandon csrf by disabling it for routes. I have never worked with angular but you can also read XSRF-TOKEN cookie by laravel in your Angular app and then send it back as X-XSRF-TOKEN header it will be picked up by laravel.

@deben Hey

In my example in 7th step i described how you link them.

This is the part that links your entity with media imageables:

            if($mediaId && $mediaZone) {
                // Link media file with entity
                $mediaData = [
                    'mediaId' => $mediaId,
                    '_token' => csrf_token(),
                    'entityClass' => (new \ReflectionClass($this->game))->getName(), // You can also hardcode entity here if you like
                    'entityId' => $this->game->id,
                    'zone' => $mediaZone
                ];
                $req = Request::createFromBase(Request::create('', 'POST', $mediaData));
                $res = $media->linkMedia($req);
            }

You can see last part that calls on linkMedia(). Of course you would replace $this->game with tour slider instance.

Is this what you are asking?

@zedee

Ah now i understand.
Well currently i can see ways of achieving what you want but that would require editing file from core installation.

If you would like to go this way you can do something like that:
This seems easy solution see if it's exactly what you want.
In App/Http/Kernel.php

1. Remove 'App\Http\Middleware\VerifyCsrfToken', from $middleware stack.
2. Add 'csrf' => 'App\Http\Middleware\VerifyCsrfToken', to $routeMiddleware stack.

That would globally disable csrf.

Helpfully Asgard has config entries for enabling middleware for routes frontend, backend, api.
For example if only backend exposed you can now add csrf middleware in config/asgard.core.core.php in backend stack, that would only require you to edit 1 file from default package.

@zedee

A bit lost here, so you want to publish dashboard assets and rewrite views?

For publishing everything in Assets folder of module: php artisan module:publish Dashboard

I can see that Dashboard module are not exposing views.
You would need to edit DashboardServiceProvider

    public function boot()
    {
        $this->publishes([
            __DIR__ . '/../Resources/views' => base_path('resources/views/asgard/dashboard'),
        ], 'views');
        
        $this->loadViewsFrom(base_path('Themes/'.config('asgard.core.core.admin-theme').'/views/modules/dashboard'), 'dashboard');
        $this->loadViewsFrom(base_path('resources/views/asgard/dashboard'), 'dashboard');
        $this->loadViewsFrom(__DIR__ . '/../Resources/views', 'dashboard');
    }

php artisan vendor:publish --provider="Modules\Dashboard\Providers\DashboardServiceProvider" --tag="views"

Thats a PR for dashboard module for sure.

Update: PR filled

@zedee

Yeah same thing for all modules that you want view modified where view composers are not enough.
Probably we/i should do a PR's for all asgard modules that has views to expose them and also include Theme override line.

Personally i ignore everything in Modules folder and for my custom modules i just pull them from my private repositories.
For any core module edits i do i try to PR that changes if it makes sense in global manner. If PR makes no sense for project sake i keep separate list of modified files and code so i can re-apply fixes on fresh installs.

Probably good strategy would be replace modified module with core one and use again custom repository until thing you need is in the core module.

For dashboard module PR is merged and in the master, but you would modify composer.json to pull master until tagged release comes over.
If you do not want to pull master you could remove Dashboard from .gitignore and just remember that you made change so you don't accidentally update it with original one.

@zedee

I debugged this problem and it's because CoreServiceProvider registers Modules/<module>/Resources/views before any module can do local views location declarations and is placed on 0th index and thus always finds those views first.

This applies to all modules of asgard and any custom modules except users module since this is skipped for that one.

For now you have two options.

First is to edit CoreServiceProvider:

    /**
     * Register the view namespaces for the modules
     * @param Module $module
     */
    protected function registerViewNamespace(Module $module)
    {
        if ($module->getName() == 'user' || $module->getName() == 'dashboard') {
            return;
        }
        $this->app['view']->addNamespace(
            $module->getName(),
            $module->getPath() . '/Resources/views'
        );
    }

Second one i like better, in DashboardServiceProvider:

// instead of 
$this->loadViewsFrom(base_path('Themes/'.config('asgard.core.core.admin-theme').'/views/modules/dashboard'), 'dashboard');

// do this
$this->app['view']->prependNamespace('dashboard', base_path('Themes/'.config('asgard.core.core.admin-theme').'/views/modules/dashboard'));

That would place every prepend to 0th position. And we can control then what folders to look first.

I'll keep this one in mind and look if any good PR can be done.

This is how final version should look like for boot:

    // use use Modules\Workshop\Manager\StylistThemeManager;
    public function boot(StylistThemeManager $theme)
    {
        $this->publishes([
            __DIR__ . '/../Resources/views' => base_path('resources/views/asgard/dashboard'),
        ], 'views');

        $this->app['view']->prependNamespace('dashboard', base_path('resources/views/asgard/dashboard'));
        $this->app['view']->prependNamespace('dashboard', $theme->find(config('asgard.core.core.admin-theme'))->getPath() . '/views/modules/dashboard');
    }

Will have to re-PR upon new development of situation.

@zedee

Yeah it basically takes namespace and path and adds that path for that namespace and places it in first position (0th index).

With this code what would happen is:

1. CoreServiceProvider registers Modules/{module}/Resources/views as first hint.
2. Then boot method prepends to hints array resources/views/asgard/dashboard
3. And finally we prepend to hints array {theme_path)/views/modules/dashboard'

So in the end we will get hints array like (order of folders that Laravel checking for views):

[
    0 => '/var/myserverpath/asgard/Themes/{mytheme}/views/modules/dashboard',
    1 => '/var/myserverpath/asgard/resources/views/asgard/dashboard',
    2 => '/var/myserverpath/asgard/Modules/Dashboard/Resources/views'
]

Previously it was always having '/var/myserverpath/asgard/Modules/Dashboard/Resources/views' as 0th index.
Since loadViewFrom appends to hints array.

if you dd($this->app['view']) you can see in Filesystem object array of hints.

Update: did PR for Revert of previous PR
And new PR to address all the findings we did here

@zedee
Np, i usually find me learning of new stuff exactly when i try to solve problem for someone else or myself.

You need to enable FileInfo PHP extension.
Then run same command again.

Or show rest of composer problem log to know answer without guessing.