Magento 2 How to create simple module that echoes text on checkout success page?

Question

I have tried all examples found on Magento forums but I can't make it work.

I need to get Order ID and customer email on checkout success page.

Here's my module structure:

TV2M/GoogleSurvey/registration.php

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'TV2M_GoogleSurvey',
    __DIR__
);

TV2M/GoogleSurvey/etc/module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
    <module name="TV2M_GoogleSurvey" setup_version="1.0.0" schema_version="1.0.0">
    </module>
</config>

TV2M/GoogleSurvey/Block/Onepage/Success.php

<?php
namespace TV2M\GoogleSurvey\Block\Onepage;
use \Magento\Framework\View\Element\Template;



class Success extends \Magento\Checkout\Block\Onepage\Success
{
    public function getGoogleSurvey()
    {
        return "[email protected]";
    }
}

Module is activated, setup upgrade, cache clean...

In my theme folder, I have created a phtml file called by layout XML. File is loaded correctly. But when I call my function it returns nothing: echo $block->getEmail();

I have also tried to add di.xml:

TV2M/GoogleSurvey/etc/frontend/di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <preference for="Magento\Checkout\Block\Onepage\Success" type="TV2M\GoogleSurvey\Block\Onepage\Success" />
</config>

Can someone please tell me how to access getGoogleSurvey() function? Which files are necessary in my module? Thanks in advance.

Answer 1

you should run di:compile command, also pass require parameters in constructor of parent

class(\Magento\Checkout\Block\Onepage\Success)

Also change getEmail() function name it will be good in practice because we also access DB field by getEmail().

You should have call that template file with your current block in layout file. Can you please share the layout code?

Answer 2

first you have a problem in your

TV2M/GoogleSurvey/Block/Onepage/Success.php

you defined namespace two times change file to this

<?php
namespace TV2M\GoogleSurvey\Block\Onepage;
use \Magento\Framework\View\Element\Template;

class Success extends \Magento\Checkout\Block\Onepage\Success
{
    public function getEmail()
    {
        return "[email protected]";
    }
}

if helps accept answer

Answer 3

I finally found by myself.

In google_survey.phtml the correct code to call the function getGoogleSurvey() is:

$blockObj= $block->getLayout()->createBlock('TV2M\GoogleSurvey\Block\Onepage\Success');
echo $blockObj->getGoogleSurvey();

For the entire module to work we need the files mentioned above:

TV2M/GoogleSurvey/registration.php

TV2M/GoogleSurvey/etc/module.xml

TV2M/GoogleSurvey/Block/Onepage/Success.php

And in theme folder:

templates/html/google_survey.phtml

layout/checkout_onepage_success.xml

Now I can change the function getGoogleSurvey() in order to get customer email:

$order = $this->_checkoutSession->getLastRealOrder();
return $order->getCustomerEmail()

We don't need di.xml in this case.

Thanks to those who spent time to help me.