Get this extension on Magento Connect

Features

1. Uses the free API service provided by Scribd to upload and manage your document from the Magento administration area.
2. Upload as much document you want to upload, because there is no restriction on the storage limit.
3. Tag your uploaded documents on Scribd.
4. Set scope Private or Public for your uploaded document.
5. Upload and transform any file — including PDF, Word and PowerPoint — into a web document that’s discoverable through search engines, shared on social networks and read on billions of mobile devices.
6. Assign uploaded files to your product which can be shown in the storefront using a multi functional online Scribd Reader.
7. Supports all the document formats supported by Scribd. This list of the supported format can be found on This Location

Installation Guide

1. Get the extension from Magento Connect.
2. Install the extension from Magento Connect Manager.
3. Voila! Installation completed.

Setting up the Module

1. Sign up for an account on http://www.scribd.com
2. Get the API Key and Secret Key from Scribd. The procedure for getting your API key and Secret Key is described on http://support.scribd.com/entries/25453-where-can-i-find-my-api-key.
3. In Magento backend goto System–>Configuration–>MagDoc–>Settings.
4. Fill out the API key and Secret Key value you obtain from Scribd and save the settings.
5. Now the module is set up and ready to be used.

User Guide

1. Document can be uploaded on Scribd from Magento administration area. In admin area go to Magdoc–>Manage Document. You can add/edit/delete documents from here.
2. Documents can be assigned to product. Create or Edit any product. A new option for selecting the document for the product will be visible in the product edit area. But make sure the attribute “magdoc_id” is already in the attribute set of the product being edited. Select the required document and save the product.
3. Visit the product details page on the frontend. The document will be visible using Scribd Reader.

Developer Guide

To display Scribd document in the product details page. This should be placed in appropriate place. Also you can see that the height and width for the Scribd Reader can be configured from layout.

<block type="magdoc/magdoc" name="magdoc" template="magdoc/magdoc.phtml">
            	<action method="setDocumentHeight"><width>600px</width></action>
            	<action method="setDocumentWidth"><width>850px</width></action>
 </block>

Here’s a tip for showing the Scribd document on tabs on product details page.

<block type="catalog/product_view_tabs" name="product.info.tabs" as="info_tabs" template="catalog/product/view/tabs.phtml" >
                    <action method="addTab" translate="title" module="catalog">
                    	<alias>magdoc</alias>
                    	<title>Document</title>
                    	<block>magdoc/magdoc</block>
                    	<template>magdoc/magdoc.phtml</template>
                   	</action>
        </block>

I hope the module will be useful for the store owners. If you have any feedbacks, please report in the comment section below.

Disclaimer: Scribd is the property of Scribd Inc. This module is NOT the official module of Scribd.

[Note: I am describing here based on Ubuntu.]

Step 1: Download and Install Eclipse
Download and Install Eclipse. Choose the relevant package to download. Unzip the package and copy to some location. Lets say /home/user/ Please note that the Eclipse IDE requires that a Java Runtime Environment (JRE) be installed on your machine to run. Java SE 5 or greater is recommended.

Step 2: Setting up PHP Project
Next thing you have to do is to setup the project in Eclipse. Open the Eclipse IDE and it will ask for your Workspace. Browse to your workspace (Where your Magento site is running locally) or by default point it to /var/www and click OK. Now click on File–>New –> New PHP Project, and add your folder name on Project Name and click Finish. Eclipse will take few time on building your project, so take a coffee break if you want and be back in few minutes to go through the steps below.

Step 3: Installing X-Debugger

sudo apt-get install php5-xdebug

Step 4: Configure X-Debugger
Type this in your command prompt.

sudo gedit /etc/php5/apache2/conf.d/xdebug.ini

And add this settings on the .ini file

xdebug.remote_enable=1

And restart the apache server.

sudo /etc/init.d/apache2 restart

Step 5: Debug Configuration on Eclipse

On menu click Window–>Preference. Find PHP–>Debug Node in the left. When you click Debug you can see screen like this. Select PHP Debugger – XDebug.

To Set Server click PHP Servers and add new server as follows and click Finish.

Step 6: Configuring debug conf for Magento Projects

On menu click Run–> Debug Configurations. Find PHP Web Page and Right click for adding new configuration. Add something similar to like this.

