shopware5 / devdocs Goto Github PK

Old plugins provides access to the Plugin-Configuration via Shopware_Components_Plugin_Bootstrap::Config. Please add documentation on how to access this in need Plugin System.

Problem solved in this way: https://github.com/Haehnchen/shopware-plugin-commerce-tools-exporter/blob/master/Config/ConfigFactory.php#L15

Target:
https://developers.shopware.com/developers-guide/plugin-system/

Hi, how build plugin in shopware 5.2.6?
Build Backend plugin new clear window (page)?
I created plugin aded menu item and when click go to page plugin then show error "Not Found 404 app"

we shold change this command
sudo apt-get install nodejs-legacy npm
to:
sudo apt-get install nodejs npm

cuz nodejs-legacy install node v4.2 and to complete the grunt installation we need node v4.5 pr above

the example at https://developers.shopware.com/developers-guide/shopware-5-cli-commands/ gives me an error:

[Symfony\Component\Console\Exception\LogicException]
  The command defined in "…" cannot have an empty name.

to fix it i had to add setName() to the configure function. but shouldnt shopware do that for us, using the command from <tag name="console.command" command="swagcommandexample:import"/>? or for what else is there "swagcommandexample:import" in the xml file? (fwiw, i removed the "command" attribute from tag, dont see any use for it)

Hi,

I'm using the documentation wo get started with shopware.
Therefore I followed the plugin quick start guide to develop my first plugin.

Unfortunately the implementation of the used class/component SloganPrinter is not explained, or am I missing something?

The last part covering "OneToMany" associations is not complete and therefor useless. It leaves out the detail window of variants and there is no example code anywhere to be found. Shopware itself never uses the "extend: 'Shopware.store.Association'" code that is given in the tutorial. All questions about this issue on the community board are unanswered. I can manage to display the data of a variant in a detail window, but I can't save it ("Cannot read property indexOf of undefined" in urlAppend method of ext-app.js). How do you manage to get variants to work?

I have configured shopware 5.1.1 in windows 7 and installed sample plugin shown in shopware doc. But it is not working. I have clear the cache.

https://developers.shopware.com/blog/atom.xml

This page contains the following errors:
error on line 1 at column 33: XML declaration allowed only at the start of the document
Below is a rendering of the page up to the first error.

There several hidden features inside Shopware PhpStorm that needs so more documentation. Provide a Page describing some basic usages.

Issues:

• Haehnchen/idea-php-shopware-plugin#40
• Haehnchen/idea-php-shopware-plugin#18
• Haehnchen/idea-php-shopware-plugin#33

Example

• https://confluence.jetbrains.com/display/PhpStorm/Shopware+development+with+PhpStorm

https://developers.shopware.com/styletile/_components-icon-set.html

The following icons are missing arrow in their class description:

icon--right4
icon--left5
icon--down5
icon--up4
icon--right5
icon--left6
icon--down6
icon--up5
icon--right6

Example:

<td><i class="icon--arrow-down5"></i><br/>
    icon--down5
</td>

Should be:

<td><i class="icon--arrow-down5"></i><br/>
    icon--arrow-down5
</td>

hello,
this "api/addresses" in REST api does not retrieve customer_id or user_id, i cannot know which address for which customer

Link to download example plugin on page https://developers.shopware.com/developers-guide/plugin-extension-by-plugin/#swagextendcustomproducts/installer.php not working.

Hello guys. Great work !!! I just had one small issue. whenever I've runned "ant build-unit" i had the problem that tools.jar was not there. I have solved this with just installing Java SDK (sudo apt-get install openjdk-7-jdk). I guess it should have been there at first place.

It'd be great to have a shopware/php matrix for supported php versions for each shopware version.

It could be an table with green ticks/red crosses which shows the support of php versions for each shopware version.

Ioncube supported versions should also be included in the table (deprecated above SW 5.5).

I just saw you've introduced a list of all icons for backend in devdocs/blob/master/source/designers-guide/backend-icons/index.html. Great! 👍

