Error Reporting in ZF2: form messages, custom error pages, logging

Error Reporting
in Zend Framework 2

Zend Framework Day – Turin, Italy – 07/02/2014

Application Failures
User Mistakes

User Privacy Concerns
• Over 40% of online shoppers are very
concerned over the use of personal
information
• Public opinion polls have revealed a
general desire among Internet users to
protect their privacy
Online Privacy: A Growing Threat. - Business Week, March 20, 2000, 96. Internet Privacy in ECommerce:
Framework, Review, and Opportunities for Future Research - Proceedings of the 41st Hawaii
International Conference on System Sciences - 2008

Creating A Form in ZF2
<?php
namespace ApplicationForm;
use ZendFormForm;
class ContactForm extends Form
{
public function __construct() {
parent::__construct();
// ...
}
//...
}

Adding Form Fields
public function init() {
$this->setName('contact');
$this->setAttribute('method', 'post');
[…]..
$this->add(array('name' => 'email',
'type' => 'text',
'options' => array(
'label' => 'Name',
),
);
$this->add(array('name' => 'message',
'type' => 'textarea',
'options' => array(
'label' => 'Message',
),
);
//. […]..
}

Validation: inputFilter
<?php
namespace ApplicationForm;
[…]
class ContactFilter extends InputFilter

{
public function __construct() {

// filters go here
}

}

Required Field Validation
$this->add(array(
'name' => 'email',
'required' => true,
'filters' => array(
array(
'name' => 'StringTrim'),
),
'validators' => array(
array(
'name' => 'EmailAddress',
)
)
));

InputFilter Usage
<?php
namespace ApplicationController;

[…]
class IndexController extends AbstractActionController
{

public function contactAction()
{
$form = new Contact();
$filter = new ContactFilter();

$form->setInputFilter($filter);
return new ViewModel(array(
'form' => $form );

}
}

Error Message Customization
$this->add(array(
'name' => 'email',

'required' => true,
'filters' => array(
array('name' => 'StringTrim'),
),

array('name' =>'NotEmpty',
'options' => array(
'messages' => array(
NotEmpty::IS_EMPTY => 'We need an '.
'e-mail address to be able to get back to you'
),
),
),
array('name' => 'EmailAddress'),

)
));

Check Chain
$this->add(array(
'name' => 'email',

'required' => true,
'filters' => array(
array('name' => 'StringTrim'),
),

'options' => array(
),
),
'break_chain_on_failure' => true,
),

array('name' => 'EmailAddress'),
) ));

Words to Avoid

http://uxmovement.com/forms/how-to-make-your-form-error-messages-more-reassuring/

A few tips:
•

•

•

45

Provide the user with a solution to the
problem
Do not use technical jargon, use
terminology that your audience
understands
Avoid uppercase text and exclamation
points

Condensing N messages into 1
$this->add(array(
'name' => 'email',

'required' => true,
'options' => array(

)),
),
array('name' => 'EmailAddress',
'options' => array(
'message' => 'E-Mail address does not seem to be valid.
Please make sure it contains the @ symbol

and a valid domain name.',
)));

Messages VS message
$this->add(array(
'name' => 'email',

'required' => true,
'options' => array(

)),
),
array('name' => 'EmailAddress',
'options' => array(
'message' => 'E-Mail address does not seem to be valid.
Please make sure it contains the @ symbol

and a valid domain name.',
)));

Default Message Translation
public function onBootstrap(MvcEvent $e)
{
$translator = $e->getApplication()
->getServiceManager()->get('translator');

$translator->addTranslationFile(
'phpArray', __DIR__ .
'/../../vendor/zendframework/zendframework/'.
'resources/languages/it/Zend_Validate.php',
'default',
'it_IT'
);
AbstractValidator::setDefaultTranslator($translator);
}

Custom Message Translation
$this->add(array(
'name' => 'email',
'required' => true,
'options' => array(
'translator' => $translator,
'message' => $translator->translate(
'Make sure your e-mail address contains the @
symbol and a valid domain name.'
)),
),
)));