Step 7: Add Break-Point and start debugging

Now almost all the settings are done. Now you can just add a break-point on your code and start debugging your script by clicking the BUG icon on the top bar.

Few tips though before you start.

1. Set up an external browser to run your debug configuation. Go to Window–>Preference and type in web browser in the top left search. And you will get a result. Click on Web Browser to select Use External Web Browser. If that is not clickable first click the restore default button and then the external web browser should be clickable.
2. You can enable multi-session debug, because you do not want to always click the debug button after each debug end. For that go to preference. Search for debug. Find PHP –> Debug –>Installed Debugger. Click the XDebug and then click configure. You can then Check the Use Multisession checkbox and save.

$connection = Mage::getSingleton('core/resource')->getConnection('default_setup');

Then we will use this connection to instanciate Zend_Db_Select object and write query like

$select = new Zend_Db_Select($connection);
$table = 'catalog_product_index_price';
$select->from($table, array('entity_id'))
	->where('entity_id = ?', $entityId);

// Getting result

$result = $select->query();
$rowCount = $result->rowCount();

if ($rowCount) {
	foreach ($result->fetchAll() as $data) {
		return $data['entity_id'];
	}
}

The above one is for select but what about inserting data? It is simple as well. All you have to do is create an associative array of data to be inserted and use connection to add data. For example

$connection = Mage::getSingleton('core/resource')->getConnection('default_setup');
$table = 'catalog_product_index_price';

$insertData = array();
$insertData ['price'] = $productPrice;
$insertData ['final_price'] = $productPrice;
$insertData ['min_price'] = $productPrice;
$insertData ['max_price'] = $productPrice;
$insertData ['tier_price'] = $productPrice;

$connection->insert($table, $insertData);

I think this should be a good enough code for using custom query in Magento. About Zend_Db_Select please visit http://framework.zend.com/manual/en/zend.db.select.html.

[UPDATE]

If you want to update the data with custom query and have a condition then you can send the conditions as array as third params to update function. For example.

$connection = Mage::getSingleton('core/resource')->getConnection('default_setup');
$table = 'catalog_product_index_price';

$updateCond = array(); // Update condition array container.
$insertData = array();
$insertData ['price'] = $productPrice;
$insertData ['final_price'] = $productPrice;
$insertData ['min_price'] = $productPrice;
$insertData ['max_price'] = $productPrice;
$insertData ['tier_price'] = $productPrice;

$updateCond [] = 'store_id = 0';
$updateCond [] = 'entity_id = 3';

$connection->insert($table, $insertData, $updateCond);

Happy Brogramming!!

Next place to look into will be .. Yes! the model eav/entity_increment_numeric. And if you see the model class Mage_Eav_Model_Entity_Increment_Numeric there is only one Method in this class the public function getNextId() which is responsible to the the Next increment ID, needless to say its parent has other methods as well since you might have already understood. So if some how you can trigger the right Increment Model for any entity type and the call this method, you must get the next increment ID of order/invoice/shippment.

That was the “prose” part now lets get down to the “code poetry”. Here’s how you first find the appropriate increment ID and then fetch the new Increment ID.

            //Get the Entity Type Increment Model you want, our case invoice
            // @var $entity_type_model Mage_Eav_Model_Entity_Type
            $entity_type_model=Mage::getSingleton('eav/config')->getEntityType('invoice');

            //Triggering the getNextId() of the Increment Model
            //@var $invoiceNew Mage_Sales_Model_Order_Invoice
            $new_incr_id = $entity_type_model->fetchNewIncrementId($invoiceNew->getOrder()->getStoreId());

Now, you have the generated Invoice Increment ID. This can be helpful in cases when you want to do something else before Invoice is created but you want to now the Increment Id before hand. Hope this helps.

The two conditions are:

1. If an element of the form already has a value, disable that form element.
2. On triggering an event by acting on some form element to change other form’s element’s attribute value.

If an element of the form already has a value, disable that form element

