Blueprint.php

<?php namespace Jenssegers\Mongodb\Schema;

use Closure;
use Illuminate\Database\Connection;

class Blueprint extends \Illuminate\Database\Schema\Blueprint {

	/**
	 * The MongoConnection object for this blueprint.
	 *
	 * @var MongoConnection
	 */
	protected $connection;

	/**
	 * The MongoCollection object for this blueprint.
	 *
	 * @var MongoCollection
	 */
	protected $collection;

	/**
	 * Fluent columns
	 *
	 * @var array
	 */
	protected $columns = array();

	/**
	 * Create a new schema blueprint.
	 *
	 * @param  string   $table
	 * @param  Closure  $callback
	 * @return void
	 */
	public function __construct(Connection $connection, $collection)
	{
		$this->connection = $connection;
		$this->collection = $connection->getCollection($collection);
	}

	/**
	 * Specify an index for the collection.
	 *
	 * @param  string|array  $columns
	 * @param  array         $options
	 * @return bool
	 */
	public function index($columns = null, $options = array())
	{
		$columns = $this->fluent($columns);

		// Columns are passed as a default array
		if (is_array($columns) && is_int(key($columns)))
		{
			// Transform the columns to the required array format
			$transform = array();
			foreach ($columns as $column)
			{
				$transform[$column] = 1;
			}

			$columns = $transform;
		}

		$this->collection->ensureIndex($columns, $options);

		return $this;
	}

	/**
	 * Indicate that the given index should be dropped.
	 *
	 * @param  string|array  $columns
	 * @return bool
	 */
	public function dropIndex($columns = null)
	{
		$columns = $this->fluent($columns);

		foreach ($columns as $column)
		{
			$this->collection->deleteIndex($column);
		}

		return $this;
	}

	/**
	 * Specify a unique index for the collection.
	 *
	 * @param  string|array  $columns
	 * @return bool
	 */
	public function unique($columns = null, $name = null)
	{
		$columns = $this->fluent($columns);
		$this->index($columns, array('unique' => true));

		return $this;
	}

	/**
	 * Specify a non blocking index for the collection.
	 *
	 * @param  string|array  $columns
	 * @return bool
	 */
	public function background($columns = null)
	{
		$columns = $this->fluent($columns);
		$this->index($columns, array('background' => true));

		return $this;
	}

	/**
	 * Specify a sparse index for the collection.
	 *
	 * @param  string|array  $columns
	 * @return bool
	 */
	public function sparse($columns = null)
	{
		$columns = $this->fluent($columns);
		$this->index($columns, array('sparse' => true));

		return $this;
	}

	/**
	 * Specify the number of seconds after wich a document should be considered expired based,
	 * on the given single-field index containing a date.
	 *
	 * @param  string|array  $columns
	 * @param  int           $seconds
	 * @return bool
	 */
	public function expire($columns, $seconds)
	{
		$columns = $this->fluent($columns);
		$this->index($columns, array('expireAfterSeconds' => $seconds));

		return $this;
	}

	/**
	 * Indicate that the table needs to be created.
	 *
	 * @return bool
	 */
	public function create()
	{
		$collection = $this->collection->getName();

		// Ensure the collection is created
		$db = $this->connection->getMongoDB();
		$db->createCollection($collection);
	}

	/**
	 * Indicate that the collection should be dropped.
	 *
	 * @return bool
	 */
	public function drop()
	{
		$this->collection->drop();
	}

	/**
	 * Add a new column to the blueprint.
	 *
	 * @param  string  $type
	 * @param  string  $name
	 * @param  array   $parameters
	 * @return Blueprint
	 */
	protected function addColumn($type, $name, array $parameters = array())
	{
		$this->fluent($name);
		return $this;
	}

	/**
	 * Allow fluent columns
	 *
	 * @param  string|array  $columns
	 * @return string|array
	 */
	protected function fluent($columns = null)
	{
		if (is_null($columns))
		{
			return $this->columns;
		}
		else if (is_string($columns))
		{
			return $this->columns = array($columns);
		}
		else
		{
			return $this->columns = $columns;
		}
	}

}