Form Factory
$translator = $I_services->get('translator');
$I_form = new Contact();
$I_filter = new ContactFilter($translator);
$I_form->setInputFilter($I_filter);
return $I_form;

http://patterntap.com/pattern/funny-and-helpful-404-error-page-mintcom

Error Display Configuration
Skeleton Applicaton
Configuration

Hiding Exception Traces
'view_manager' => array(

'display_not_found_reason' => false,
'display_exceptions' => false,
'doctype' => 'HTML5',
'not_found_template' => 'error/404',
'exception_template' => 'error/index',
'template_map' => array(
'layout/layout' => __DIR__ . '/../view/layout/layout.phtml',
'application/index/index'=> __DIR__ .
'/../view/application/index/index.phtml',
'error/404' => __DIR__ . '/../view/error/404.phtml',
'error/index' => __DIR__ . '/../view/error/index.phtml',
),
'template_path_stack' => array(
__DIR__ . '/../view',
),
),

Custom Error Pages
'view_manager' => array(

'display_not_found_reason' => false,
'display_exceptions' => false,
'doctype' => 'HTML5',
'not_found_template' => 'error/404',
'exception_template' => 'error/index',
'template_map' => array(
'layout/layout' => __DIR__ . '/../view/layout/layout.phtml',
'application/index/index'=> __DIR__ .
'/../view/application/index/index.phtml',
'error/404' => __DIR__ . '/../view/error/404.phtml',
'error/index' => __DIR__ . '/../view/error/index.phtml',
),
'template_path_stack' => array(
__DIR__ . '/../view',
),
),

How about PHP Errors?
{
public function indexAction()
{

1/0;
return new ViewModel();
}
}

Early error detection principle

Handling PHP Errors
public function onBootstrap(MvcEvent $I_e) {
[…]
set_error_handler(array('ApplicationModule','handlePhpErrors'));
}
public static function handlePhpErrors($i_type,
$s_message,
$s_file,
$i_line) {
if (!($i_type & error_reporting())) { return };

throw new Exception("Error: " . $s_message . " in file " . $s_file
. " at line " . $i_line);
}

What happens now?
{
{

1/0;
}
}

Now… what if?
{
{
$doesNotExist->doSomething();
}
}

Fatal error: Call to a member function doSomething() on a non-object in
/srv/apps/zfday/module/Application/src/Application/Controller/IndexController.php
on line 20

Fatal Error Handling
[…]
$am_config = $I_application->getConfig();
$am_environmentConf = $am_config['mvlabs_environment'];
// Fatal Error Recovery
if (array_key_exists('recover_from_fatal', $am_environmentConf) &&
$am_environmentConf['recover_from_fatal']) {
$s_redirectUrl = $am_environmentConf['redirect_url'];
}
$s_callback = null;
if (array_key_exists('fatal_errors_callback', $am_environmentConf)) {
$s_callback = $am_environmentConf['fatal_errors_callback'];
}
register_shutdown_function(array('ApplicationModule',
'handleFatalPhpErrors'),
$s_redirectUrl,
$s_callback);
}

/**
* Redirects user to nice page after fatal has occurred
*/
public static function handleFatalPhpErrors($s_redirectUrl,
$s_callback = null) {
if (php_sapi_name() != 'cli' && @is_Array($e = @get_last())) {
if (null != $s_callback) {
// This is the most stuff we can get.
// New context outside of framework scope
$m_code = isset($e['type']) ? $e['type'] : 0;
$s_msg = isset($e['message']) ? $e['message']:'';
$s_file = isset($e['file']) ? $e['file'] : '';
$i_line = isset($e['line']) ? $e['line'] : '';
$s_callback($s_msg, $s_file, $i_line);
}
header("location: ". $s_redirectUrl);
}
return false;
}

