Jak stworzyć prosty moduł "Hello World" w Magento?

Przede wszystkim gorąco polecam zakup PDF / E-Book z PHP Architect. To US$20, ale jest jedynym prostym zasobem "Oto jak działa Magento", który udało mi się znaleźć. Zacząłem również pisać tutoriale Magento na mojej własnej stronie internetowej .

Po drugie, jeśli masz wybór, a nie jesteś doświadczonym programistą lub nie masz dostępu do doświadczonego programisty (najlepiej w PHP i} Java), wybierz inny koszyk. Magento jest dobrze zaprojektowany, ale został zaprojektowany, aby być rozwiązaniem wózka, na którym inni programiści mogą budować Moduły. Nie został zaprojektowany tak, aby był łatwo zrozumiały dla ludzi, którzy są inteligentni, ale nie są programistami.

Po Trzecie, Magento MVC bardzo różni się od Ruby on Rails, Django, CodeIgniter, CakePHP , itd. Model MVC, który jest popularny wśród programistów PHP w dzisiejszych czasach. Myślę, że bazuje na modelu Zend , a całość jest bardzo podobny do Javy. Są dwa kontrolery, o które musisz się martwić. Moduł / frontName controller, a następnie kontroler MVC.

Po czwarte, sama aplikacja Magento jest zbudowana przy użyciu tego samego systemu modułów, którego będziesz używać, więc grzebanie w kodzie głównym jest użyteczną taktyką uczenia się. Ponadto, wiele z tego, co będziesz robił z Magento, to nadpisywanie istniejących klas. To, co tu omawiam, to tworzenie nowej funkcjonalności, a nie nadpisywanie. Zostawić pamiętaj o tym, gdy patrzysz na próbki kodu.

Zacznę od pierwszego pytania, pokazując, jak skonfigurować kontroler / router, aby odpowiedzieć na konkretny adres URL. To będzie mała powieść. Może później będę miał czas na tematy związane z modelem/szablonem, ale na razie nie mam. będę jednak krótko rozmawiał z twoim pytaniem SQL.

Ostateczne zastrzeżenie. Używam Magento od około dwóch lub trzech tygodni, więc caveat emptor. Jest to ćwiczenie, aby uzyskać to prosto w mojej głowie, jak to jest, aby pomóc przepełnienie stosu.

Utwórz moduł

Wszystkie dodatki i dostosowania do Magento są wykonywane za pomocą modułów. Więc pierwszą rzeczą, której potrzebujesz aby to zrobić, należy utworzyć nowy moduł. Tworzenie pliku XML w app/modules o następującej nazwie

cd /path/to/store/app
touch etc/modules/MyCompanyName_HelloWorld.xml

<?xml version="1.0"?>
<config>
     <modules>
        <MyCompanyName_HelloWorld>
            <active>true</active>
            <codePool>local</codePool>
        </MyCompanyName_HelloWorld>
     </modules>
</config>

MyCompanyName jest unikalną przestrzenią nazw dla Twoich modyfikacji, nie musi to być Nazwa Twojej firmy, ale zalecana konwencja my magento. HelloWorld to nazwa Twojego modułu.

Wyczyść pamięć podręczną aplikacji

Teraz, gdy plik modułu jest już na miejscu, musimy powiadomić o tym Magento (i sprawdzić naszą pracę). W aplikacji admin

1. idź do System - > Zarządzanie Cache
2. wybierz Odśwież z menu All Cache
3. kliknij Zapisz Ustawienia pamięci podręcznej

1. przejdź do System - > Konfiguracja
2. Kliknij Zaawansowane
3. w polu ustawień" Wyłącz wyjście modułów " poszukaj nowego modułu o nazwie "MyCompanyName_HelloWorld"

Jeśli możesz żyć z wydajnością spowolnić, możesz wyłączyć pamięć podręczną aplikacji podczas rozwój/uczenie się. Nic nie jest bardziej frustrujące niż zapominanie o wyczyszczeniu pamięci podręcznej i zastanawianie się, dlaczego twoje zmiany nie pojawiają się.

Konfiguracja struktury katalogów

Następnie musimy skonfigurować strukturę katalogów dla modułu. Nie będziesz potrzebował wszystkich tych katalogów, ale nie ma nic złego w skonfigurowaniu ich wszystkich teraz.

mkdir -p app/code/local/MyCompanyName/HelloWorld/Block
mkdir -p app/code/local/MyCompanyName/HelloWorld/controllers
mkdir -p app/code/local/MyCompanyName/HelloWorld/Model
mkdir -p app/code/local/MyCompanyName/HelloWorld/Helper
mkdir -p app/code/local/MyCompanyName/HelloWorld/etc
mkdir -p app/code/local/MyCompanyName/HelloWorld/sql