Lets take an example of core’s customer creation Admin form. What we can see while creating a customer from Admin end, the field “Associate to Website” is available to change for the first time. But when you are editing a customer info the very field is disabled. Lets see how this can be acheivable. If you look into Mage_Adminhtml_Block_Customer_Edit_Tab_Account class you can see the following chunk of code.

  if ($customer->getId()) {
            $form->getElement('website_id')->setDisabled('disabled');
            $form->getElement('created_in')->setDisabled('disabled');
        }

What this does is checks for the Id of the customer if it is present the form elements disabled attribute is set to disabled. So initially while creating a new customer this condition is not fulfilled while on edition of the customer data the condition is fulfilled and hence the form element website_id and the created_in are disabled. This was just an example, you can also write similar conditions for your custom form. Suppose your data for the current form is in $formData variable and then by checking certain field value you can add similar condition.

$formData=Mage::registry('current_custom_data');

if(!empty($formData->getMyField())){
	$targetElement=$form->getElement("my_field");

	//For Disabling the field (Value will not be posted on form submit)
	$targetElement->setDisabled('disabled');

	//Or for making the field readonly
	$targetElement->setReadonly(true);

}

On triggering an event by acting on some form element to change other form’s element’s attribute value

Lets take the same customer edition page, you can see a checkbox with label Send auto-generated password. If you check that checkbox then the New Password textfield above it gets disabled. To get the similar interactivity for custom form you will have to do as following.

