StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p><strong>Lesson 1</strong>: Don't use PHP's superglobals</p> <ul> <li><code>$_POST</code> = <code>$this->params['form'];</code></li> <li><code>$_GET</code> = <code>$this->params['url'];</code></li> <li><code>$_GLOBALS</code> = <code>Configure::write('App.category.variable', 'value');</code></li> <li><code>$_SESSION</code> (view) = <code>$session->read();</code> (helper)</li> <li><code>$_SESSION</code> (controller) = <code>$this->Session->read();</code> (component)</li> <li><code>$_SESSION['Auth']['User']</code> = <code>$this->Auth->user();</code></li> </ul> <p>Replacements for <code>$_POST</code>: </p> <pre><code><?php ... //foreach ($_POST as $key => $value) { foreach ($this->params['form'] as $key => $value) { ... //if (isset($_POST['test_ipn'])) { if (isset($this->params['form']['test_ipn'])) { ... ?> </code></pre> <p><strong>Lesson 2</strong>: Views are for sharing (with the user)</p> <p>Code documented "Compiles premium info and send the user to Paypal" doesn't send the user to PayPal. Are you redirecting in the view?</p> <pre><code><?php function redirect($premiumId) { ... $this->redirect($url . '?' . http_build_query($paypalData), 303); } </code></pre> <p>Redirect at the end of your controller and delete the view. :)</p> <p><strong>Lesson 3</strong>: Data manipulation belongs in model layer</p> <pre><code><?php class PremiumSite extends AppModel { ... function beforeSave() { if ($this->data['PremiumSite']['type'] == "1") { $cost = Configure::read('App.costs.premium'); $numberOfWeeks = ((int) $this->data['PremiumSite']['length']) + 1; $timestring = String::insert('+:number weeks', array( 'number' => $numberOfWeeks, )); $expiration = date('Y-m-d H:i:s', strtotime($timestring)); $this->data['PremiumSite']['upfront_weeks'] = $weeks; $this->data['PremiumSite']['upfront_expiration'] = $expiration; $this->data['PremiumSite']['cost'] = $cost * $numberOfWeeks; } else { $this->data['PremiumSite']['cost'] = $cost; } return true; } ... } ?> </code></pre> <p><strong>Lesson 4</strong>: Models aren't just for database access</p> <p>Move code documented "Enables premium site after payment" to PremiumSite model, and call it after payment:</p> <pre><code><?php class PremiumSite extends AppModel { ... function enable($id) { $transaction = $this->find('first', array( 'conditions' => array('PaypalNotification.id' => $id), 'recursive' => 0, )); $transactionType = $transaction['PaypalNotification']['txn_type']; if ($transactionType == 'subscr_signup' || $transaction['PaypalNotification']['payment_status'] == 'Completed') { //New subscription or payment ... } elseif ($transactionType == 'subscr-cancel' || $transactionType == 'subscr-eot') { //Subscription cancellation or other problem ... } return $this->saveAll($data); } ... } ?> </code></pre> <p>You would call from controller using <code>$this->PaypalNotification->PremiumSite->enable(...);</code> but we aren't going to do that, so let's mix it all together...</p> <p><strong>Lesson 5</strong>: Datasources are cool</p> <p>Abstract your PayPal IPN interactions into a datasource which is used by a model.</p> <p>Configuration goes in <code>app/config/database.php</code></p> <pre><code><?php class DATABASE_CONFIG { ... var $paypal = array( 'datasource' => 'paypal_ipn', 'sandbox' => true, 'api_key' => 'w0u1dnty0ul1k3t0kn0w', } ... } ?> </code></pre> <p>Datasource deals with web service requests (<code>app/models/datasources/paypal_ipn_source.php</code>)</p> <pre><code><?php class PaypalIpnSource extends DataSource { ... var $endpoint = 'http://www.paypal.com/'; var $Http = null; var $_baseConfig = array( 'sandbox' => true, 'api_key' => null, ); function _construct() { if (!$this->config['api_key']) { trigger_error('No API key specified'); } if ($this->config['sandbox']) { $this->endpoint = 'http://www.sandbox.paypal.com/'; } $this->Http = App::import('Core', 'HttpSocket'); // use HttpSocket utility lib } function validate($data) { ... $reponse = $this->Http->post($this->endpoint, $data); .. return $valid; // boolean } ... } ?> </code></pre> <p>Let the model do the work (<code>app/models/paypal_notification.php</code>)</p> <p>Notifications are only saved if they are valid, sites are only enabled if the notification is saved </p> <pre><code><?php class PaypalNotification extends AppModel { ... function beforeSave() { $valid = $this->validate($this->data); if (!$valid) { return false; } //Minor change to use item_id as premium_site_id $this->data['PaypalNotification']['premium_site_id'] = $this->data['PaypalNotification']['item_number']; /* $this->data['PaypalNotification'] = am($this->data, // use shorthand functions array('premium_site_id' => $this->data['item_number'])); */ return true; } ... function afterSave() { return $this->PremiumSite->enable($this->id); } ... function validate($data) { $paypal = ConnectionManager::getDataSource('paypal'); return $paypal->validate($data); } ... ?> </code></pre> <p>Controllers are dumb. (<code>app/controllers/paypal_notifications_controller.php</code>)</p> <p>"Are you a post? No? .. then I don't even exist." Now this action just shouts, "I save posted PayPal notifications!"</p> <pre><code><?php class PaypalNotificationsController extends AppModel { ... var $components = array('RequestHandler', ...); ... function callback() { if (!$this->RequestHandler->isPost()) { // use RequestHandler component $this->cakeError('error404'); } $processed = $this->PaypalNotification->save($notification); if (!$processed) { $this->cakeError('paypal_error'); } } ... } ?> </code></pre> <p><strong>Bonus Round</strong>: Use provided libraries instead of native PHP</p> <p>Refer to previous lessons for examples of the following:</p> <ul> <li><code>String</code> instead of <code>sprintf</code></li> <li><code>HttpSocket</code> instead of <code>fsock</code> functions</li> <li><code>RequestHandler</code> instead of manual checks</li> <li><code>am</code> instead of <code>array_merge</code></li> </ul> <p>These can prevent coding errors, reduce amount of code and/or increase readability.</p>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload