pstaender / ssshell
ssshell is a REPL for SilverStripe. Runs on top of PsySH 🚀
Installs: 1 614
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 3
Forks: 2
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- psy/psysh: ~0.9
- silverstripe/framework: ^4 || ^5
- symfony/console: ^7.0
README
REPL for SilverStripe running on Psy Shell 🚀
Install
Install in your current project with:
$ composer require --dev pstaender/ssshell
Usage
To use ssshell just type ./vendor/bin/ssshell
(or ssshell
if its installed globally) in your project folder and you can start using the shell:
Psy Shell v0.12.4 (PHP 8.2.19 — cli) by Justin Hileman
Loading dev environment (SilverStripe CMS: 5.2.2)
>
Command Line Options
You can use most of psyshs' cli arguments. Type psysh -h
for help.
Requirements
sshell runs on SilverStripe v5.
For SilverStripe v4 you can use the ss4
-branch or stick to version v0.0.4 via composer require pstaender/ssshell 'v0.0.4'
.
Features
Namespaces and views of objects and lists
ssshell
comes with a set of frequent used namespaces for convenient REPL handling.
By default all DataObjects, DataLists, ArrayLists and Query objects will be displayed in a human-readable fashion.
As example, creating a SilverStripe User would be:
> Member::create(['Email' => 'editor', 'Password' => 'password'])->write() => 1 > Member::get()->first() => SilverStripe\Security\Member {#3229 +ClassName: "SilverStripe\Security\Member", +LastEdited: "2019-07-01 11:34:54", +Created: "2019-07-01 11:34:54", +Email: "editor", +Password: "$2y$10$9b5f51921992948f40cf7uHeqjQLuG9Bnqf4sq54TBnsB80CmwJhC", +PasswordEncryption: "blowfish", +Salt: "10$9b5f51921992948f40cf75", +Locale: "en_US", +FailedLoginCount: 0, +ID: 1, +RecordClassName: "SilverStripe\Security\Member", +LoggedPasswords: [ [ "ClassName" => "SilverStripe\Security\MemberPassword", "LastEdited" => "2019-07-01 11:34:54", "Created" => "2019-07-01 11:34:54", "Password" => "$2y$10$9b5f51921992948f40cf7uHeqjQLuG9Bnqf4sq54TBnsB80CmwJhC", "Salt" => "10$9b5f51921992948f40cf75", "PasswordEncryption" => "blowfish", "MemberID" => 1, "ID" => 1, "RecordClassName" => "SilverStripe\Security\MemberPassword", ], ], +RememberLoginHashes: [], +LinkTracking: [], +FileTracking: [], +Groups: [], }
Sake command
You can use all familiar sake commands:
> sake dev/build Building database SS_test using SilverStripe\ORM\Connect\MySQL 8.0.16 CREATING DATABASE TABLES * File (0 records) * CHECK TABLE command disabled for PDO in native mode * SiteConfig (1 records) …
> sake dev/tasks SILVERSTRIPE DEVELOPMENT TOOLS: Tasks -------------------------- * Migrate SiteTree Linking Task: sake dev/tasks/MigrateSiteTreeLinkingTask * Database Migrations: sake dev/tasks/MigrationTask …
Flush command
> flush
Same effect when using sake
with ?flush
.
Static Command
View available static properties / methods of classes.
Displays static properties and methods:
> static SilverStripe\Control\Director
To display only one of them:
> static props SilverStripe\Control\Director … > static methods SilverStripe\Control\Director …