$eventElem=$fieldset->addField('nocode', 'checkbox', array(
                'label' => Mage::helper('customer')->__('Event Element'),
                'name'  => 'eventelem',
                'id'    => 'eventelem',
				'value'=>1,
				'onclick'=>'modifyTargetElement(this)',
            ));

		$eventElem->setAfterElementHtml('<script>
			function modifyTargetElement(checkboxElem){
				if(checkboxElem.checked){
					$("target_element").disabled=true;
				}
				else{
					$("target_element").disabled=false;
				}
			}
		</script>');

What you can see is after an element of a form is initiallized you can add HTML codes (which of course for us is only Javascript code) by calling a setAfterElementHtml method and write the implementation of the function called on the event of the Event element.
I’ve tried to be more explanatory as possible, if you still have any confusion there is always a comment box below. Happy Coding!

Here’s the XML structure of layout from customer.xml where you add class to My Account link.

<!-- customer.xml-->
    <reference name="top.links">
        <action method="addLink" translate="label title" module="customer">
			<label>My Account</label>
			<url helper="customer/getAccountUrl"/>
			<title>My Account</title>
			<prepare/>
			<urlParams/>
			<class/>
			<position>10</position>
			<aParams>
				<class>my-class-name</class>
			</aParams>
		</action>
    </reference>
<!-- customer.xml-->

One notable thing in the structure above is the aParams which is responsible for adding the class to the Anchor tag, not the List tag. Hope this helps someone! Happy Coding.

I will try to describe this issue by taking a case of changing the Magento’s login functionality to a Ajax powered login functionality. So after this you will be able to implement a login function in a pop-up div in any page, unlike the default Magento’s seperate login page. I will leave the pop-up div part to you and get started with the real business (AJAX and JSON).

Presuming that you will use Mini-Login form. Here is how you proceed.

1. Change Submit type button to Button type button.
2. Register OnClick Javascript event of that button and its Handler
3. In the Handler function call Ajax Request for login
4. Show Error Message or redirect to customer Dashboard

Your mini.login.phtml should be like this

<form action="<?php //echo $this->getPostActionUrl() ?>" id="mini-login-form" method="post">
    <fieldset>
        <p><label><?php echo $this->__('Email') ?>:</label> <input name="login[username]" class="input-text" /></p>
        <p><label><?php echo $this->__('Password') ?>:</label> <input name="login[password]" class="input-text" /></p>
        <p><input type="button" onClick="handlerFunction()" value="<?php echo $this->__('Login') ?>" /></p>
    </fieldset>
</form>

<script type="text/javascript">
<!--
function handlerFunction(){

// Write These codes only after form Validation

// Making Ajax Request
		var request = new Ajax.Request(
			//Defining Ajax Request URL, We are calling custom Controller Ns_Mylogin_AccountController Class (Defined Below)
        	'<?php echo $this->getUrl("mylogin/account/loginPost") ?>',
           	{
            	method: 'post',
                onComplete: function(transport){ // Defining Complete Callback Function

                	// Getting Ajax Response Text Which is JSON Object
                	var jsonResponse=transport.responseText;
                	//Checking JSON Objects property and performing related action
                	// You will understand the response Text format after going through the controller description (Below)
                	if(jsonResponse.error){
                		alert("Error Occured");
						return false;
                	}
                	else{
                		window.location.href=jsonResponse.url;
                	}
                },
                parameters: Form.serialize($("mini-login-form"))	// Seriallizing the form input values
        	}
        );
}
//-->
</script>

Please see inline comments for better understanding. Now our next set should be setting up our custom controller. I’ll not get into details of setting up modules and all but directly to our controller class Ns_Mylogin_AccountController. What I’ve done is just taken the core’s loginPostAction function of Mage_Customer_AccountController and added some codes there. Please see there is a comment on each line added apart from the default Magento’s core code.

<?php
require_once("Mage/Customer/controllers/AccountController.php");
class Ns_Mylogin_AccountController extends Mage_Customer_AccountController{
	/**
	 * Login post action
	 * @return JSON Object
	 */
	public function loginPostAction()
	{
		// Added Line #1
		$result["error"]=0;

		$session = $this->_getSession();

		if ($this->getRequest()->isPost()) {
			$login = $this->getRequest()->getPost('login');
			if (!empty($login['username']) &amp;&amp; !empty($login['password'])) {
				try {
					$session->login($login['username'], $login['password']);
					if ($session->getCustomer()->getIsJustConfirmed()) {
						$this->_welcomeCustomer($session->getCustomer(), true);
					}
				} catch (Mage_Core_Exception $e) {
					switch ($e->getCode()) {
						case Mage_Customer_Model_Customer::EXCEPTION_EMAIL_NOT_CONFIRMED:
							//Added Line #2
							$result["error"]=1;
							$message = Mage::helper('customer')->__('This account is not confirmed. <a href="%s">Click here</a> to resend confirmation email.', 						Mage::helper('customer')->getEmailConfirmationUrl($login['username']));
							break;
						case Mage_Customer_Model_Customer::EXCEPTION_INVALID_EMAIL_OR_PASSWORD:
							//Added Line #3
							$result["error"]=1;
							$message = $e->getMessage();
							break;
						default:
							//Added Line #4
							$result["error"]=1;
							$message = $e->getMessage();
					}
					$session->addError($message);
					$session->setUsername($login['username']);
				} catch (Exception $e) {
					// Mage::logException($e); // PA DSS violation: this exception log can disclose customer password
				}
			} else {
				//Added Line #5
				$result["error"]=1;
				$session->addError($this->__('Login and password are required'));
				//Added Line #6
				$this->getResponse()->setBody(Mage::helper('core')->jsonEncode($result));
			}
		}
		//Added Line #7
		$result["url"]=$this->_loginPostRedirect();
		//Added Line #8
		$this->getResponse()->setBody(Mage::helper('core')->jsonEncode($result));
	}

What I’ve done is added an array $result that will hold value if there is error or not while processing the user’s request. If there is error that array will hold $result['error']=1 else it will be as initiallized in Added Line #1. From Added Line #2 through Added Line #5, we have various condition to check for error and set our $result variable.

On Added Line #7 we have called another function (which we we rewrite as well) that will give us the url location identifying which location should be redirect after successful login. The implementation of function is given below. Finally in Added Line #8 and Line #6 we have encoded our $result array into JSON format and send as the response.

For visuallization our $result array will be one of the following.

1. Case (No Error) : $result["error"]=0; $result["url"]=”SOME Redirect URL”
2. Case (Error) : $result["error"]=1;

This JSON encoded response will be then used by the ajax call back function defined and perform related action.

Here’s the _loginPostRedirect() function which I mentioned (Added Line #7).

/**
	 * Define target URL and redirect customer after logging in
	 */
	protected function _loginPostRedirect()
	{
		$session = $this->_getSession();

		if (!$session->getBeforeAuthUrl() || $session->getBeforeAuthUrl() == Mage::getBaseUrl() ) {

			// Set default URL to redirect customer to
			$session->setBeforeAuthUrl(Mage::helper('customer')->getAccountUrl());

			// Redirect customer to the last page visited after logging in
			if ($session->isLoggedIn())
			{
				if (!Mage::getStoreConfigFlag('customer/startup/redirect_dashboard')) {
					if ($referer = $this->getRequest()->getParam(Mage_Customer_Helper_Data::REFERER_QUERY_PARAM_NAME)) {
						$referer = Mage::helper('core')->urlDecode($referer);
						if ($this->_isUrlInternal($referer)) {
							$session->setBeforeAuthUrl($referer);
						}
					}
				}
				else if ($session->getAfterAuthUrl()) {
					$session->setBeforeAuthUrl($session->getAfterAuthUrl(true));
				}
			} else {
				$session->setBeforeAuthUrl(Mage::helper('customer')->getLoginUrl());
			}
		} else if ($session->getBeforeAuthUrl() == Mage::helper('customer')->getLogoutUrl()) {
			$session->setBeforeAuthUrl(Mage::helper('customer')->getDashboardUrl());
		}
		else {
			if (!$session->getAfterAuthUrl()) {
				$session->setAfterAuthUrl($session->getBeforeAuthUrl());
			}
			if ($session->isLoggedIn()) {
				$session->setBeforeAuthUrl($session->getAfterAuthUrl(true));
			}
		}
		// Changed Here
		return $session->getBeforeAuthUrl(true);
	}

You can download the code From Here.

Hope it helps! Happy Coding.

 <core>
 <rewrite>
 <locale>Namespace_Module_Model_Locale</locale>
 </rewrite>
 </core>
 

Then in Namespace_Module_Model_Locale class you can add the following code.

 class Namespace_Module_Model_Locale extends Mage_Core_Model_Locale{
 /*
 * Code: subesh.com.np
 */

public function currency($currency)
 {
 Varien_Profiler::start('locale/currency');
 if (!isset(self::$_currencyCache[$this->getLocaleCode()][$currency])) {
 try {
 $currencyObject = new Zend_Currency($currency, $this->getLocale());

// Additionally Added Code
 // The options array's position key has other values as well.

// 	Zend_Currency::STANDARD
 // 	Zend_Currency::RIGHT
 //	Zend_Currency::LEFT

$options = array(
 'position'	=> Zend_Currency::RIGHT
 );

$currencyObject->setFormat($options);

// END Additionally Added Code

} catch (Exception $e) {
 $currencyObject = new Zend_Currency($this->getCurrency(), $this->getLocale());
 $options = array(
 'name'      => $currency,
 'currency'  => $currency,
 'symbol'    => $currency
 );
 $currencyObject->setFormat($options);
 }

self::$_currencyCache[$this->getLocaleCode()][$currency] = $currencyObject;
 }
 Varien_Profiler::stop('locale/currency');
 return self::$_currencyCache[$this->getLocaleCode()][$currency];
 }

}

You can see the comment of the code above for more detail understanding.

P.S: Be informed that you need to change the Class Name you are about to create on the basis of your Namespace and Module name.

/*** Setting Default Shipping Method
 * Checking If Quote Already Has Address Or Not
 * - If Yes then leave as it is
 * - Else check if Customer has default Shipping Address or Not
 * -- Yes then get Default Shipping Address and set Shipping Method
 * -- No Set Default Shipping address to NL*/
 if(!Mage::getSingleton('checkout/type_onepage')->getQuote()->getShippingAddress()->getCountryId()){
		$customerSession=Mage::getSingleton("customer/session");
		if($customerSession->isLoggedIn()){
		$customerAddress=$customerSession->getCustomer()->getDefaultShippingAddress();
			if($customerAddress->getId()){
			$customerCountry=$customerAddress->getCountryId();
				$shipping = Mage::getSingleton('checkout/type_onepage')->getQuote()->getShippingAddress()->setCountryId($customerCountry)->setShippingMethod('flatrate_flatrate')->save();
		}else{
			$shipping = Mage::getSingleton('checkout/type_onepage')->getQuote()->getShippingAddress()->setCountryId('NL')->setShippingMethod('flatrate_flatrate')->save();
			}
		}
	}

Cheers!

[UPDATE]
The original solution seems to show some issue. Thanks to the great reader of this blog the “perfect” solution for this case can be found in comments. As always new and better solutions are always welcome.