jaedb/dev-tools

This package is abandoned and no longer maintained. The author suggests using the plasticstudio/dev-tools package instead.

Development tools for SilverStripe

2.0.0 2018-01-12 02:22 UTC

Requires

• silverstripe/cms: ^4
• silverstripe/framework: ^4
• silverstripe/vendor-plugin: ^1

BSD-3-Clause

• James Barnsley

• silverstripe

README

Adds additional functionality to assist in developing SilverStripe websites.

Dependencies

• SilverStripe 3.1+
• Betterbuttons

Features

• Performance of page loads
• Visualisation of current site state (DEV/TEST/LIVE)
• Admins can emulate any other user
• IconSelectField to use icon libraries within the CMS
• Automatic redirection from development domains, when in LIVE mode
• LogJam logging to append system error log
• BugHerd integration

Installation

1. Add to your composer requirements composer require jaedb/dev-tools
2. Edit your theme's templates/Page.ss template and add $DebugTools immediately before the </body> tag
3. Run /dev/build?flush=1
4. Toggle debug tools by turning your site to DEV or TEST modes (disabled on LIVE sites for obvious reasons)
5. Set the site's BugHerd project key in config.yml. See config/dev-tools.yml for an example.

Usage

Primary domain redirection

When you set your SS_PRIMARY_DOMAIN property on a live website, we automatically redirect to this primary domain. This avoids the need for bloated .htaccess redirections and allows control at the environment level.

• Set your preferred domain in _ss_environment.php
• Consider whether you want http vs https, and include this in your domain (but exclude trailing slash!).
• Example: define('SS_PRIMARY_DOMAIN', 'https://plasticstudio.co.nz'); will redirect http://www.plasticstudio.co.nz/some-section/subpage to https://plasticstudio.co.nz/some-section/subpage.
• To completely disable this functionality set disable_primary_domain_redirection: true in your project's config.yml

Debug Tools

• Manage the visibility of the Debug Tools from within the CMS, under Settings
• Manage ability to Emulate users, also under Settings

IconSelectField

• Set your $db field to type Icon (eg 'PageIcon' => 'Icon')
• IconSelectField::create($name, $title, $iconFolder)
• $name is the database field as defined in your class
• $title is the label for this field
• $iconFolder (optional) defines the directory where your icons can be found. Defaults to /site/icons.
• Use your icon in templates as you would any other property (eg $PageIcon). If your icon is an SVG, the SVG image data will be injected into the template. To prevent this, you can call $PageIcon.IMG instead to enforce use of <img> tags.

LogJam

• LogJam::Log($message, $environment)
• $message a string that you'd like to log
• $environment (optional) the type of environment that should log this message (ie test, dev, live). Defaults to dev.

1. Enable LogJam in _config.php by adding LogJam::EnableLog();
2. Check your log file location. Set this in _ss_environment.php with the following:

ini_set('log_errors','on');
ini_set('error_log','/home/mywebsite/logs/php.log');