https://github.com/scaleflex/syliusfilerobotplugin

https://github.com/scaleflex/syliusfilerobotplugin

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/scaleflex/syliusfilerobotplugin
• Owner: scaleflex
• Created: 2022-04-21T09:30:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T05:28:11.000Z (5 months ago)
• Last Synced: 2024-11-10T20:07:08.487Z (9 days ago)
• Language: PHP
• Size: 267 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Installation

### Step 1: Download the plugin

Open a command console, enter your project directory and execute the

following command to download the latest stable version of this bundle:

```shell

 composer require scaleflex/sylius-filerobot-plugin

```

This command requires you to have Composer [installed globally](https://getcomposer.org/doc/00-intro.md), as explained in the installation

chapter of the Composer documentation.

### Step 2: Enable the plugin

Then, enable the plugin by adding it to the list of registered

plugins/bundles in config/bundles.php file of your project:

```injectablephp

 ['all' => true],

];

```

### Step 3: Configure the plugin

#### Update DB Schema

```shell

bin/console doctrine:migration:diff

bin/console doctrine:migration:migrate

bin/console cache:clear

```

### Add Admin route

Create file in ```config/routes/scaleflex_sylius_filerobot.yaml``` and add content bellow

```yaml

# config/routes/scaleflex_sylius_filerobot.yaml

scaleflex_sylius_filerobot:

  resource: "@ScaleflexSyliusFilerobotPlugin/Resources/config/routing.yaml"

```

#### Update product media tab form

Change form theme ```{% form_theme form '@ScaleflexSyliusFilerobotPlugin/Admin/Form/imagesTheme.html.twig' %}```

in your ```templates/bundles/SyliusAdminBundle/Product/Tab/_media.html.twig```

```html

{% form_theme form '@ScaleflexSyliusFilerobotPlugin/Admin/Form/imagesTheme.html.twig' %}



  
{{ 'sylius.ui.media'|trans }}


  


    {{ form_row(form.images, {'label': false}) }}


    {{ sylius_template_event(['sylius.admin.product.' ~ action ~ '.tab_media', 'sylius.admin.product.tab_media'], {'form': form}) }}

  



```

#### Update product grid thumbnail

Change grid thumbnail column template

```yaml

# config/package/_sylius.yaml


sylius_grid:

  grids:

    sylius_admin_product:

      fields:

        image:

          options:

            template: "@ScaleflexSyliusFilerobotPlugin/Admin/Product/Grid/Field/image.html.twig"

```

#### Add script

```yaml

# config/package/sylius_ui.yaml

sylius_ui:

  events:

    sylius.admin.layout.javascripts:

      blocks:

        filerobot_script: '@ScaleflexSyliusFilerobotPlugin\Admin\filerobotScript.html.twig'

```

#### Add config filter

Create a file ```config/packages/scaleflex_filerobot.yaml``` and add content bellow

```yaml

imports:

  - { resource: "@ScaleflexSyliusFilerobotPlugin/Resources/config/filters.yaml"}

```

#### Update config in Admin

Goto **Scaleflex Filerobot** under **Configuration**



You can only enable if token, security template id are correct

- Activation: Enable/Disable Filerobot plugin

- Filerobot Token: Your Filerobot token

- Security Template Identifier: Your security template ID

- Filerobot upload directory: Folder path to your asset, ie /magento

#### Developer guide

The Filerobot plugin provide some twig method, filter support developer

- ```is_filerobot(image_path)```: Twig function check if image is filerobot

- ```image_path|filerobot('sylius_shop_product_thumbnail')```: Twig Filter, with image size, you can add more filter

in ```config/package/scaleflex_filerobot.yaml```

    ```yaml

    scaleflex_sylius_filerobot:

      filters:

        custom_size: { width: 120, height: 120 }

    

    ```

    and in Twig

    ```html

    image_path|filerobot('custom_size')

    ```

    

    We have some default size follow Sylius default, you can override it in filter config above

    

    ```yaml

    scaleflex_sylius_filerobot:

      filters:

        sylius_admin_product_large_thumbnail: { width: 550, height: 412 }

        sylius_admin_product_small_thumbnail: { width: 150, height: 112 }

        sylius_admin_product_tiny_thumbnail: { width: 64, height: 64 }

        sylius_admin_product_thumbnail: { width: 50, height: 50 }

        sylius_shop_product_tiny_thumbnail: { width: 64, height: 64 }

        sylius_shop_product_small_thumbnail: { width: 150, height: 112 }

        sylius_shop_product_thumbnail: { width: 260, height: 260 }

        sylius_shop_product_large_thumbnail: { width: 550, height: 412 }

        sylius_small: { width: 120, height: 120 }

    

    ```

- If you use Scaleflex Filerobot on existing File you have to check the path is filerobot or not, if not use the default way

#### Example with Sylius default

- ```templates/bundles/SyliusShopBundle/Product/_mainImage.html.twig```

```html

{% if product.imagesByType('thumbnail') is not empty %}

    {% if is_filerobot(product.imagesByType('thumbnail').first.path) %}

        {% set path = product.imagesByType('thumbnail').first.path|filerobot('sylius_shop_product_thumbnail') %}

    {% else %}

        {% set path = product.imagesByType('thumbnail').first.path|imagine_filter(filter|default('sylius_shop_product_thumbnail')) %}

    {% endif %}

{% elseif product.images.first %}

    {% if is_filerobot(product.images.first.path) %}

        {% set path = product.images.first.path|filerobot('sylius_shop_product_thumbnail') %}

    {% else %}

        {% set path = product.images.first.path|imagine_filter(filter|default('sylius_shop_product_thumbnail')) %}

    {% endif %}

{% else %}

    {% set path = asset('assets/shop/img/200x200.png') %}

{% endif %}



```

- ```templates/bundles/SyliusShopBundle/Product/Show/_mainImage.html.twig```

```html

{% if product.imagesByType('main') is not empty %}

    {% set source_path = product.imagesByType('main').first.path %}

    {% if not is_filerobot(source_path) %}

        {% set original_path = source_path|imagine_filter('sylius_shop_product_original') %}

        {% set path = source_path|imagine_filter(filter|default('sylius_shop_product_large_thumbnail')) %}

    {% else %}

        {% set original_path = source_path|filerobot('sylius_shop_product_original') %}

        {% set path = source_path|filerobot('sylius_shop_product_large_thumbnail') %}

    {% endif %}

{% elseif product.images.first %}

    {% set source_path = product.images.first.path %}

    {% if not is_filerobot(source_path) %}

        {% set original_path = source_path|imagine_filter('sylius_shop_product_original') %}

        {% set path = source_path|imagine_filter(filter|default('sylius_shop_product_large_thumbnail')) %}

    {% else %}

        {% set original_path = source_path|filerobot('sylius_shop_product_original') %}

        {% set path = source_path|filerobot('sylius_shop_product_large_thumbnail') %}

    {% endif %}

{% else %}

    {% set original_path = asset('assets/shop/img/400x300.png') %}

    {% set path = original_path %}

{% endif %}





    



{% if product.images|length > 1 %}



{{ sylius_template_event('sylius.shop.product.show.before_thumbnails', {'product': product}) }}



    {% for image in product.images %}

    {% set path = image.path is not null ? (is_filerobot(image.path) ? image.path|filerobot('sylius_shop_product_small_thumbnail') : image.path|imagine_filter('sylius_shop_product_small_thumbnail')) : asset('assets/shop/img/200x200.png') %}

    


    {% if product.isConfigurable() and product.enabledVariants|length > 0 %}

        {% include '@SyliusShop/Product/Show/_imageVariants.html.twig' %}

    {% endif %}

        

            

        

    

    {% endfor %}



{% endif %}


```