Unum: A simple entity implementation

2.0.1 2015-09-10 15:20 UTC

This package is not auto-updated.

Last update: 2024-05-11 15:46:01 UTC


README

Build Status Latest Stable Version License

Installation

Require this package with composer:

$ composer require socialengine/setup-test-db

Usage

Create a class with protected attributes that extends SocialEngine\Unum\Entity:

class MyEntity extends \SocialEngine\Unum\Entity
{
  protected $name;
  protected $email;
}

From there, new entities can be new-ed with an array of attributes:

$entity = new MyEntity(['name' => 'Duke', 'email' => 'support@socialengine.com']);

Accessing Attributes

Attributes can be accessed with either array or object syntax:

$entity = new MyEntity(['name' => 'Duke', 'email' => 'support@socialengine.com']);
echo $entity->name; // Duke
echo $entity['email']; // support@socialengine.com

Accessing an attribute which has not been "loaded" with data will throw an InvalidArgumentException.

By defining a method of the form get{AttributeName}, the entity will use that method to return a property's value.

Note: snake_case attributes will be converted to PascalCase for methods, so test_prop becomes getTestProp

class GetMethodEntity extends \SocialEngine\Unum\Entity
{
    protected $name;
    
    protected function getName()
    {
        return $name . ' From Method!';
    }
}

$entity = new GetMethodEntity(['name' => 'Hello']);
var_dump($entity->name); // string(18) "Hello From Method!"

Assigning Attributes

Attributes can be assigned with either array or object syntax:

$entity = new MyEntity();
$entity->name = 'My Name';
$entity['email'] = 'fake@example.com';
var_dump($entity->toArray());
/*
array(2) {
  'name' =>
  string(4) "Duke"
  'email' =>
  string(24) "support@socialengine.com"
}
*/

Assigning to an attribute which does not exist will throw an InvalidArgumentException.

By defining a method of the form set{AttributeName}, the entity will use that method to set a property's value.

Note: snake_case attributes will be converted to PascalCase for methods, so test_prop becomes setTestProp

class SetMethodEntity extends \SocialEngine\Unum\Entity
{
    protected $name;
    
    protected function setName($value)
    {
        $this->name = $name . ' Set By Method!';
    }
}

$entity = new SetMethodEntity(['name' => 'Hello']);
var_dump($entity->name); // string(20) "Hello Set By Method!"

Dirty Attributes

Assigning an entity's attribute a value which differs than its current value will mark that attribute as "dirty". To retrieve an entity's dirty attributes, pass true as the $dirty flag to toArray

$entity = new MyEntity();
$entity->name = 'My Name';
var_dump($entity->toArray(true));
/*
array(1) {
  'name' =>
  string(7) "My Name"
}
*/

Entities can be "cleaned" with the clean method, which will remove the "dirty" mark from all attributes.

$entity = new MyEntity();
$entity->name = 'My Name';
$entity->email = 'whatever';
$entity->clean();
var_dump($entity->toArray(true));
/*
array(0) {
}
*/

Meta Attributes

You can set and get "meta" attributes - ones that do not have attributes directly attached to them.

This is good if you have an entity that stores a category_id but does not store the category name

<?php

require('vendor/autoload.php');

class MyEntity extends \SocialEngine\Unum\Entity
{
  protected $category_id;
  protected $first_name;
  protected $last_name;

  protected function getCategoryName()
  {
    $categoryNamesMap = [
      1 => 'Awesome'
    ];

    return $categoryNamesMap[$this->getProp('category_id')];
  }

  /**
   * You can also set meta properties
   */
  protected function setName($name)
  {
    list($firstName, $lastName) = explode(' ', $name, 2);

    $this->fromArray([
      'first_name' => $firstName,
      'last_name' => $lastName
    ]);
  }
}

$entity = new MyEntity(['category_id' => 1]);
var_dump($entity->categoryName);
/*
string(7) "Awesome"
*/

$entity['name'] = 'Duke Orcino';
var_dump($entity->toArray(true));
/*
array(2) {
  'first_name' =>
  string(4) "Duke"
  'last_name' =>
  string(6) "Orcino"
}
*/

The entity above will let you access Meta attributes via the normal syntax. Use build in setProp and getProp so that you can leverage some of the validation and attribute checking code Unum offers you.

Code Style

Please follow the following guides and code standards:

PHP

Git

Addendum and Clarifications

  • namespace should be on the same line as opening php tag: <?php namespace SocialEngine\Amazing
  • Property names should be camelCase
  • Test names should use underscores, not camelCase. e.g.: test_cats_love_catnip

License

MIT.