adityasetiono/php-functions

Function helpers for PHP

5.0.0 2018-03-12 23:55 UTC

Requires

• php: ~7

Requires (Dev)

• phpunit/phpunit: ^6.4

MIT

• Aditya Setiono

README

A PHP library to serialise/deserialise an array to an object or vice versa.

Installation

To install it with composer:

composer require adityasetiono/php-functions

Usage

Import needed functions, for example:

use function adityasetiono\util\{deserialize, serialize, generate_alphanumeric};

Random String Generator

And to use it:

$string = generate_alphanumeric(5);

// => "aR4z0"

Serialise / Deserialise

This is a function to serialise/deserialise an array to an object and vice versa. Because the library is built as an external function, the class properties are required to have getters and setters.

A class example

// User.php
class User {
    protected $firstName;
    protected $lastName;
    protected $email;
    protected $username;
    
    public function setFirstName(string $firstName): User
    {
        $this->firstName = $firstName;
        
        return $this;
    }
    
    public function getFirstName(): string
    {
        return $this->firstName;
    }
    
    public function setLastName(string $lastName): User
    {
        $this->lastName = $lastName;
        
        return $this;
    }
    
    public function getLastName(): string
    {
        return $this->lastName;
    }
    
    public function setEmail(string $email): User
    {
        $this->email = $email;
        
        return $this;
    }
    
    public function getEmail(): string
    {
        return $this->email;
    }
    
    public function setUsername(string $username): User
    {
        $this->username = $username;
        
        return $this;
    }
    
    public function getUsername(): string
    {
        return $this->username;
    }
}

Serialiser

$user = serialize([
    'firstName' => 'John',
    'lastName' => 'Doe',
    'email' => '[e-mail]',
    'username' => 'johndoe'
], User::class);

Result

echo $user->getFirstName(); // John
echo $user->getEmail(); // [e-mail]

Serialised object are compatible with DoctrineORM Entities and can be persisted to database as is (Only tested with Doctrine so far, other ORM Entities need to be tested separately). This is just a generic serialiser to serialise an array to an object.

Here is an example of DoctrineORM Entity Serialization

// User.php
use Doctrine\ORM\Mapping as ORM;
/**
 * @ORM\Entity
 * @ORM\Table(name="user")
 */
class User {
    
    /**
     * @ORM\Id
     * @ORM\Column(type="guid")
     * @ORM\GeneratedValue(strategy="UUID")
     */
    protected $uuid;
    
    /**
     * @ORM\Column(type="string", nullable=true)
     */
    protected $firstName;
    
    /**
     * @ORM\Column(type="string", nullable=true)
     */
    protected $lastName;
    
    /**
     * @ORM\Column(type="string", nullable=true)
     */
    protected $email;
    
    /**
     * @ORM\Column(type="string", nullable=true)
     */
    protected $username;
    
    public function getUuid(): string
    {
        return $this->uuid;
    }
    
    public function setFirstName(string $firstName): User
    {
        $this->firstName = $firstName;
        
        return $this;
    }
    
    public function getFirstName(): string
    {
        return $this->firstName;
    }
    
    public function setLastName(string $lastName): User
    {
        $this->lastName = $lastName;
        
        return $this;
    }
    
    public function getLastName(): string
    {
        return $this->lastName;
    }
    
    public function setEmail(string $email): User
    {
        $this->email = $email;
        
        return $this;
    }
    
    public function getEmail(): string
    {
        return $this->email;
    }
    
    public function setUsername(string $username): User
    {
        $this->username = $username;
        
        return $this;
    }
    
    public function getUsername(): string
    {
        return $this->username;
    }
}

Serialiser

Uuid is a primary key and auto-generated by the DB.

$user = serialize([
    'firstName' => 'John',
    'lastName' => 'Doe',
    'email' => '[e-mail]',
    'username' => 'johndoe'
], User::class);

Persist to DB

// obtaining the entity manager
$entityManager = EntityManager::create($conn, $config);
$entityManager->persist($user);
$entityManager->flush();

Deserialiser

Getting the object/entity from Database

$uuid = 'e48a0ba1-1504-11e8-ae97-0649b2727d37'; // Hardcoded for display purposes
$user = $entityManager->find(User::class, $uuid);

Use the deserialise

$array = deserialise($user); // empty option means complete deserialization by default.
echo json_encode($array);

Content of $array will be

{
  "uuid": "e48a0ba1-1504-11e8-ae97-0649b2727d37",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[e-mail]",
  "username": "johndoe"
}

Another example with custom fields. The second parameter accepts an associative array with key which will be the result's key and value is the property name. The deserialiser expects the value to be exactly the same as camelCase of the getter without get.

$customArray = deserialize($user,[
    'first_name' => 'firstName',
    'surname' => 'lastName',
    'email' => 'email',
]);
echo json_encode($customArray);

Content of $customArray will be

{
  "first_name": "John",
  "surname": "Doe",
  "email": "[e-mail]"
}

The deserialiser should work with nested object and array of objects. Further example will be provided in the documentation. (It is available in the tests files).

Issues

Feel free to use GitHub Issues or email directly to [e-mail] as I started this library on my own. Collaborators are welcomed.