However as a developer I do not want to touch design-related stuff. Would it be an option for you to introduce _data-directory as described in Jekyll-documentation?

If you're interested I could do this initially?

Hello,
i have an issue with the newest SW Version and the CustomProduct plugin.
Everything works fine except the detail view of the order position.
The add field doesnt show in the details, but the request gets it.

data: [{label: "Set Dämpfungsockel", type: "checkbox", multi: true,…},…] 0: {label: "Set Dämpfungsockel", type: "checkbox",,…} 1: {label: "Länge Kältemittelleitungen 6/10 gebördelt", type: "custom_type",…}

type: "checkbox" is shown but not the custom field.

In the Address Management Guide (https://developers.shopware.com/developers-guide/address-management-guide/#extending-the-address-form) the following script is given for the FormBuilder Subscriber:

// PluginFolder/Subscriber/FormExtenderSubscriber.php

public static function getSubscribedEvents()
{
    return [
        'Shopware_Form_Builder' => 'onFormBuild',
    ];
}
    
public function onFormBuild(\Enlight_Event_EventArgs $event)
{
    if ($event->getReference() !== \Shopware\Bundle\AccountBundle\Form\Account\AddressFormType::class) {
        return;
    }

    /** @var \Symfony\Component\Form\FormBuilderInterface $builder */
    $builder = $event->getBuilder();

    $builder->get('additional')
            ->add('neighboursName', \Symfony\Component\Form\Extension\Core\Type\TextType::class, [
                'constraints' => [
                    new \Symfony\Component\Validator\Constraints\NotBlank()
                ]
            ]);
}

This will not work in Shopware v5.5 and higher, since the reference given to the $event is no longer the FormType class but the value of the FormTypes block value.

The correct way to check if the correct FormType is addressed by the FormBuilder should therefore be:

if ($event->getReference() !== 'address') {
        return;
}

The linked ZIP-file at the end of the article *https://developers.shopware.com/developers-guide/controller/ * is buggy in the latest SW version.

Hi,
I just started with Shopware Dev.

I put the SwagController example in /local/frontend ,activated it in the backend, but the following route returns nothing special :

http://shopware.site/frontend/test/index

Why the heck using the API from old and slow PHP? It makes no sense, you can write a plugin in PHP which hooks directly...

We need more Javascript snippets, since nowadays Websites are performing better when they using principles like PWA which are mainly powered by client side Javascript.. If Shopware will not provide a documentation which shows some JS Snippets, its not ready for the future of the Web.

Frameworks like Vue.js / Polymer / React / Angular are the way the best user experiences are made. And not a php generated page, which is even not accessible when offline or with poor connection... so please do your homework shopware!

When I call addresses, there is no customer element

https://github.com/shopware/devdocs/blob/master/source/developers-guide/rest-api/api-resource-address/index.md

Cannot extend "Add item" module with new Tab.
Trying to make by This example, but it does not work.

If a single page takes 250ms (milliseconds) to load surely 4 pages would take 1 second, not 1 minute, right?
250ms x 4 = 1000ms = 1s

So 400 page loads would take 100 seconds as opposed to 1h.

shopware 5.4.2 uses extjs 4.1.0 (according to Ext.getVersion('extjs')) but documentation at https://developers.shopware.com/developers-guide/backend-components/basics/ links to http://docs.sencha.com/extjs/4.1.3/#!/api

and apparently extjs removes features even in patch versions!?

http://docs.sencha.com/extjs/4.1.0/#!/api/Ext.container.Container-method-onAdded
onAdded( container, pos )

http://docs.sencha.com/extjs/4.1.3/#!/api/Ext.container.Container-method-onAdded
onAdded( )

ps. the 2 other extjs links on that page also link to the wrong extjs version

This page:

https://developers.shopware.com/developers-guide/rest-api/api-resource-property-group/

I probably not linked correctly. I could only find it through a link from the examples, but not in the main navigation. To my understanding, it should be listed in the resources navigation.

the three extjs doc links in https://developers.shopware.com/developers-guide/backend-components/basics/ are 404

404 Not Found
Code: NoSuchKey
Message: The specified key does not exist.
Key: extjs/4.1.1/index.html
RequestId: 38D5F1773B607998
HostId: yhzi8Hsxok0Y6KiUM/QAPSWxeMOTTsVFOItwXS8cdjh6jbLa8108jBm8oq8ovVpLhBlSQS5CJSU=

i hope this is just temporary, cause 4.1.3 is still there, but we cant trust those cause they break the api even on minor version changes...

I downloaded this plug-in and tried to install it in my demo-shop.

I took a look at the server-logs, too:

192.168.56.1 - - [29/Apr/2016:13:18:59 +0000] "GET /backend/login/getLoginStatus?_dc=1461935939526 HTTP/1.1" 200 68 "http://shopware.dev/backend/" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.86 Safari/537.36"
192.168.56.1 - - [29/Apr/2016:13:18:58 +0000] "POST /backend/PluginInstaller/installPlugin HTTP/1.1" 200 36 "http://shopware.dev/backend/" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.86 Safari/537.36"
192.168.56.1 - - [29/Apr/2016:13:19:00 +0000] "GET /backend/PluginManager/detail?_dc=1461935940121&technicalName=SwagPluginSystem&page=1&start=0&limit=25 HTTP/1.1" 200 484 "http://shopware.dev/backend/" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.86 Safari/537.36"
192.168.56.1 - - [29/Apr/2016:13:19:00 +0000] "GET /backend/PluginManager/localListing?_dc=1461935940685&page=1&start=0&limit=20000&group=%5B%7B%22property%22%3A%22groupingState%22%2C%22direction%22%3A%22DESC%22%7D%5D&sort=%5B%7B%22property%22%3A%22groupingState%22%2C%22direction%22%3A%22DESC%22%7D%5D HTTP/1.1" 200 1158 "http://shopware.dev/backend/" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.86 Safari/537.36"

I cannot enable the plugin: when I click on the green + symbol, the plugin wents from not-installed to deactivated list.

Shopware Version 5.1 (shopware/shopware@8647bdf)
My vagrant machine:

$ lsb_release -d
Description:    Ubuntu 14.04.3 LTS
$ php --version
PHP 5.6.20-3+donate.sury.org~trusty+1 (cli) 
Copyright (c) 1997-2016 The PHP Group
Zend Engine v2.6.0, Copyright (c) 1998-2016 Zend Technologies
    with Zend OPcache v7.0.6-dev, Copyright (c) 1999-2016, by Zend Technologies
    with Xdebug v2.4.1-dev, Copyright (c) 2002-2016, by Derick Rethans

My host machine

$ lsb_release -d
Description:    Ubuntu 16.04 LTS

It is not a real Issue, but it would be nice if there was a *.xml File for Code Style to download on the https://developers.shopware.com/developers-guide/coding-standards/ Page.

As most PHP-devs are using PhpStorm this would be nice (Editor -> Code Style -> PHP)

According to https://github.com/shopware/devdocs/blob/3d3a138829e390afc7ba88fd227629d21a07073a/source/sysadmins-guide/elasticsearch-setup/index.md
only 1.6 is officially supported.
However, according to https://github.com/shopware/shopware/blob/5.1/composer.json#L41 Shopware is running the 2.2 client library.
We successfully ran on 2.3.3 already.

Thus I wonder whether the documentation is just outdated in this case and what is generally considered best practice for the Elasticsearch setup on Shopware 5.1/5.2?

We should evaluate javascript based search engines.
lunr.js looks most promising.

During the page generation a json based index file is build, that is later consumed by the client.

• http://10consulting.com/2013/03/06/jekyll-and-lunr-js-static-websites-with-powerful-full-text-search-using-javascript/
• https://github.com/jbouzekri/SculpinSearchBundle
• http://www.tipue.com/search/
• https://github.com/acelaya/blog/blob/master/app/src/AndrewShell/Twig/Extensions/Text.php#L50

Hi,
this example with windows.js script does not working for me, i replaced .each with .forEach and everything works fine now.

https://developers.shopware.com/developers-guide/backend-extension/

I am new in shopware , i am creating a plugin that is based on canvas greeting card designing and i want to create product using my plugin , So how to achieve this from plugin ,
Every things are going well in my plugin but i stacked here for the same.
So please share some piece of code or any document that help me to achieve this task.
Thanks
Neeraj

Found a broken link on this page: https://developers.shopware.com/developers-guide/payment-plugin/ (our plugin guides)

The broken link is https://developers.shopware.com/developers-guide/payment-plugin/plugin-guide/ (relative link in the Markdown file)

Not to sure where the user should land, when clicking the link. Would totally fix that for you, if someone would just point me to the right direction (URL) :)

