The Definitive Guide to Craft Validation for Plugin Developers

Retired

This book is no longer available for sale.

The Definitive Guide to Craft Validation for Plugin Developers

A practical guide to unlocking the hidden secrets of validation in Craft CMS.

About the Book

If you're working on a Craft plugin that accepts user input, chances are you'll want to validate that data. Thanks to its Yii underpinnings, Craft includes lots of powerful validation features as standard, but they're not always easy to use or understand.

In an attempt to help us out, Craft adds its own layer of abstraction on top of the Yii validation tools. This makes the syntax a bit more consistent and approachable, but also renders the associated Yii documentation useless. Worse still, the official Craft documentation is currently rather lacking in this area.

That's where this book comes in. It provides a complete guide to validation in Craft 2, all the way from the high-level concepts, right down to the nuts and bolts of implementation.

If you want to know how to implement validation in your Craft plugin as quickly and effectively as possible, you're in the right place. 

About the Author

Stephen Lewis
Stephen Lewis

Stephen Lewis is the founder, fearless leader, and general dogsbody of Experience, a web development consultancy.

Stephen began his web career back in the late 90s, when font tags were the height of sophistication, and Flash seemed like the solution rather than the problem. Long before then, he was programming in BASIC, Pascal, FORTRAN, and several other languages which have utterly failed to withstand the test of time.

Perhaps because of this history of obsolescence, Stephen has a curious affinity for PHP. It's not young or hip, isn't particularly pretty, and never gets invited to the cool parties, but somehow it gets the job done. These may be further reasons for Stephen's aforementioned feelings of empathy.

When he's not wrangling PHP, Stephen dabbles in JavaScript, and the occasional bit of Python, although he secretly doesn't trust significant whitespace. In times of weakness, Stephen has been known to turn chairs upside-down to see how they're made, a sad and disturbing legacy of his Furniture Design degree (which has been about as much use as FORTRAN).

Should you wish to peer deeply into the dark recesses of Stephen's psyche, you can find him blogging irregularly, and Tweeting too frequently.

Table of Contents

  • Introduction
    • The Obligatory Origin Story
    • Is This Book For Me?
    • Errata
    • Get In Touch
  • 1. Foundations
    • How To Declare A Model Attribute
    • How To Validate A Model’s Attributes
    • Useful Validation Methods
    • Summary
  • 2. AttributeTypes
    • The Many Roles of AttributeTypes
    • How AttributeTypes Affect Validation
    • Overriding The Default AttributeType Validator Parameters
    • Available AttributeTypes
    • Summary
  • 3. Attribute Rules
    • Available Attribute Validation Rules
    • Summary
  • 4. Hidden Validator Settings
    • How To Use A Hidden Validator Setting
    • A Yii Validation Rule Primer
    • Available Hidden Validator Settings
    • Summary
  • 5. Custom Validators
    • How To Tell Craft To Use A Custom Validator
    • How To Implement A Custom Validator
    • Summary
  • Conclusion
  • Appendix A: Reserved “Handle” Words
  • About The Author

The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

80% Royalties. Earn $16 on a $20 book.

We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earnedover $13 millionwriting, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub