cubiclesoft/to-composer

CubicleSoft PHP Software Development Libraries for Composer


README

A single repository containing all CubicleSoft PHP libraries in a CubicleSoft namespace and then made Composer ready. Fully automated nightly updates. MIT or LGPL, your choice.

Donate

How To Use

The usual Composer require method works: https://packagist.org/packages/cubiclesoft/to-composer

composer require cubiclesoft/to-composer

License Correction

The license is actually your choice of MIT or LGPL. The 'composer.json' file format is rather inflexible and therefore incapable of refined licensing options.

Classes

Included and supported:

  • \CubicleSoft\AppleICNS - Create and parse Apple icon (.icns) files. Documentation (src/AppleICNS.php)
  • \CubicleSoft\CalendarEvent - Powerful scheduling class. Feed in a cron line, get back the next timestamp of when something should trigger. Documentation (src/CalendarEvent.php)
  • \CubicleSoft\CLI - Static functions in a class to extract command-line options, parse user input on the command-line, and log messages to the console. Do you really need a separate logging library? I don't. Documentation (src/CLI.php)
  • \CubicleSoft\ColorTools - Static functions in a class to convert RGB to other color spaces and calculate readable foreground text colors for any background color. Documentation (src/ColorTools.php)
  • \CubicleSoft\CRC32Stream - Calculates CRC32 checksums in a streaming format. Documentation (src/CRC32Stream.php)
  • \CubicleSoft\CSDB - Cross-database, cross-platform, lightweight base class for interfacing with databases. Designed specifically for developing open source applications where the target database is unknown. Write each SQL query one time and have all queries automagically work for all supported databases. Complete with all the standard features you expect in a SQL injection free database class. Uses PDO by default. Documentation (src/CSDB.php)
  • \CubicleSoft\CSDB_mysql - Full MySQL/Maria DB interface. (src/CSDB_mysql.php)
  • \CubicleSoft\CSDB_mysql_lite - Lightweight MySQL/Maria DB interface. (src/CSDB_mysql_lite.php)
  • \CubicleSoft\CSDB_oci - Full Oracle DB interface (beta). (src/CSDB_oci.php)
  • \CubicleSoft\CSDB_oci_lite - Lightweight Oracle DB interface (beta). (src/CSDB_oci_lite.php)
  • \CubicleSoft\CSDB_pgsql - Full PostgreSQL interface. (src/CSDB_pgsql.php)
  • \CubicleSoft\CSDB_pgsql_lite - Lightweight PostgreSQL interface. (src/CSDB_pgsql_lite.php)
  • \CubicleSoft\CSDB_sqlite - Full SQLite interface. (src/CSDB_sqlite.php)
  • \CubicleSoft\CSDB_sqlite_lite - Lightweight SQLite interface. (src/CSDB_sqlite_lite.php)
  • \CubicleSoft\CSPRNG - Cross-platform Cryptographically Secure Random Number Generator (CSPRNG). Unlike nearly all of the classes out there that claim to implement a CSPRNG, this one actually does things correctly because I scoured the actual PHP C source code and spent the necessary time figuring out which calls called the system-level CSPRNG for each major platform. This class also doesn't wimp out and fallback to some hocus-pocus, non-random, weak sauce solution - it throws an Exception which you intentionally and correctly do not ever catch. Documentation (src/CSPRNG.php)
  • \CubicleSoft\DeflateStream - Compresses/Uncompresses deflate data (including gzip) in a streaming format without intermediate files. Documentation (src/DeflateStream.php)
  • \CubicleSoft\DigitalOcean - A complete SDK for interacting with all DigitalOcean APIs. (src/DigitalOcean.php)
  • \CubicleSoft\DirHelper - Static functions in a class for simplifying common file system tasks regarding directories, including recursive copy, delete, and permissions changes when building installers, live demos, and testing tools. Documentation (src/DirHelper.php)
  • \CubicleSoft\EFSS - Creates hierarchical, encrypted, compressed data stores. Encrypted File Storage System is a real, virtual, mountable block-based file system for PHP. Documentation (src/EFSS.php)
  • \CubicleSoft\EventManager - Register to listen for events whenever the application fires them. Can be the basis of a plugin/module system. Documentation (src/EventManager.php)
  • \CubicleSoft\FastCGI - Implements a FactCGI client. Documentation (src/FastCGI.php)
  • \CubicleSoft\FlexForms - Powerful class for building/generating HTML forms. Highly extensible with XSRF and anti-bot defenses. Documentation (src/FlexForms.php)
  • \CubicleSoft\GenericServer - Implements a generic TCP/IP server class. Can be used for creating custom protocols. Documentation (src/GenericServer.php)
  • \CubicleSoft\HTTP - Baseline static functions in a class for performing all things HTTP. Has powerful URL parsing tools (e.g. relative to absolute URL conversion). Used primarily by WebBrowser. Asynchronous capable. Documentation (src/HTTP.php)
  • \CubicleSoft\IPAddr - Static functions in a class for processing IPv4 and IPv6 addresses into a uniform format. Documentation (src/IPAddr.php)
  • \CubicleSoft\LineDiff - Static functions in a class for generating line-by-line diffs. Documentation (src/LineDiff.php)
  • \CubicleSoft\MIMEParser - Parses MIME content of all forms. Intended primarily for use with POP3. (src/MIMEParser.php)
  • \CubicleSoft\MultiAsyncHelper - Not for the feint of heart. This class simplifies management of mixing multiple non-blocking objects. See the Ultimate Web Scraper toolkit test suite for example usage. Documentation (src/MultiAsyncHelper.php)
  • \CubicleSoft\PHPMinifier - Static functions in a class for minifying PHP code while still generally maintaining readability. Documentation (src/PHPMinifier.php)
  • \CubicleSoft\POP3 - Powerful class for accessing a POP3 server. Pair it with MIMEParser and TagFilter for advanced e-mail handling. (src/POP3.php)
  • \CubicleSoft\ProcessHelper - Static functions in a class for starting and terminating non-blocking processes across all platforms. Documentation (src/ProcessHelper.php)
  • \CubicleSoft\ReadWriteLock - A very old class that implements a cross-platform, named read-write lock for very old versions of PHP. Use the PECL sync extension instead. Documentation (src/ReadWriteLock.php)
  • \CubicleSoft\Request - Static functions in a class for doing basic, common, but missing request initialization handling. Common initialization routines for CubicleSoft applications. Documentation (src/Request.php)
  • \CubicleSoft\SMTP - Powerful set of static functions in a class for sending e-mail. Full RFC support. (src/SMTP.php)
  • \CubicleSoft\Str - Static functions in a class for doing basic, common, but missing string manipulation. Common initialization routines for CubicleSoft applications. Some minor carryover from extremely old C++ libraries. Documentation (src/Str.php)
  • \CubicleSoft\StringBitStream - Parse data stored in a bit stream such as Flash (SWF) files. Documentation (src/StringBitStream.php)
  • \CubicleSoft\TagFilter - The world's most powerful tag filtering PHP class. It can clean up the worst HTML (e.g. Word HTML) in a single pass or extract data (or both). As a direct result, it is blistering fast. Many, many times faster and smaller than everything else I've used. Documentation (src/TagFilter.php)
  • \CubicleSoft\TagFilterNodes - Output from TagFilter::Explode(), which explodes a HTML document into a flattened DOM-like structure. From there, use CSS3 media queries to locate nodes of interest. Documentation (src/TagFilterNodes.php)
  • \CubicleSoft\TagFilterNode - TagFilterNodes::Get() returns a TagFilterNode object which provides easy but slower object-oriented access to TagFilterNodes. Documentation (src/TagFilterNode.php)
  • \CubicleSoft\TagFilterNodeIterator - Allows iteration over CSS3 query results from TagFilterNode::Find() using foreach. Also has a Filter() function to further reduce results using additional CSS3 selectors. Documentation (src/TagFilterNodeIterator.php)
  • \CubicleSoft\TagFilterStream - Used by TagFilter but can be used separately for processing large HTML files in smaller chunks (aka a stream). Documentation (src/TagFilterStream.php)
  • \CubicleSoft\UTF8 - Flexible UTF-8 string manipulation static functions in a class. CubicleSoft was doing Unicode and UTF-8 long before Unicode and UTF-8 were cool. Documentation (src/UTF8.php)
  • \CubicleSoft\WebBrowser - Probably the most powerful state tracking system in pure PHP for web scraping. Virtually indistiguishable from a real web browser and therefore extremely difficult to detect. Has HTML form extraction and command-line shell interface capabilities. I occasionally dream of adding a Javascript parsing engine to it. Superior in every way to Guzzle when it comes to web scraping (Guzzle is an API consumer, not a web scraper - different domains). Documentation (src/WebBrowser.php)
  • \CubicleSoft\WebBrowserForm - Represents and manipulates a single extracted HTML form from a page. Generates WebBrowser-compliant output for feeding back into WebBrowser for another request. Documentation (src/WebBrowserForm.php)
  • \CubicleSoft\WebMutex - A very old class that implements a cross-platform, named mutex for very old versions of PHP. Use the PECL sync extension instead. Documentation (src/WebMutex.php)
  • \CubicleSoft\WebServer - It is what it says on the tin. It's a web server. In pure PHP. Abuses the HTTP class to implement a rather scary and complete feature set that probably rivals Apache. Isn't going to win any performance awards. Is probably susceptible to DoS attacks due to multiple bugs in PHP. Used by Cloud Storage Server and PHP App Server. Documentation (src/WebServer.php)
  • \CubicleSoft\WebSocket - Implements a WebSocket client. Probably not as robust as it could be on the async front but, unlike most WebSocket classes, this one allows the application to ignore those pesky control packets. Docuemtation (src/WebSocket.php)
  • \CubicleSoft\WebSocketServer - Move over Node.js and whatever else is out there. A new WebSocket server is in town. With limits on packet size because, well, WebSocket vulnerabilities. Actually, you probably shouldn't use this in production environments either. WebSocket is kind of a broken protocol. The server exists to test the client because there aren't that many open servers out there. Documentation (src/WebSocketServer.php)
  • \CubicleSoft\XTerm - Static functions in a class for emitting XTerm-compatible escape codes to alter terminal behavior. Mostly for changing font styles and colors but also supports most escape codes with easier to comprehend functions. Many features also work with the Command Prompt in Windows 10 and later. Documentation (src/XTerm.php)
  • \CubicleSoft\simple_html_dom - Not actually a CubicleSoft class. Accidental inclusion from Ultimate Web Scraper Toolkit. [Shrugs] Obsoleted by TagFilter. (src/simple_html_dom.php)