See title. I think that should be noted somewhere, ie. with some example of how to retrieve customers which have been created "after" a specific date.

Thats possible by filtering with the "firstLogin" field of a customer.

("firstLogin" is a bad name for a "created_at" field imho, but thats not the topic here)

Reason: that field name is not very clever in giving away, thats in fact a identifier of when that customer has been created.

I'm talking 5.3.4 here, haven't check other versions.

I was trying to figure out why the template extension does not work - the services.xml is missing:
<tag name="shopware.event_subscriber"/>
after
<argument type="service" id="template"/>
in custom/plugins/SwagPluginSystem/Resources/services.xml

it is documented - but missing in the files

The swagproductbasics.zip file isn't available for download in this page: https://developers.shopware.com/developers-guide/backend-components/basics/

Please add higher quality entity relationship diagram, as the current pdf looses quality when zoomed to 100%, with difficulty to read the text.

https://developers.shopware.com/developers-guide/entity-relationship-model/

Is there any reason not using sync folders, which are created between host and virtual machine, instead of deploying changes with ftps and phpstorm ?

According to the Update Guide, shippings and billings have been replaced by defaultShippingAddress and defaultBillingAddress, which have the type address.
Shipping and billing still seem to work for POST requests.

The guide to add a custom risk rule is not working for me with shopware 5.2.10

