Улучшение качества кода в CakePHP
Я использую CakePHP уже несколько недель, и это был отличный опыт. Мне удалось быстро вывести сайт на сайт, и я даже добавил множество новых функций, которые я планировал, но так и не смог реализовать.
Взгляните на следующие два контроллера: они позволяют пользователю добавлять статус премиум-статуса на один из сайтов, связанных с их учетной записью. Они не чувствуют себя очень "тошнотворными", могут ли они быть улучшены каким-либо образом?
Контроллер PremiumSites обрабатывает процесс регистрации и в конечном итоге будет иметь другие связанные вещи, такие как история.
class PremiumSitesController extends AppController {
var $name = 'PremiumSites';
function index() {
$cost = 5;
//TODO: Add no site check
if (!empty($this->data)) {
if($this->data['PremiumSite']['type'] == "1") {
$length = (int) $this->data['PremiumSite']['length'];
$length++;
$this->data['PremiumSite']['upfront_weeks'] = $length;
$this->data['PremiumSite']['upfront_expiration'] = date('Y-m-d H:i:s', strtotime(sprintf('+%s weeks', $length)));
$this->data['PremiumSite']['cost'] = $cost * $length;
} else {
$this->data['PremiumSite']['cost'] = $cost;
}
$this->PremiumSite->create();
if ($this->PremiumSite->save($this->data)) {
$this->redirect(array('controller' => 'paypal_notifications', 'action' => 'send', $this->PremiumSite->getLastInsertID()));
} else {
$this->Session->setFlash('Please fix the problems below', true, array('class' => 'error'));
}
}
$this->set('sites',$this->PremiumSite->Site->find('list',array('conditions' => array('User.id' => $this->Auth->user('id'), 'Site.is_deleted' => 0), 'recursive' => 0)));
}
}
код >
Контроллер PaypalNotifications обрабатывает взаимодействие с Paypal.
class PaypalNotificationsController extends AppController {
var $name = 'PaypalNotifications';
function beforeFilter() {
parent::beforeFilter();
$this->Auth->allow('process');
}
/**
* Compiles premium info and send the user to Paypal
*
* @param integer $premiumID an id from PremiumSite
* @return null
*/
function send($premiumID) {
if(empty($premiumID)) {
$this->Session->setFlash('There was a problem, please try again.', true, array('class' => 'error'));
$this->redirect(array('controller' => 'premium_sites', 'action' => 'index'));
}
$data = $this->PaypalNotification->PremiumSite->find('first', array('conditions' => array('PremiumSite.id' => $premiumID), 'recursive' => 0));
if($data['PremiumSite']['type'] == '0') {
//Subscription
$paypalData = array(
'cmd' => '_xclick-subscriptions',
'business'=> '',
'notify_url' => '',
'return' => '',
'cancel_return' => '',
'item_name' => '',
'item_number' => $premiumID,
'currency_code' => 'USD',
'no_note' => '1',
'no_shipping' => '1',
'a3' => $data['PremiumSite']['cost'],
'p3' => '1',
't3' => 'W',
'src' => '1',
'sra' => '1'
);
if($data['Site']['is_premium_used'] == '0') {
//Apply two week trial if unused
$trialData = array(
'a1' => '0',
'p1' => '2',
't1' => 'W',
);
$paypalData = array_merge($paypalData, $trialData);
}
} else {
//Upfront payment
$paypalData = array(
'cmd' => '_xclick',
'business'=> '',
'notify_url' => '',
'return' => '',
'cancel_return' => '',
'item_name' => '',
'item_number' => $premiumID,
'currency_code' => 'USD',
'no_note' => '1',
'no_shipping' => '1',
'amount' => $data['PremiumSite']['cost'],
);
}
$this->layout = null;
$this->set('data', $paypalData);
}
/**
* IPN Callback from Paypal. Validates data, inserts it
* into the db and triggers __processTransaction()
*
* @return null
*/
function process() {
//Original code from http://www.studiocanaria.com/articles/paypal_ipn_controller_for_cakephp
//Have we been sent an IPN here...
if (!empty($_POST)) {
//...we have so add 'cmd' 'notify-validate' to a transaction variable
$transaction = 'cmd=_notify-validate';
//and add everything paypal has sent to the transaction
foreach ($_POST as $key => $value) {
$value = urlencode(stripslashes($value));
$transaction .= "&$key=$value";
}
//create headers for post back
$header = "POST /cgi-bin/webscr HTTP/1.0\r\n";
$header .= "Content-Type: application/x-www-form-urlencoded\r\n";
$header .= "Content-Length: " . strlen($transaction) . "\r\n\r\n";
//If this is a sandbox transaction then 'test_ipn' will be set to '1'
if (isset($_POST['test_ipn'])) {
$server = 'www.sandbox.paypal.com';
} else {
$server = 'www.paypal.com';
}
//and post the transaction back for validation
$fp = fsockopen('ssl://' . $server, 443, $errno, $errstr, 30);
//Check we got a connection and response...
if (!$fp) {
//...didn't get a response so log error in error logs
$this->log('HTTP Error in PaypalNotifications::process while posting back to PayPal: Transaction=' .
$transaction);
} else {
//...got a response, so we'll through the response looking for VERIFIED or INVALID
fputs($fp, $header . $transaction);
while (!feof($fp)) {
$response = fgets($fp, 1024);
if (strcmp($response, "VERIFIED") == 0) {
//The response is VERIFIED so format the $_POST for processing
$notification = array();
//Minor change to use item_id as premium_site_id
$notification['PaypalNotification'] = array_merge($_POST, array('premium_site_id' => $_POST['item_number']));
$this->PaypalNotification->save($notification);
$this->__processTransaction($this->PaypalNotification->id);
} else
if (strcmp($response, "INVALID") == 0) {
//The response is INVALID so log it for investigation
$this->log('Found Invalid:' . $transaction);
}
}
fclose($fp);
}
}
//Redirect
$this->redirect('/');
}
/**
* Enables premium site after payment
*
* @param integer $id uses id from PaypalNotification
* @return null
*/
function __processTransaction($id) {
$transaction = $this->PaypalNotification->find('first', array('conditions' => array('PaypalNotification.id' => $id), 'recursive' => 0));
$txn_type = $transaction['PaypalNotification']['txn_type'];
if($txn_type == 'subscr_signup' || $transaction['PaypalNotification']['payment_status'] == 'Completed') {
//New subscription or payment
$data = array(
'PremiumSite' => array(
'id' => $transaction['PremiumSite']['id'],
'is_active' => '1',
'is_paid' => '1'
),
'Site' => array(
'id' => $transaction['PremiumSite']['site_id'],
'is_premium' => '1'
)
);
//Mark trial used only on subscriptions
if($txn_type == 'subscr_signup') $data['Site']['is_premium_used'] = '1';
$this->PaypalNotification->PremiumSite->saveAll($data);
} elseif($txn_type == 'subscr-cancel' || $txn_type == 'subscr-eot') {
//Subscription cancellation or other problem
$data = array(
'PremiumSite' => array(
'id' => $transaction['PremiumSite']['id'],
'is_active' => '0',
),
'Site' => array(
'id' => $transaction['PremiumSite']['site_id'],
'is_premium' => '0'
)
);
$this->PaypalNotification->PremiumSite->saveAll($data);
}
}
/**
* Used for testing
*
* @return null
*/
function index() {
$this->__processTransaction('3');
}
}
код >
/views/paypal_notifications/send.ctp
Отправляет пользователя в Paypal вместе со всеми необходимыми данными
echo "<html>\n";
echo "<head><title>Processing Payment...</title></head>\n";
echo "<body onLoad=\"document.form.submit();\">\n";
echo "<center><h3>Redirecting to paypal, please wait...</h3></center>\n";
echo $form->create(null, array('url' => 'https://www.sandbox.paypal.com/cgi-bin/webscr', 'type' => 'post', 'name' => 'form'));
foreach ($data as $field => $value) {
//Using $form->hidden sends in the cake style, data[PremiumSite][whatever]
echo "<input type=\"hidden\" name=\"$field\" value=\"$value\">";
}
echo $form->end();
echo "</form>\n";
echo "</body></html>\n";
код >
Ответы
Ответ 1
Урок 1. Не используйте суперглобальные переменные PHP
-
$_POST
= $this->params['form'];
-
$_GET
= $this->params['url'];
-
$_GLOBALS
= Configure::write('App.category.variable', 'value');
-
$_SESSION
(view) = $session->read();
(помощник)
-
$_SESSION
(controller) = $this->Session->read();
(компонент)
-
$_SESSION['Auth']['User']
= $this->Auth->user();
Замены для $_POST
:
<?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'])) {
...
?>
Урок 2. Представления предназначены для совместного использования (с пользователем).
Код, документированный "Информация о премиях Compiles и отправке пользователю в Paypal", не отправляет пользователя в PayPal. Вы перенаправляетесь в представление?
<?php
function redirect($premiumId) {
...
$this->redirect($url . '?' . http_build_query($paypalData), 303);
}
Перенаправить в конец вашего контроллера и удалить представление.:)
Урок 3: манипуляция данными принадлежит к слою модели
<?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;
}
...
}
?>
Урок 4. Модели предназначены не только для доступа к базе данных.
Переместить код с документами "Включает премиальный сайт после оплаты" модели PremiumSite и вызвать ее после оплаты:
<?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);
}
...
}
?>
Вы могли бы позвонить из контроллера с помощью $this->PaypalNotification->PremiumSite->enable(...);
, но мы этого не сделаем, поэтому давайте смешаем все это вместе...
Урок 5. Источники данных классные.
Расскажите о своих IPN-взаимодействиях PayPal в источнике данных, который используется моделью.
Конфигурация идет в app/config/database.php
<?php
class DATABASE_CONFIG {
...
var $paypal = array(
'datasource' => 'paypal_ipn',
'sandbox' => true,
'api_key' => 'w0u1dnty0ul1k3t0kn0w',
}
...
}
?>
Datasource обрабатывает запросы веб-сервисов (app/models/datasources/paypal_ipn_source.php
)
<?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
}
...
}
?>
Пусть модель выполняет работу (app/models/paypal_notification.php
)
Уведомления сохраняются только в том случае, если они действительны, сайты разрешены только в том случае, если уведомление сохранено
<?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);
}
...
?>
Контроллеры тупые. (app/controllers/paypal_notifications_controller.php
)
"Вы почта? Нет?.. тогда я даже не существую". Теперь это действие просто кричит: "Я сохраняю опубликованные уведомления PayPal!"
<?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');
}
}
...
}
?>
Бонусный раунд: используйте предоставленные библиотеки вместо собственного PHP
Обратитесь к предыдущим урокам для следующих примеров:
-
String
вместо sprintf
-
HttpSocket
вместо fsock
функций
-
RequestHandler
вместо ручных проверок
-
am
вместо array_merge
Они могут предотвращать ошибки кодирования, уменьшать количество кода и/или повышать читаемость.
Ответ 2
За исключением всех вещей, отмеченных deizel (отличный пост), помните один из основных принципов пирога: жирные модели, тощие контроллеры. Вы можете проверить этот пример, но основная идея - поместить все ваши данные в ваши модели. Ваш контроллер должен (в основном) быть только ссылкой между вашими моделями и представлениями. Ваш PremiumSitesController:: index() является прекрасным примером того, что должно быть где-то в вашей модели (как указано deizel).
Chris Hartjes также написал книгу о рефакторинге, вы можете захотеть взглянуть на него, если вы действительно хотите учиться (это не бесплатно, но это дешево, хотя). Кроме того, Matt Curry имеет один, с классным именем: Super Awesome Advanced CakePHP Tips, и он полностью бесплатный для скачивания. Оба делают хорошее чтение.
Я также хотел бы подключить свою собственную статью о тортах, которые, как мне кажется, важны для качества кода в торте: Форматирование и читаемость кода. Хотя я понимаю, если люди не согласны..: -)
Ответ 3
Хорошо бы отметить эти две вещи:
- у вас есть много жестко закодированных конфигурационных материалов... используйте cake Configure, чтобы сделать это... как
$cost
в первом контроллере или $paypalData... вы можете получить его из другого места, если хотите (например, флешка должна поступать из языковых файлов), но не смешивать конфигурацию с реализацией... это будет сделать классы более читабельными, а обслуживание намного проще...
- инкапсулировать весь материал сокета в новый класс-помощник... вам может понадобиться его в другом месте... и действительно, он запутывает то, что происходит... также, подумайте о том, чтобы переместить другие части вашего контроллера boa... например, просто подталкивать к нему какой-то другой класс, что делает реализацию... вы всегда должны стараться иметь небольшие и сжатые передние контроллеры, потому что гораздо легче понять, что происходит... если кто-то заботится о деталях реализации, он может загляните в соответствующий класс...
что я думаю, это торт...
Greetz
back2dos