rainshowers.org

Articles about software development and notes on development tools.

Guide to Silverstripe CMS: Reference to vendor folders with notes on those that contain modules

Posted on
#Silverstripe

note: use $ grip silverstripe_files-and-folders.md to live preview .md in a browser tab. see: /home/ken/Documents/silverstripe_vendor_folders.ods

Modules in Silverstripe are considered folders that contain either a _config.php file or a _config folder, along with a composer.json file. The composer.json file normally contains a Type property, shown below in the tables.

Libraries

Path (all that contain composer.json) Type (* indicates assumed) Description (taken from composer.json) IsModule Notes
/vendor/doctrine/instantiator library A small, lightweight utility to instantiate objects in PHP without invoking their constructors
/vendor/doctrine/lexer library PHP Doctrine Lexer parser library that can be used in Top-Down, Recursive Descent Parsers.
/vendor/nikic/php-parser library A PHP parser written in PHP
/vendor/ralouphie/getallheaders library* A polyfill for getallheaders.
/vendor/embed/embed library PHP library to retrieve page info using oembed, opengraph, etc
/vendor/ua-parser/uap-php library* A multi-language port of Browserscope’s user agent parser.
/vendor/intervention/image library* Image handling and manipulation library with support for Laravel integration
/vendor/league/csv library CSV data manipulation made easy in PHP
/vendor/league/flysystem library Filesystem abstraction: Many filesystems, one API.
/vendor/league/mime-type-detection library* Mime-type detection for Flysystem
/vendor/sebastian/code-unit-reverse-lookup library* Looks up which function or method a line of code belongs to
/vendor/sebastian/comparator library* Provides the functionality to compare PHP values for equality
/vendor/sebastian/diff library* Diff implementation
/vendor/sebastian/environment library* Provides functionality to handle HHVM/PHP environments
/vendor/sebastian/exporter library* Provides the functionality to export PHP variables for visualization
/vendor/sebastian/global-state library* Snapshotting of global state
/vendor/sebastian/object-enumerator library* Traverses array structures and object graphs to enumerate all referenced objects
/vendor/sebastian/recursion-context library* Provides functionality to recursively process PHP variables
/vendor/sebastian/resource-operations library* Provides a list of PHP built-in functions that operate on resources
/vendor/sebastian/version library* Library that helps with managing the version number of Git-hosted PHP projects
/vendor/phpdocumentor/reflection-common library* Common reflection classes used by phpdocumentor to reflect the code structure
/vendor/phpdocumentor/reflection-docblock library With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.
/vendor/phpdocumentor/type-resolver library A PSR-5 based resolver of Class names, Types and Structural Element Names
/vendor/swiftmailer/swiftmailer library Swiftmailer, free feature-rich PHP mailer
/vendor/bramus/ansi-php library* ANSI Control Functions and ANSI Control Sequences (Colors, Erasing, etc.) for PHP CLI Apps
/vendor/bramus/monolog-colored-line-formatter library* Colored Line Formatter for Monolog
/vendor/guzzlehttp/psr7 library* PSR-7 message implementation that also provides common utility methods
/vendor/symfony/cache library Provides an extended PSR-6, PSR-16 (and tags) implementation
/vendor/symfony/cache-contracts library Generic abstractions related to caching
/vendor/symfony/config library Helps you find, load, combine, autofill and validate configuration values of any kind
/vendor/symfony/filesystem library Provides basic utilities for the filesystem
/vendor/symfony/finder library Finds files and directories via an intuitive fluent interface
/vendor/symfony/polyfill-ctype library Symfony polyfill for ctype functions
/vendor/symfony/polyfill-iconv library Symfony polyfill for the Iconv extension
/vendor/symfony/polyfill-intl-idn library Symfony polyfill for intl’s idn_to_ascii and idn_to_utf8 functions
/vendor/symfony/polyfill-intl-normalizer library Symfony polyfill for intl’s Normalizer class and related functions
/vendor/symfony/polyfill-mbstring library Symfony polyfill for the Mbstring extension
/vendor/symfony/polyfill-php72 library Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions
/vendor/symfony/polyfill-php73 library Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
/vendor/symfony/polyfill-php80 library Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
/vendor/symfony/polyfill-php81 library Symfony polyfill backporting some PHP 8.1+ features to lower PHP versions
/vendor/symfony/service-contracts library Generic abstractions related to writing services
/vendor/symfony/translation library Provides tools to internationalize your application
/vendor/symfony/translation-contracts library Generic abstractions related to translation
/vendor/symfony/var-exporter library Allows exporting any serializable PHP data structure to plain PHP code
/vendor/symfony/yaml library Loads and dumps YAML files
/vendor/egulias/email-validator library* A library for validating emails against several RFCs
/vendor/marcj/topsort library High-Performance TopSort/Dependency resolving algorithm
/vendor/m1/env library* Env is a lightweight library bringing .env file parser compatibility to PHP. In short - it enables you to read .env files with PHP.
/vendor/phpunit/php-code-coverage library Library that provides collection, processing, and rendering functionality for PHP code coverage information.
/vendor/phpunit/php-file-iterator library FilterIterator implementation that filters files based on a list of suffixes.
/vendor/phpunit/php-text-template library Simple template engine.
/vendor/phpunit/php-timer library Utility class for timing
/vendor/phpunit/php-token-stream library Wrapper around PHP’s tokenizer extension.
/vendor/sminnee/callbacklist library PHP class that manages a list of callbacks
/vendor/sminnee/phpunit library The PHP Unit Testing framework - forked to backport PHP 8 support
/vendor/sminnee/phpunit-mock-objects library Mock Object library for PHPUnit (fork to add PHP 7.4 support to 3.4)
/vendor/phpspec/prophecy library Highly opinionated mocking framework for PHP 5.3+
/vendor/monolog/monolog library Sends your logs to files, sockets, inboxes, databases and various web services
/vendor/composer/ca-bundle library Lets you find a path to the system CA bundle, and includes a fallback to the Mozilla CA bundle.
/vendor/myclabs/deep-copy library Create deep copies (clones) of your objects
/vendor/psr/cache library* Common interface for caching libraries
/vendor/psr/container library Common Container Interface (PHP FIG PSR-11)
/vendor/psr/http-factory library* Common interfaces for PSR-7 HTTP message factories
/vendor/psr/http-message library* Common interface for HTTP messages
/vendor/psr/log library* Common interface for logging libraries
/vendor/psr/simple-cache library* Common interfaces for simple caching
/vendor/webmozart/assert library* Assertions to validate method input/output with nice error messages.
/vendor/webonyx/graphql-php library A PHP port of GraphQL reference implementation