Other:

  • \CubicleSoft\Crypt_AES - Internal or undocumented class. (src/Crypt_AES.php)
  • \CubicleSoft\Crypt_Base - Internal or undocumented class. (src/Crypt_Base.php)
  • \CubicleSoft\CalendarEvent_TZSwitch - Internal or undocumented class. (src/CalendarEvent_TZSwitch.php)
  • \CubicleSoft\CSDB_PDO_Statement - Internal or undocumented class. (src/CSDB_PDO_Statement.php)
  • \CubicleSoft\EFSS_FirstBlock - Internal or undocumented class. (src/EFSS_FirstBlock.php)
  • \CubicleSoft\EFSS_DirEntry_DirFile - Internal or undocumented class. (src/EFSS_DirEntry_DirFile.php)
  • \CubicleSoft\EFSS_DirEntries - Internal or undocumented class. (src/EFSS_DirEntries.php)
  • \CubicleSoft\EFSS_File - Internal or undocumented class. (src/EFSS_File.php)
  • \CubicleSoft\EFSS_Unused - Internal or undocumented class. (src/EFSS_Unused.php)
  • \CubicleSoft\EFSS_DirCopyHelper - Internal or undocumented class. (src/EFSS_DirCopyHelper.php)
  • \CubicleSoft\EFSS_SymlinkCopyHelper - Internal or undocumented class. (src/EFSS_SymlinkCopyHelper.php)
  • \CubicleSoft\EFSS_FileCopyHelper - Internal or undocumented class. (src/EFSS_FileCopyHelper.php)
  • \CubicleSoft\EFSSIncremental - Internal or undocumented class. (src/EFSSIncremental.php)
  • \CubicleSoft\EmailBuilder - Internal or undocumented class. (src/EmailBuilder.php)
  • \CubicleSoft\Crypt_Rijndael - Internal or undocumented class. (src/Crypt_Rijndael.php)
  • \CubicleSoft\simple_html_dom_node - Internal or undocumented class. (src/simple_html_dom_node.php)
  • \CubicleSoft\WebServer_TempFile - Internal or undocumented class. (src/WebServer_TempFile.php)
  • \CubicleSoft\WebServer_Client - Internal or undocumented class. (src/WebServer_Client.php)

Sources

Frequently Asked Questions

Okay, let's skip the questions. I don't like Composer. The best libraries are always self-contained (i.e. no external dependencies), small, light, and fast. Composer directly violates this core principle of software development. Looking at the most popular items on Packagist, I see nothing you can't do already with CubicleSoft libraries, a couple of isolated third-party crypto libs (e.g. phpseclib), and some extremely minor bits of glue - all that with far less application code and far fewer files. Less application code means less time spent writing and maintaining it. Fewer files means faster uploads to a production environment, fewer open tabs to edit stuff, and fewer security vulnerabilities.

This repository exists only because Composer exists. Its sole purpose is to provide Composer-lovers a way to use CubicleSoft libraries within that worldview.

BUT just because I don't like something doesn't mean it doesn't exist. Okay? Lots and lots of people use Composer. That said, this repository and package are 100% automated. Library updates flow in within 24 hours of the upstream push. The 'update.php' script here performs all of the magic transformations required to convert the libraries to a Composer compatible world and then pushes them into this repository. Packagist then picks up the newly tagged version and Composer update picks up the changes from there. You are happy because you get what you want. I'm happy because I can continue to develop software however I want.