Gdzie umieścić pliki .php, .js, .html, .css z biblioteki innej firmy, która współpracuje z opracowanym przeze mnie rozszerzeniem?

Powiedzmy, że chcę opracować rozszerzenie Magento, które łączy się, powiedzmy, z pakietem wykresów Open Source lub galerią obrazów lub czymkolwiek innym, co NIE jest częścią samego rozszerzenia. Po pobraniu (oddzielnie od rozszerzenia) biblioteka innej firmy jest dostarczana jako pojedynczy plik .zip ze wszystkimi plikami .php, .js, .html i .css.

Czy umieszczam na biednym właścicielu strony, który chce zainstalować moje rozszerzenie razem z biblioteką innej firmy, ciężar rozdzielenia oryginalnego pliku .zip innej firmy i umieszczenia ich w plikach .js w / js, .php w / lib,. css w / skin itp?

Czy też istnieje ogólnie akceptowany „zrzut” dla zewnętrznych plików zip, w których można wygodnie rozpakować plik w stanie, w jakim się znajduje, i zrobić to?

Nie wiem, czy istnieje jedna poprawna odpowiedź na to pytanie, ponieważ tak naprawdę zależy to od kodu, który podajesz.

Jeśli chcesz dołączyć zewnętrzną bibliotekę php, np. Sdk dla zewnętrznego API, to powinna ona zostać umieszczona w katalogu / lib twojego projektu Magento, aby mogła być dołączona przez twoje rozszerzenie, które ją wykorzystuje.

Jednak używasz również js i css jako przykładów. Jeśli używasz js od stron trzecich w swoim rozszerzeniu do kodu wyjściowego, np. Niektóre js, które renderuje wykres kanwy, powinno to być bardziej niż prawdopodobnie umieszczone w katalogu / js, aby można je było dołączyć do twojego rozszerzenia. W przypadku css prawdopodobnie powinien zostać dodany do podstawowego / domyślnego motywu i katalogów skór.

Niestety system rozszerzenia Magento 1 nie ułatwia dystrybucji tego rodzaju rzeczy, ponieważ pliki są rozproszone w całym projekcie, a nie zawarte w jednym katalogu. Narzędzia takie jak Magento Composer Installer i Modman nieco w tym pomagają.

Po pobraniu (oddzielnie od rozszerzenia) rozszerzenia innych firm są dostarczane w jednym pliku .zip ze wszystkimi plikami .php, .js, .html i .css.

Zawsze byłem fanem wróżenia konwencji od samego źródła, chociaż może być to niejednoznaczne w Magento 1.

Pod warunkiem, że licencja na bibliotekę innej firmy zezwala na tworzenie pakietów, należy ją rozpakować i ponownie spakować wraz z rozszerzeniem, ponieważ nie ma natywnego mechanizmu rozpakowywania oddzielnej podbiblioteki (mogę się mylić).

Lokalizacja tych zasobów zależy od typu i wewnętrznej organizacji plików. Biblioteki Pure JS powinny ulec zmniejszeniu ./js/. Pliki, które są wykonywane po stronie serwera, należą do ./lib/, zwracając uwagę, że dowolna klasa PHP ./lib/może być automatycznie ładowana przez (zasadniczo PSR-0) schemat automatycznego ładowania (zob. Konwencja automatycznego ładowania Zend Framework 1). Za ./lib/pośrednictwem klienta (ref. ./lib/.htaccess) Nie można uzyskać dostępu do niczego poniżej .

Więc chcesz utworzyć rozszerzenie i do jego budowy używasz zewnętrznego zasobu / pakietu. Moim zdaniem, niezależnie od tego, jakiego pakietu użyłeś w swoim rozszerzeniu, twoje rozszerzenie powinno być zgodne z najlepszymi praktykami Magento. Oznacza to, że należy oddzielić wszystkie pliki js, css, obrazy od zewnętrznego zasobu i umieścić w base\defaultkatalogach pakietów motywów.

tzn. nie ma takiej unikalnej lokalizacji do umieszczania zasobów pakietu stron trzecich. Ostatecznie, gdy dostarczysz fajne rozszerzenie, wszystkie pliki js, css i obrazy związane z tym rozszerzeniem powinny być przechowywane w miejscu, w którym zwykle będzie szukał inny programista, a prawie w każdym przypadku jest to base/defaultpakiet motywów.

W skrócie

Wszystkie twoje rozszerzenia js powinny się znaleźć

skin\frontent\base\default\js\[your_extension]\[all_of_your_js_files]
skin\frontent\base\default\css\[your_extension]\[all_of_your_css_files]
skin\frontent\base\default\images\[your_extension]\[all_of_your_images]

