activecollab/resistance

Resistance

Resistance is a simple Redis key manager for PHP. It does not try to be a fully featured ORM, just to make keyspace management easier.

How to use?

Include it in your project using Composer:

{
    "require": {
        "activecollab/resistance": "~0.1"
    }
}

Implement a storage:

<?php
  namespace My\App\Storage;

  use Predis\Client;
  use ActiveCollab\Resistance\Storage\Storage;
  use ActiveCollab\Resistance\Storage\Field\StringField;
  use ActiveCollab\Resistance\Storage\Field\IntegerField;
  use ActiveCollab\Resistance\Storage\Field\BooleanField;

  /**
   * @package ActiveCollab\GrandCentral\Storage
   */
  final class MyObjects extends Storage
  {
    /**
     * Construct a new storage instance
     *
     * @param Client $connection
     * @param string $application_namespace
     */
    public function __construct(Client &$connection, $application_namespace)
    {
      parent::__construct($connection, $application_namespace);

      $this->setFields([
        'url'           => (new StringField)->required()->unique()->isUrl()->modifier('trim'),
        'is_paid'       =>  new BooleanField,
        'members_count' =>  new IntegerField,
        'clients_count' =>  new IntegerField,
      ]);
    }
  }

Field Settings

Common field settings:

• map - Map ID-s and values and make them accessible via getIdsBy() method,
• protect - Protect field from being set on insert(),
• required - Value is required not to be empty,
• unique - Make sure that field value is unique in the storage (required is implied). This setting is not applicable to boolean fields,

String field settings:

• format - Value is required and needs to match the given format,
• isEmail - Value is required and needs to be a valid email address,
• isUrl - Value is required and needs to be a valid URL,
• modifier - Make sure that values go through this callback or function before they are stored.

Read, Update, Delete

Instantiate it using a \ActiveCollab\Resistance::factory():

\ActiveCollab\Resistance::factory("\My\App\Storage\MyObjects")->insert([], [], …);
\ActiveCollab\Resistance::factory("\My\App\Storage\MyObjects")->update($id, []);
\ActiveCollab\Resistance::factory("\My\App\Storage\MyObjects")->get($id);
\ActiveCollab\Resistance::factory("\My\App\Storage\MyObjects")->getFieldValue($id, 'url');
\ActiveCollab\Resistance::factory("\My\App\Storage\MyObjects")->delete($id);

How to contribute?

Five simple steps to contribute.

• Fork the repo,
• Clone to your computer,
• cd to checkout folder and run composer install to update dependencies,
• Make and push the changes. Make sure that you have tests in place,
• Send a Pull Request.

Thank you!