gamernetwork / yolk-support

src/Fieldset.php

<?php
/*
 * This file is part of Yolk - Gamer Network's PHP Framework.
 *
 * Copyright (c) 2013 Gamer Network Ltd.
 * 
 * Distributed under the MIT License, a copy of which is available in the
 * LICENSE file that was bundled with this package, or online at:
 * https://github.com/gamernetwork/yolk
 */

namespace yolk\support;

use yolk\contracts\support\Type;

/**
 * A set of field definitions and associated validation rules.
 */
class Fieldset implements \IteratorAggregate, \Countable {

	/**
	 * Array of fields defined in this fieldset.
	 * @var array
	 */
	protected $fields;

	protected $types;

	public function __construct() {
		$this->fields = [];
		$this->types  = [];
	}

	/**
	 * Add a new field definition.
	 * @param  string   $name    name of the field
	 * @param  string   $type    one of the \yolk\contracts\support\Type constants or a string containing a custom type
	 * @param  array    $rules   an array of validation rules
	 * @return self
	 */
	public function add( $name, $type = Type::TEXT, $rules = [] ) {
		$this->fields[$name] = new Field($name, $type, $rules);
		$this->types = [];	// clear this so it will be refreshed when we've finished adding fields
		return $this;
	}

	/**
	 * Validate the data in the specified array.
	 * @param  array $data
	 * @return array first element is an array of cleaned data, second is an array of the errors (if any)
	 */
	public function validate( array $data ) {

		$errors = [];

		foreach( $this->fields as $field ) {

			$f = $field->name;
			$v = isset($data[$f]) ? $data[$f] : null;

			list($clean, $errors[$f]) = $field->validate($v);

			if( !$errors[$f] )
				$data[$f] = $clean;

		}

		return [
			$data,
			array_filter($errors),
		];

	}

	public function listNames() {
		return array_keys($this->fields);
	}

	public function getDefaults() {
		$defaults = [];
		foreach( $this->fields as $field ) {
			$defaults[$field->name] = $field->default;
		}
		return $defaults;
	}

	public function __get( $key ) {
		return isset($this->fields[$key]) ? $this->fields[$key] : null;
	}

	public function __isset( $key ) {
		return isset($this->fields[$key]);
	}

	public function getIterator() {
		return new \ArrayIterator($this->fields);
	}

	public function count() {
		return count($this->fields);
	}

	public function getByType( $type ) {

		$type = strtolower($type);

		if( !$this->types ) {

The expression $this->types of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

			$this->types['unique'] = [];
			foreach( $this->fields as $field ) {

				if( !isset($this->types[$field->type]) )
					$this->types[$field->type] = [];

				$this->types[$field->type][] = $field->name;

				if( $field->isUnique() )
					$this->types['unique'][] = $field->name;

			}
		}

		return isset($this->types[$type]) ? $this->types[$type] : [];

	}

}

// EOF