SMS::S...:Driver(3pm)

📦
version 1.07 · 3 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 SMS::Send::Driver — the 3pm page, but make it cute 💖

okay bestie, welcome to the SMS::Send::Driver manual page ✨ this is a Perl module, it lives in the 3pm section, and it's filed under User Contributed Perl Documentation 🎀 so you know it's the real deal. sit down, grab a strawberry 🍓, and let's get into it.

🌸 NAME 🌸

SMS::Send::Driver — the base class for SMS::Send drivers, periodt 👑

🦋 DESCRIPTION 🦋

so the tea is this: SMS::Send::Driver is an abstract base class for all the SMS::Send driver classes. every single one. it's giving founding mother 💅

right now, at this time, it does not provide any implementation code for drivers — like, none — although lowkey this may change in the future 👀. the one exception is a couple of methods it hands you specifically to trigger "does not implement method" errors. so if you forgot to write something, it will let you know, and it will not be subtle 😭

but here's the thing — it still absolutely serves a purpose: it's the thing you should sub-class your driver from, so the universe can tell your driver is a SMS::Send driver. it's the little name tag at the party 🏷️

⚠️ super important, no cap: if your driver class does not return true for $driver->isa('SMS::Send::Driver'), then the SMS::Send constructor will straight up refuse to use your class as a driver. it will not negotiate. it will not hear you out. it's giving bouncer at the club 🚫💀

✨ METHODS ✨

💜 new

the new constructor is required to be implemented by your driver subclass. no new, no vibes, no driver 🫶

it receives a set of arbitrary paired params. the values of these params are assumed to be driver-specific (and yes, this is expected to change 🔮).

if your driver needs to login to some system, locate hardware, or do some other form of initialisation to validate that the SMS delivery mechanism actually exists — it should do that in new. that's the moment. that's the vibe check 🌈

it should return a new SMS::Send::Driver-subclass object, or die on error 💀

💜 send_sms

the send_sms method is also required to be implemented by your driver subclass. yes bestie, both of them. it's a package deal 💅

it receives a set of param pairs as documented in SMS::Send.

and here's the return value lore, listen closely because it's specific 👑:

  • return true for either success or fire-and-forget with unknown result 🔥
  • return defined-but-false ('' or 0) for a failed message send 😭
  • or die on a fatal error 💀

that's the whole contract. memorise it. iykyk ✨

🫶 SUPPORT 🫶

bugs should be reported via the CPAN bug tracker at

<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SMS-Send>

for other issues, contact the author. they're nice, promise 🌸

👑 AUTHOR 👑

Adam Kennedy <adamk@cpan.org>

iconic. legendary. ate. 💅

Copyright 2005 - 2011 Adam Kennedy.

this program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

the full text of the license can be found in the LICENSE file included with this module 📜

okay that's the whole page, you're basically a SMS::Send driver dev now, no cap 🧚💖

and for the sign-off — this was generated by perl v5.36.0 on 2023-08-18, from the SMS::S...:Driver(3pm) page itself. slay, bye bestie 🌈⭐💜

📦 where this page comes from