//for third parties, you can create an inner directory, to specify it
skin\frontent\base\default\js\[your_extension]\[your_external_resource]\[resource_js_files]
skin\frontent\base\default\css\[your_extension]\[your_external_resource]\[resource_css_files]
skin\frontent\base\default\images\[your_extension]\[your_external_resource]\[resource_image_files]

W ten sposób inny programista może bardzo łatwo znaleźć pliki js, css i obrazy (również zasobów zewnętrznych) rozszerzenia. Ponieważ używasz dodatkowego podkatalogu do wskazania zewnętrznych plików zasobów w katalogu nazwy rozszerzenia, da to innym najlepszą wskazówkę, że twoje rozszerzenie polega na niektórych pakietach stron trzecich.

Dlatego polecam oddzielić zewnętrzne pakiety i uczynić je częścią twojego rozszerzenia, aby inny programista mógł łatwo znaleźć twoje zależności. :-)

EDYCJA - 1

Nie należy obciążać rozszerzenia swoim właścicielem witryny. Możesz uniknąć tej trudności, odpowiednio wyrównując rozszerzenie. Oznacza to, że jeśli zapiszesz wszystkie powiązane pliki w określonych lokalizacjach katalogu, to wszystko, co powinien zrobić właściciel witryny, to pobierz rozszerzenie, a następnie Scal swoje rozszerzenie z katalogu głównego aplikacji. tj. wyrównaj prawidłowo swoje rozszerzenie. To powinno wyglądać tak.

/app
|_____code\community\Namespace\Module\...
|_____design
|        |_____frontend\base\defalt\...
|        |_____adminhtml\base\defalt\...

/skin
|_____frontend\base\default\js|css|images\[your_extension]\all_theme_related_files
|_____frontend\base\default\js|css|images\[your_extension]\all_theme_related_files

EDYCJA - 2

Jeśli istnieją jakieś pakiety, które powinny być współużytkowane przez wszystkie aplikacje Magento (takie jak biblioteka javascript lub pakiet php itp.), Możesz umieścić je w \libkatalogu.

Prawdą jest, że może istnieć duplikat pliku, jeśli dwa rozszerzenia korzystają z tych samych pakietów zasobów. Mogą także używać innej wersji tego samego pakietu zasobów. Ale w zasadzie twoje rozszerzenie powinno wykorzystywać tylko zasoby twojego rozszerzenia (i może polegać na domyślnych zasobach Magento) i nie powinno polegać na zasobach innych rozszerzeń, chyba że twoje rozszerzenie jest „rozszerzoną wersją” rozszerzenia strony trzeciej.

Magento ma własny menedżer pakietów o nazwie Magento Connect. Powinieneś sprawdzić ten przewodnik z oficjalnej dokumentacji, aby w pełni zrozumieć, jak powinna wyglądać paczka. Po zrozumieniu struktury możesz spakować moduł z instalacji Magento.

Zasadniczo Magento używa jej własnej struktury do ładowni .php, .phtml, js, css, imagespliki.

Dla deweloperów rozszerzeń magento bardzo ważne jest, aby postępować zgodnie z magento. Sprawdź ten link .

Więc,

1. Twoje .phppliki powinny przejść do app/code/communityfolderu
2. Twoje jspliki mogą iść do jsfolderu lub do skin/frontend or adminhtml/your_theme_pack/your_theme/jsfolderu
3. Twoje csspliki mogą przejść do skin/frontend or adminhtml/your_theme_pack/your_theme/cssfolderu
4. Twoje imagespliki mogą przejść do skin/frontend or adminhtml/your_theme_pack/your_theme/imagesfolderu
5. Twój files should go tofolder „html app / design / frontend or adminhtml / template`

Interfejs PS oznacza, że ​​twoje rozszerzenie jest dla sklepu frontowego, a adminthml oznacza, czy twoje rozszerzenie jest dla obszaru administracyjnego.

Istnieją specjalne sposoby przechowywania tych plików w Magento, więc powinieneś ich przestrzegać.

Sprawdziłbym również, czy pożądane funkcje kopiowania są już dostępne w środowisku magento / zend. Na przykład tworzenie pdf, wysyłanie wiadomości e-mail, czytanie xml itp. Są już wbudowane w Magento.

Mam nadzieję że to pomoże.

Aktualizacja 1

Jeśli chcesz po prostu gdzieś przechowywać swoje pliki, możesz je przechowywać w dowolnym miejscu. Możesz nawet utworzyć nowy folder w katalogu głównym Magento. Ale nie jest to najlepsza praktyka dla Magento, które załaduje twój serwer podczas wykonywania tych plików. Chcesz to sprawdzić https://magentotherightway.com/