Silk\Database\ActiveRecord

Complexity

Total Complexity

17

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes	1
Bugs	0	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	save()	0	6	1
A	delete()	0	6	1
A	refresh()	0	6	1
A	exists()	0	4	2
A	meta()	0	10	2
A	setObject()	0	6	1
A	setId()	0	5	1
	actionClasses()	0	1	?
A	activeAction()	0	8	1
A	executeAction()	0	4	1
A	__get()	0	12	3
A	__isset()	0	4	1
A	__set()	0	6	2

<?php

namespace Silk\Database;

use Silk\Meta\ObjectMeta;
use Illuminate\Support\Collection;

/**
 * @property-read int    $id
 * @property-read object $object
 */
abstract class ActiveRecord
{
    /**
     * The core model object
     * @var object
     */
    protected $object;

    /**
     * The object type in WordPress
     */
    const OBJECT_TYPE = '';

    /**
     * The name of the primary ID property on the object
     */
    const ID_PROPERTY = '';

    /**
     * Save the changes to the database.
     *
     * @return $this
     */
    public function save()
    {
        $this->activeAction('save');

        return $this;
    }

    /**
     * Delete the record from the database.
     *
     * @return $this
     */
    public function delete()
    {
        $this->activeAction('delete');

        return $this;
    }

    /**
     * Load and set the object from the database.
     *
     * @return $this
     */
    public function refresh()
    {
        $this->activeAction('load');

        return $this;
    }

    /**
     * Simple existence checking
     *
     * @return bool
     */
    public function exists()
    {
        return $this->object && $this->id;
    }

    /**
     * Meta API for this type
     *
     * @param  string $key  Meta key to retreive or empty to retreive all.
     *
     * @return object
     */
    public function meta($key = '')
    {
        $meta = new ObjectMeta(static::OBJECT_TYPE, $this->id);

        if ($key) {
            return $meta->get($key);
        }

        return $meta;
    }

    /**
     * Update the core object
     *
     * @param object $object
     */
    public function setObject($object)
    {
        $this->object = $object;

        return $this;
    }

    /**
     * Set the primary ID on the model.
     *
     * @param string|int $id  The model's ID
     *
     * @return $this
     */
    public function setId($id) {
        $this->object->{static::ID_PROPERTY} = (int) $id;

        return $this;
    }

    /**
     * Get the map of action => class for resolving active actions.
     *
     * @return array
     */
    abstract protected function actionClasses();

    /**
     * Perform a database action.
     *
     * @return void
     */
    protected function activeAction($action)
    {
        $actionClass = Collection::make(
            $this->actionClasses()
        )->get($action, NullAction::class);

        $this->executeAction(new $actionClass($this));
    }

    /**
     * Execute the active action
     */
    private function executeAction(Executable $action)
    {
        $action->execute();
    }

    /**
     * Magic getter.
     *
     * @param  string $property
     *
     * @return mixed
     */
    public function __get($property)
    {
        if ($property == 'id') {
            return $this->object->{static::ID_PROPERTY};
        }

        if ($property == static::OBJECT_TYPE) {
            return $this->object;
        }

        return $this->object->$property;
    }

    /**
     * Magic Isset Checker.
     */
    public function __isset($property)
    {
        return ! is_null($this->__get($property));
    }

    /**
     * Magic setter.
     *
     * @param string $property  The property name
     * @param mixed  $value     The new property value
     */
    public function __set($property, $value)
    {
        if (property_exists($this->object, $property)) {
            $this->object->$property = $value;
        }
    }
}