'mvlabs_environment' => array(
'exceptions_from_errors' => true,
'recover_from_fatal' => true,
'fatal_errors_callback' => function($s_msg, $s_file, $s_line) {
return false;
},
'redirect_url' => '/error',

'php_settings' => array(
'error_reporting' => E_ALL,
'display_errors' => 'Off',
'display_startup_errors' => 'Off',
),
),

PHP Settings Conf
'mvlabs_environment' => array(
'exceptions_from_errors' => true,
'recover_from_fatal' => true,
'fatal_errors_callback' => function($s_msg, $s_file, $s_line) {
return false;
},
'redirect_url' => '/error',

'php_settings' => array(
'error_reporting' => E_ALL,
'display_errors' => 'Off',
'display_startup_errors' => 'Off',
),
),

PHP Settings
[…]
foreach($am_phpSettings as $key => $value) {
ini_set($key, $value);
}
}

CUSTOMER SUPPORT TEAM REACTION
http://www.flickr.com/photos/18548283@N00/8030280738

ENVIRONMENT
DEPENDANT
CONFIGURATION

Local/Global Configuration Files

Index.php
// Application wide configuration
$am_conf = $am_originalConf = require 'config/application.config.php';

// Environment specific configuration
$s_environmentConfFile = 'config/application.'.$s_env.'.config.php';
if (file_exists($s_environmentConfFile) &&
is_readable($s_environmentConfFile)) {
// Specific environment configuration merge
$am_environmentConf = require $s_environmentConfFile;
$am_conf = ZendStdlibArrayUtils::merge($am_originalConf,
$am_environmentConf
);
}

// Additional Specific configuration files are also taken into account
$am_conf["module_listener_options"]["config_glob_paths"][] =
'config/autoload/{,*.}' . $s_env . '.php';
ZendMvcApplication::init($am_conf)->run();

application.config.php
'modules' => array(
'Application',
),

Application.dev.config.php
'modules' => array(
'Application',
'ZendDeveloperTools',
),

Enabling Environment Confs
// Application nominal environment
$am_conf = $am_originalConf = require 'config/application.config.php';

// Environment specific configuration
$s_environmentConfFile = 'config/application.'.$s_env.'.config.php';
// Do we have a specific configuration file?
if (file_exists($s_environmentConfFile) &&
is_readable($s_environmentConfFile)) {
// Specific environment configuration merge
$am_environmentConf = require $s_environmentConfFile;
$am_conf = ZendStdlibArrayUtils::merge($am_originalConf,
$am_environmentConf );
}

// Additional Specific configuration files are also taken into account
$am_conf["module_listener_options"]["config_glob_paths"][] =
'config/autoload/{,*.}' . $s_env . '.php';
ZendMvcApplication::init($am_conf)->run();

index.php Check
// What environment are we in?
$s_env = getenv('APPLICATION_ENV');
if (empty($s_env)) {
throw new Exception('Environment not set.'.
' Cannot continue. Too risky!');
}

Apache Config File
<VirtualHost *:80>
DocumentRoot /srv/apps/zfday/public
ServerName www.dev.zfday.it
SetEnv APPLICATION_ENV "dev"
<Directory /srv/apps/zfday/public>
AllowOverride FileInfo
</Directory>
</VirtualHost>

LOGGING

http://www.flickr.com/photos/otterlove/8154505388/

Why Log?

Troubleshooting
• Stats Generation
• Compliance
•

95

Zend Log
$logger = new ZendLogLogger;
$writer = new ZendLogWriterStream('/var/log/app.log');
$logger->addWriter($writer);
$logger->info('Informational message');
$logger->log(ZendLogLogger::EMERG, 'Emergency message');

Zend Log
$writer = new ZendLogWriterStream('/var/log/app.log');
$logger->addWriter($writer);
$logger->log(ZendLogLogger::EMERG, 'Emergency message');
ZendLogLogger::registerErrorHandler($logger);
ZendLogLogger::registerExceptionHandler($logger);