Composer Plugins

Path Type (* indicates assumed) Description (taken from composer.json) IsModule Notes
/vendor/composer/installers composer-plugin A multi-framework Composer library installer
/vendor/silverstripe/recipe-plugin composer-plugin Helper plugin to install SilverStripe recipes
/vendor/silverstripe/vendor-plugin composer-plugin Allows vendor modules to expose directories to the webroot

Silverstripe Recipes

Path Type (* indicates assumed) Description (taken from composer.json) IsModule Notes
/vendor/silverstripe/recipe-cms silverstripe-recipe SilverStripe recipe for fully featured page and asset content editing
/vendor/silverstripe/recipe-core silverstripe-recipe SilverStripe framework-only core recipe _config/ + _config.php
/ silverstripe-recipe The SilverStripe Framework Installer

Silverstripe Vendor Modules

Path Type (* indicates assumed) Description (taken from composer.json) IsModule Notes
/vendor/silverstripe/admin silverstripe-vendormodule SilverStripe admin interface _config/ + _config.php
/vendor/silverstripe/asset-admin silverstripe-vendormodule Asset management for the SilverStripe CMS _config/ + _config.php
/vendor/silverstripe/assets silverstripe-vendormodule SilverStripe Assets component _config/ + _config.php
/vendor/silverstripe/campaign-admin silverstripe-vendormodule SilverStripe campaign admin interface _config/ + _config.php
/vendor/silverstripe/cms silverstripe-vendormodule The SilverStripe Content Management System _config/ + _config.php
/vendor/silverstripe/config Silverstripe-vendormodule* SilverStripe configuration based on YAML and class statics
/vendor/silverstripe/errorpage silverstripe-vendormodule ErrorPage component for SilverStripe CMS _config/
/vendor/silverstripe/framework silverstripe-vendormodule The SilverStripe framework _config/ + _config.php
/vendor/silverstripe/graphql silverstripe-vendormodule GraphQL server for SilverStripe models and other data _config/ + _config.php
/vendor/silverstripe/login-forms silverstripe-vendormodule A collection of templates for the CMS login screens _config/
/vendor/silverstripe/mimevalidator silverstripe-vendormodule Checks uploaded file content roughly matches a known MIME type for the file extension. _config/
/vendor/silverstripe/reports silverstripe-vendormodule Reports module for SilverStripe CMS _config/
/vendor/silverstripe/session-manager silverstripe-vendormodule Allow users to manage and revoke access to multiple login sessions across devices. _config/
/vendor/silverstripe/siteconfig silverstripe-vendormodule Site wide settings administration. _config/
/vendor/silverstripe/versioned silverstripe-vendormodule SilverStripe Versioned component _config/
/vendor/silverstripe/versioned-admin silverstripe-vendormodule SilverStripe versioned admin interface _config/ + _config.php

Silverstripe Themes

Path TypeAssumed Description (taken from composer.json) IsModule Notes
/themes/simple silverstripe-theme The SilverStripe simple theme (default SilverStripe 3 theme)