PHPackages                             wearebraid/piction - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. wearebraid/piction

ActiveLaravel

wearebraid/piction
==================

Piction API library

06PHP

Since Nov 12Pushed 7y ago3 watchersCompare

[ Source](https://github.com/wearebraid/laravel-piction)[ Packagist](https://packagist.org/packages/wearebraid/piction)[ RSS](/packages/wearebraid-piction/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Laravel / Piction
-----------------

[](#laravel--piction)

### **NOTE: THIS IS IN BETA MODE, PLEASE DO NOT USE THIS IN A PRODUCTION SETTING**

[](#note-this-is-in-beta-mode-please-do-not-use-this-in-a-production-setting)

This is a package for quick integration with Pictino for storing records in a more usable fashion.

### Features

[](#features)

### Installation

[](#installation)

1. Install composer package: `composer require wearebraid/piction`
2. Install config file

```
php artisan vendor:publish --provider="Wearebraid\Piction\PictionServiceProvider"

```

3. Add the following items to your Laravel `.env` file:

```
PICTION_HOST=http:///piction/
PICTION_USERNAME=username
PICTION_PASSWORD=password

```

4. Add service provider and facade to your app's config: `config/app.php`

```
...
'providers' => [
	...
	Wearebraid\Piction\PictionServiceProvider::class,
	...
],
'aliases' => [
	...
	'Piction' => Wearebraid\Piction\Facades\Piction::class,
	...
],
...

```

#### Basic Config Settings

[](#basic-config-settings)

##### `config/piction.php`

[](#configpictionphp)

- `host`: This is set to pull from the `.env` file to set the host URL for your Piction install
- `user`: This is set to pull from the `.env` file to set the desired user for retrieving data from Piction
- `pass`: This is set to pull from the `.env` file to set the desired user's password for retrieving data from Piction
- `endpoint`: Default is `!soap.jsonget`, you should not need to change this as most of the functionality is relying on JSON data returned from Piction.
- `use_scout`: Default is `false` If you choose to use [Laravel's Scout](https://github.com/laravel/scout) set this to `true`. More details on using Scout and the Scout Record class below.
- `timeout`: Default is `300`, this is the number of seconds a Piction call will take before Guzzle will timeout.

---

### Using Scout *(And you should)*

[](#using-scout-and-you-should)

Why use [Scout](https://github.com/laravel/scout)? Because it is **AWESOME!** Follow the [Scout setup](https://laravel.com/docs/master/scout#installation). Once you have it configured, in `config/piction.php` set `'use_scout' => true`

From then on, instead of using `Wearebraid\Piction\Models\Record` as your main record model, switch to `Wearebraid\Piction\Models\Scout\Record`

This model extends the normal record model adding the `Searchable` functions for indexing the records for quick searches. Then from within a controller you can then use `Record::search('spiders')->paginate(20);`

#### Command Line Scripts

[](#command-line-scripts)

1. `php artisan piction:collections` **This is the main script you will run daily** Stores latest collection info to database and adds any new collections. These records will also keep track of the last updated time for the collection. Collections that have been removed from Piction will be deleted from the database as well as all records in that collection. This script also:
    1. Goes through each collection and requests the latest records for each.
    2. Requests deleted UMO's and removes records that no longer exist on Piction.
2. `php artisan piction:records collection_id` This command will connect to Piction and retrieve *ALL* records since the last run for a spcific collection. A collection id is required to run this script.
3. `php artisan piction:deleted` Since Piction doesn't support webhooks, we can get the latest data each day but we don't know what's been deleted. That's where this script comes in. It connects to Piction retrieving a list of all deleted UMO's and then deletes any of those found in the database.

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/a626ef09e15428419a017bb71cce3288196ecd0c4f04ce027183397b07d7b2e9?d=identicon)[braid](/maintainers/braid)

---

Top Contributors

[![chrisladams](https://avatars.githubusercontent.com/u/1268538?v=4)](https://github.com/chrisladams "chrisladams (11 commits)")

### Embed Badge

![Health badge](/badges/wearebraid-piction/health.svg)

```
[![Health](https://phpackages.com/badges/wearebraid-piction/health.svg)](https://phpackages.com/packages/wearebraid-piction)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)