I dodać plik konfiguracyjny

touch app/code/local/MyCompanyName/HelloWorld/etc/config.xml

I wewnątrz pliku konfiguracyjnego Dodaj następujący tekst, który jest zasadniczo " pustym" konfiguracja.

<?xml version="1.0"?>
<config>
    <modules>
        <MyCompanyName_HelloWorld>
            <version>0.1.0</version>
        </MyCompanyName_HelloWorld>
    </modules>
</config>

Upraszczając sprawy, ten plik konfiguracyjny pozwoli Ci powiedzieć Magento, jaki kod chcesz uruchomić.

Następnie musimy skonfigurować routery modułu. Dzięki temu system będzie wiedział, że obsługujemy dowolne adresy URL w postaci

http://example.com/magento/index.php/helloworld

Więc w pliku konfiguracyjnym dodaj następującą sekcję.

<config>
<!-- ... -->
    <frontend>
        <routers>
            <!-- the <helloworld> tagname appears to be arbitrary, but by
            convention is should match the frontName tag below-->
            <helloworld>
                <use>standard</use>
                <args>
                    <module>MyCompanyName_HelloWorld</module>
                    <frontName>helloworld</frontName>
                </args>
            </helloworld>
        </routers>
    </frontend>
<!-- ... -->
</config>

To, co mówisz, to " dowolny adres URL z nazwą frontową helloworld ...

http://example.com/magento/index.php/helloworld

Powinien używać kontrolera mycompanyname_helloworld".

Więc, z powyższą konfiguracją na miejscu, po załadowaniu strony helloworld powyżej, otrzymasz stronę 404. To dlatego, że nie stworzyliśmy pliku dla naszego kontrolera. Zróbmy to teraz.

touch app/code/local/MyCompanyName/HelloWorld/controllers/IndexController.php

Spróbuj załadować stronę. Postęp! Zamiast 404, otrzymasz wyjątek PHP/Magento

Controller file was loaded but class does not exist

Więc otwórz plik, który właśnie stworzyliśmy i wklej poniższy kod. Nazwa klasa musi być oparta na nazwie podanej w routerze.

<?php
class MyCompanyName_HelloWorld_IndexController extends Mage_Core_Controller_Front_Action{
    public function indexAction(){
        echo "We're echoing just to show that this is what's called, normally you'd have some kind of redirect going on here";
    }
}

Właśnie skonfigurowaliśmy kontroler module/frontName. Jest to domyślny kontroler i domyślne działanie modułu. Jeśli chcesz dodać Kontrolery lub akcje, musisz pamiętać, że pierwsza część drzewa adresu URL Magento jest niezmienna.]}

Więc jeśli chcesz dopasować ten adres URL

http://example.com/magento/index.php/helloworld/foo

Będziesz musiał mieć FooController, który możesz w ten sposób:

touch app/code/local/MyCompanyName/HelloWorld/controllers/FooController.php

<?php
class MyCompanyName_HelloWorld_FooController extends Mage_Core_Controller_Front_Action{
    public function indexAction(){
        echo 'Foo Index Action';
    }

    public function addAction(){
        echo 'Foo add Action';
    }

    public function deleteAction(){
        echo 'Foo delete Action';
    }
}

Proszę zauważyć, że domyślny Kontroler IndexController i domyślna akcja indexAction mogą być niejawne, ale muszą być jawne, jeśli coś nastąpi po niej. Tak więc http://example.com/magento/index.php/helloworld/foo będzie pasował do kontrolera FooController i akcji indexAction, a nie do akcji fooAction Indexcontrollera. Jeśli chcesz mieć fooAction, w kontrolerze IndexController musisz wywołać ten kontroler jawnie w ten sposób : http://example.com/magento/index.php/helloworld/index/foo ponieważ druga część adres url jest i zawsze będzie nazwą kontrolera. To zachowanie jest dziedzictwem Zend Framework dołączonego do Magento.

Teraz powinieneś być w stanie trafić na następujące adresy URL i zobaczyć wyniki swoich poleceń echo

http://example.com/magento/index.php/helloworld/foo
http://example.com/magento/index.php/helloworld/foo/add
http://example.com/magento/index.php/helloworld/foo/delete

To powinno dać ci podstawowe pojęcie o tym, jak Magento wysyła kontroler. Stąd polecam szturchnięcie na istniejące klasy kontrolerów Magento, aby zobaczyć, jak powinny być używane modele i system szablonu/układu.