jalsoedesign/cli-clipboard

Enables a clipboard API to get/set and clear the clipboard on various platforms

1.1.0 2019-07-18 16:46 UTC

This package is auto-updated.

Last update: 2024-04-19 03:09:13 UTC


README

Enables a clipboard API to get, set and clear the clipboard on various platforms (currently Windows and OSX).

Platform Support

Platform Support Reads with Writes with
Windows Yes ✅ Powershell script clip.exe
OSX Yes ✅ pbpaste pbcopy
Linux NO

Unsupported platforms will use a MockClipboardApi api, that will mimick the clipboard, but won't actually get/set/clear anything apart from its local state.

Installation

composer require jalsoedesign/cli-clipboard

Usage

Get the current clipboard contents

// Instantiate the clipboard class
$clipboard = \jalsoedesign\CliClipboard\Clipboard::instance();

// Get the current contents of the clipboard
$contents = $clipboard->get();

// Print the content
echo $contents;

Set the current clipboard contents

// Instantiate the clipboard class
$clipboard = \jalsoedesign\CliClipboard\Clipboard::instance();

// Set the current contents of the clipboard to "foobar"
$clipboard->set('foobar');

Clears the current clipboard contents

// Instantiate the clipboard class
$clipboard = \jalsoedesign\CliClipboard\Clipboard::instance();

// Clear the current clipboard contents
$clipboard->clear();