Charcoal\Property\MultiObjectProperty

Complexity

Total Complexity

14

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setAllowedTypes()	0	7	2
A	addAllowedType()	0	5	1
A	setJoinTable()	0	17	3
A	createJoinTable()	0	17	2
A	joinTableExists()	0	9	1
A	type()	0	4	1
A	sqlType()	0	4	1
A	sqlPdoType()	0	4	1
A	getAllowedTypes()	0	4	1
A	getJoinTable()	0	4	1

<?php

namespace Charcoal\Property;

use InvalidArgumentException;

/**
 * Multi-Object Property holds references to external objects from different models.
 */
class MultiObjectProperty extends AbstractProperty
{
    /**
     * @var array $allowedTypes
     */
    private $allowedTypes;

    /**
     * @var boolean $groupedByType
     */
    private $groupedByType = true;

    /**
     * @var string $joinTable
     */
    private $joinTable = 'charcoal_multi_objects';

    /**
     * @param array $types The allowed types map.
     * @return MultiObjectProperty Chainable
     */
    public function setAllowedTypes(array $types)
    {
        foreach ($types as $type => $typeOptions) {
            $this->addAllowedType($type, $typeOptions);
        }
        return $this;
    }

    /**
     * @param string $type        The (allowed) object type.
     * @param array  $typeOptions Extra options for the type.
     * @return MultiObjectProperty Chainable
     */
    public function addAllowedType($type, array $typeOptions = [])
    {
        $this->allowedTypes[$type] = $typeOptions;
        return $this;
    }

    /**
     * @return array
     */
    public function getAllowedTypes()
    {
        return $this->allowedTypes;
    }

    /**
     * @param string $table The join table.
     * @throws InvalidArgumentException If the table is not a string or contains invalid table characters.
     * @return MultiObjectProperty Chainable
     */
    public function setJoinTable($table)
    {
        if (!is_string($table)) {
            throw new InvalidArgumentException(
                'Join table must be a string'
            );
        }
        // For security reason, only alphanumeric characters (+ underscores) are valid table names.
        // Although SQL can support more, there's really no reason to.
        if (!preg_match('/[A-Za-z0-9_]/', $table)) {
            throw new InvalidArgumentException(
                sprintf('Table name "%s" is invalid: must be alphanumeric / underscore.', $table)
            );
        }
        $this->joinTable = $table;
        return $this;
    }

    /**
     * @return string
     */
    public function getJoinTable()
    {
        return $this->joinTable;
    }

    /**
     * Create the join table on the database source, if it does not exist.
     *
     * @return void
     */
    public function createJoinTable()
    {
        if ($this->joinTableExists() === true) {
            return;
        }

        $q = 'CREATE TABLE \''.$this->getJoinTable().'\' (
            target_type VARCHAR(255),
            target_id VARCHAR(255),
            target_property VARCHAR(255),
            attachment_type VARCHAR(255),
            attachment_id VARCHAR(255),
            created DATETIME
        )';
        $this->logger->debug($q);
        $this->source()->db()->query($q);

The method source() does not seem to exist on object<Charcoal\Property\MultiObjectProperty>.

    }

    /**
     * @return boolean
     */
    public function joinTableExists()
    {
        $q = 'SHOW TABLES LIKE \''.$this->getJoinTable().'\'';
        $this->logger->debug($q);
        $res = $this->source()->db()->query($q);

The method source() does not seem to exist on object<Charcoal\Property\MultiObjectProperty>.

        $tableExists = $res->fetchColumn(0);

        return !!$tableExists;
    }

    /**
     * @return string
     */
    public function type()
    {
        return 'multi-object';
    }

    /**
     * @return string|null
     */
    public function sqlType()
    {
        return null;
    }

    /**
     * @return integer
     */
    public function sqlPdoType()
    {
        return 0;
    }
}