Logrotate
/var/log/app.log {
missingok
rotate 7
daily
notifempty
copytruncate
compress
endscript
}
100

Filter Example
$writer1 = new ZendLogWriterStream('/var/log/app.log');
$logger->addWriter($writer1);
$writer2 = new ZendLogWriterStream('/var/log/err.log');
$logger->addWriter($writer2);
$filter = new ZendLogFilterPriority(Logger::CRIT);
$writer2->addFilter($filter);
$logger->log(ZendLogLogger::CRIT, 'Emergency message');

Monolog
use MonologLogger;
use MonologHandlerStreamHandler;
$log = new Logger('name');
$log->pushHandler(new StreamHandler('/var/log/app.log',
Logger::WARNING));
$log->addWarning('Foo');
$log->addError('Bar');

How to log?
class IndexController {

public function helloAction() {
return new ViewModel('msg' =>"Hello!");

}
}

Logging Within Controller
class GreetingsController {
$I_logger = new Logger();
$I_logger->log("We just said Hello!");
}
}

Single Responsability Violation
}
}

Fat Controllers

$I_mailer = new Mailer();
$I_mailer->mail($s_msg);
$I_queue = new Queue();
$I_queue->add($s_msg);
}
}

Handling Events
class Module {
public function onBootstrap(MvcEvent $e) {
$eventManager = $e->getApplication()
->getEventManager();
$moduleRouteListener = new ModuleRouteListener();
$moduleRouteListener->attach($eventManager);
$logger = $sm->get('logger');
$eventManager->attach('wesaidHello',
function(MvcEvent $event) use
($logger) {
$logger->log($event->getMessage());
);
}
}

Triggering An Event

$this->eventManager
->trigger('wesaidHello',
$this,
array('greeting' => 'Hello!')
);
return new ViewModel('msg' => "Hello!");
}
}

OBSERVER
http://www.flickr.com/photos/lstcaress/502606063/

Handling Framework Errors
class Module {
public function onBootstrap(MvcEvent $e) {
$eventManager = $e->getApplication()
->getEventManager();
$moduleRouteListener = new ModuleRouteListener();
$moduleRouteListener->attach($eventManager);

$logger = $sm->get('logger');
$eventManager->attach(MvcEvent::EVENT_RENDER_ERROR,
function(MvcEvent $e) use ($logger) {
$logger->info('An exception has Happened ' .
$e->getResult()->exception->getMessage());
}, -200);
);
}
}

Stuff to take home
1.
2.
3.

123

When reporting errors, make sure to be
nice with users
Different error reporting strategies could
be useful for different environments
The event manager reduces coupling and
provides flexibility

Starting Things Up
input { stdin { } }
output { stdout { codec => rubydebug } }

Starting Things Up
input { stdin { } }
output { stdout { codec => rubydebug } }
java -jar logstash-1.3.3-flatjar.jar agent -f sample.conf

Integrated Elasticsearch
input {

file { path => ["/opt/logstash/example.log"] }
}
output {
stdout { codec => rubydebug }
elasticsearch { embedded => true }
}
java -jar logstash-1.3.3-flatjar.jar agent -f elastic.conf

Integrated Web Interface
input {

file { path => ["/opt/logstash/example.log"] }
}
output {
stdout { codec => rubydebug }
elasticsearch { embedded => true }
}
java -jar logstash.jar agent -f elastic.conf --web

Thank you for your attention

Stefano Maraspin
@maraspin

Error Reporting in ZF2: form messages, custom error pages, logging

Recommended

Recommended

More Related Content

What's hot

What's hot (19)

Viewers also liked

Viewers also liked (17)

Similar to Error Reporting in ZF2: form messages, custom error pages, logging

Similar to Error Reporting in ZF2: form messages, custom error pages, logging (20)

More from Steve Maraspin

More from Steve Maraspin (19)

Recently uploaded

Recently uploaded (20)

Error Reporting in ZF2: form messages, custom error pages, logging