1. the attached file uses "Frontend" as folder but its declared as "Backend" in the bootstrap.php
2. if i change the folder and upload the plugin there is no rule added to the risk management so the tutorial and attached example are not woking for me

Resident grammar-nazi checking in :)

I was wondering how word-choice issues should be handled, if they reflect in the code base of Shopware. In case of "articles", the general consensus is, as far as I can observe, to avoid using the word "article", and instead use "product", both in the documentation and in new code. But "articles" are not the only example.

I am aware that changing names of existing classes isn't possible due to compatibility reasons. However, do you think it's reasonable to change references to those classes in the documentation?

One specific example that annoys me a little bit is "listing". In Shopware, almost every list is incorrectly called "listing" (for reference: a listing is usually one entry in a list, for example a job-listing is ein Stellenangebot). I can also imagine, "listing" was chosen due to the fact that list is a reserved keyword in PHP. However, referring to a product-list as "product-listing" in a non-programming context seems wrong to me.

So here is my question: Should terms like these which originate from a wrong word-choice be changed in the documentation? I see three options:

• Option 1: don't change anything

The Listing-controller class is called Listing and is responsible for the product-listing

• Option 2: change references in non-programming contexts

The Listing-controller class is called Listing and is responsible for the product-list

• Option 3: change every reference, but keep names (because we don't want to change code)

The List-controller class is called Listing and is responsible for the product-list

Personally, I prefer option two. What is your stance on that?

https://github.com/shopware/devdocs/blame/master/source/developers-guide/backend-components/basics/index.md#L565 image should most likely be a listing window, not a detail window.

Is it possible to filter customers, like only get inactive customers?
Its missing in the docs, but its working. (Shopware 5.3.4)

'filter' => [
                            [
                                'property' => 'active',
                                'value' => false
                            ]
                        ]

Its also missing the customer model.

am i blind or does https://github.com/shopware/devdocs/blob/master/source/designers-guide/javascript-statemanager-and-pluginbase/index.md not mention how to use the example plugin?

i see a hint "Automatically binding the plugin to the element using jQuery's data-method"...

or is this doc only for using the example plugin with the statemanager?
where is the documentation on how to use (this example) shopware-exclusive* jquery plugin without statemanager?

*jquery plugin documentation here looks completely different https://learn.jquery.com/plugins/basic-plugin-creation/ so are these two different jquery plugin systems?

The lack of English documentation is one of the major obstacles non german developers face when dealing with Shopware developement.

I was searching for documentation on how to create a widget, integrate it on my plugin and allow admins to include it on any product pages.. However i couldn't find any track except this non working example:
http://community.shopware.com/Eigene-Einkaufswelten-Elemente-erstellen_detail_1459.html
The provided example plugin: Media Widget Example doesn't work on Shopware v5.

It is becoming a frustration for us to develop shopware plugins if there's no documentation and no working examples; we are forced to ask our clients to switch to other good documented shopping systems (Prestashop for example).

We have deactivated the CSRF protection due to problems in the checkout process. Now we still see a file named https://www.ourdomain.de/csrftoken loaded on every request an with weiting times of half a second.

We are optimizing our pages on speed aspects an this one is a huge drawback. How can we get rid of that csrf call or how can we speed it up?

I followed the steps on the plugin quickstart but I couldn't see the results displayed on the front end.

I switched back and forth the Bar theme and Responsive theme but none of them was able to show the Slogan widget in the frontend.

I even deleted my plugin and used the one you provided but it also didn't work!

I cheked the logs and couldn't see anything suspesious :(

I'm running Shopware 5 on localhost on a windows 7 machine.

Hi @bcremer ,

This is regarding the 2015-03-02-sso-with-nginx-auth_request.md.
In this part of nginx.conf

server {
    ...
    error_page 401 = @error401;
    location @error401 {
        return 302 https://login.example.com;
    }
}

What should login.example.com return and where? How does it tell nginx that user is authenticated and subsequently redirect to staticpage.example.com?

PS : Similar attempt was made in nginx-auth-proxy. But the authentication is not working properly. I spent hours in trying to understand what is going wrong there. This issue contains few details about it. Can you help me in debugging this?

Problem

The postMessage API documentation indicates that there is a third argument available for createGrowlMessage() that allows the growl message to be sticky: https://developers.shopware.com/developers-guide/lightweight-backend-modules-api/#postmessage-api-documentation

However the current function definition does not accept such an argument, see:
https://github.com/shopware/shopware/blob/56df57575909854d2dec7fcba07500e27a3361ee/themes/Backend/ExtJs/backend/base/component/Shopware.Notification.js#L535

Instead, createStickyGrowlMessage() works as a separate function all by itself, see: https://github.com/shopware/shopware/blob/56df57575909854d2dec7fcba07500e27a3361ee/themes/Backend/ExtJs/backend/base/component/Shopware.Notification.js#L611

Tested Examples

Suggested in the docs - does not work:

Shopware.Notification.createGrowlMessage(
  'My title',  
  'Some description text.',
   true, // should make the growl message sticky
   false, 
   { 
      btnDetail: { 
        link: 'http://wiki.shopware.de' 
      } 
   }
);

Results in:

Suggested in the source code's comment - does work:

Shopware.Notification.createStickyGrowlMessage({
  title: 'My title',
  text: 'Some description text.',
  log: false,
  btnDetail: {
    link: 'http://wiki.shopware.de'
  }
});

Results in:

The styletile has different content for same topic.

Generally it'll be great, if we could know, how the styletile is gerenerated. Tried to catch some bugs, ended with headache :-) Additionally for PRs it'll be more great to have styletile in seperated repo instead of branch.

Icon-Set: https://developers.shopware.com/styletile/components.html#icon-set
Icons: https://developers.shopware.com/styletile/cheatsheet.html#icons

• Icon-Set and Icons are missing the new ones, coming with 5.5.7: shopware/shopware@9c1b277
• Iconset has some wrong naming, See for ref.: https://github.com/shopware/devdocs/pull/991/files
• There should be just one base font, not two: 1. shopware, 2. shopware_website

Ping @mitelg @klarstil