Detect which block method (_prepareSpecificInformation) is in use

Question

I have created a payment method and it has a _prepareSpecificInformation() that is extended under the Mage_Payment_Block_Info. Just need to detect where this is being called from with in the function as there are some points that I want to show everything and others, like an email, that I don't. This is what I have now.

protected function _prepareSpecificInformation($transport = null){
    $helper             = Mage::helper('centralprocessing');
    if ($this->_paymentSpecificInformation !== null) {
        return $this->_paymentSpecificInformation;
    }

    $info = $this->getInfo();

    $transport = new Varien_Object();
    $transport = parent::_prepareSpecificInformation($transport);

    $transData=array();

    $transData[Mage::helper('payment')->__('Card Type')]=$helper->getCardType($info->getCardType());
    $transData[Mage::helper('payment')->__('Masked CC Number')]='############'.$info->getMaskedCcNumber();

    $transData[Mage::helper('payment')->__('Response Return Code')]="".$info->getResponseReturnCode();
    $transData[Mage::helper('payment')->__('GUID')]=$info->getResponseGuid();
    $transData[Mage::helper('payment')->__('Approval Code')]=$info->getApprovalCode();

    $transport->addData($transData);

    return $transport;
}

So I wanted to add conditions on what is added to the $transData array depending if it's the admin or if it's in the email and such.

UPDATE The reason is that I need to put a link in with the data in the admin page only. Also turns out that

$transData[Mage::helper('payment')->__('GUID')]="<h1>HELLO</h1>";

Prints <h1>HELLO</h1> so the html is escaped first?

Answer 1

Detecting when being rendered on admin pages

Here's an easy way to determine whether the block is rendered within the admin page:

$isAdminBlock = $this->getParentBlock() && $this->getParentBlock() instanceof Mage_Adminhtml_Block_Sales_Order_Payment;

This works because the admin page will assign the payment block to be a child of Mage_Adminhtml_Block_Sales_Order_Payment. (PDFs and emails do not contain that parent block).

You can use this approach to modify your code like so:

protected function _prepareSpecificInformation($transport = null) {
    $helper = Mage::helper('centralprocessing');
    if ($this->_paymentSpecificInformation !== null) {
        return $this->_paymentSpecificInformation;
    }

    $info = $this->getInfo();

    // Here's where the detection occurs
    $isAdminBlock = $this->getParentBlock() && $this->getParentBlock() instanceof Mage_Adminhtml_Block_Sales_Order_Payment;

    $transData = array();

    $transData[Mage::helper('payment')->__('Card Type')] = $helper->getCardType($info->getCardType());
    $transData[Mage::helper('payment')->__('Masked CC Number')] = '############'.$info->getMaskedCcNumber();

    // Here's an example of only showing certain info to admins
    if ($isAdminBlock) {
        $transData[Mage::helper('payment')->__('Response Return Code')]="".$info->getResponseReturnCode();
        $transData[Mage::helper('payment')->__('GUID')]=$info->getResponseGuid();
        $transData[Mage::helper('payment')->__('Approval Code')]=$info->getApprovalCode();
    }

    $transport = parent::_prepareSpecificInformation($transport);
    $transport->addData($transData);

    return $transport;
}

---

Detecting between PDFs and emails

I know this doesn't answer your specific question, but hopefully it'll help someone else with a similar issue.

It's also possible to detect whether the block is being added to a PDF. When this happens, Magento calls ->toPdf() before rendering the template, so you'd just override that method, set a flag, and check the flag later:

public function toPdf() {
    $this->setIsPdf(true);
    return parent::toPdf();
}

protected function _prepareSpecificInformation($transport = null) {
    ...

    if ($this->getIsPdf()) {
        $transData['whatever'] = 'This will only appear in PDFs (not emails)';
    }

    // You could even combine this with the admin block check:
    if (!$isAdminBlock && !$this->getIsPdf()) {
        // We're probably being rendered inside of an email
    }

    ...
}

Answer 2

The admin template that calls this function is app/design/adminhtml/default/default/template/payment/info/default.phtml but there is also a pdf that shows the payment information also, app/design/adminhtml/default/default/template/payment/info/pdf/default.phtml

A good way of finding the block you have is to turn on template hints and this will show you templates and blocks used on a page.

Looking at what you need to do with your requirements I would suggest one of the following.

1. Rewrite the block Mage_Payment_Block_Info and check in the function if you are in the admin section via Mage::app()->getStore()->isAdmin() and then making your change,
2. Listen to the event adminhtml_block_html_before, check for your block type and then perform the change to the html that you require.

Answer 3

/app/code/core/Mage/Payment/Block/Info/Cc.php -> line 95
/app/code/core/Mage/Paypal/Block/Payment/Info.php -> line 53
/app/code/core/Mage/Payment/Block/Info.php -> line 105
/app/code/core/Mage/Sales/Block/Payment/Info/Billing/Agreement.php -> line 49
/app/code/core/Mage/Payment/Block/Info/Ccsave.php -> line 43

get this easy : http://doc-magento.com/ . just search your variable,function,calss from the right corner "search"