TableBuilderInterface.php

<?php

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

namespace Tactics\TableBundle;

/**
 * Description of TableBuilderInterface
 *
 * @author gert
 */
interface TableBuilderInterface extends \Traversable, \Countable
{
    /**
     * Adds a new field to this group. A field must have a unique name within
     * the group. Otherwise the existing field is overwritten.
     *
     * If you add a nested group, this group should also be represented in the
     * object hierarchy.
     *
     * @param string|TableBuilderInterface $child
     * @param string|TableTypeInterface    $type
     * @param string|array                 $headerTypeOrOptions
     * @param array                        $options
     *
     * @return TableBuilderInterface The builder object.
     */
    public function add($child, $type = null, $headerTypeOrOptions = null, array $options = array());

    /**
     * Creates a new column
     *
     * @param string                   $name    The name of the form or the name of the property
     * @param string|TableTypeInterface $type    The type of the form or null if name is a property
     * @param array                    $options The options
     *
     * @return TableBuilderInterface The created builder
     */
    public function create($name, $type = null, $headerType = null, array $options = array());
    
    /**
     * Returns a child by name.
     *
     * @param string $name The name of the child
     *
     * @return TableBuilderInterface The builder for the child
     *
     * @throws Exception\TableException if the given child does not exist
     */
    public function get($name);
    /**
     * Removes the field with the given name.
     *
     * @param string $name
     *
     * @return TableBuilderInterface The builder object.
     */
    public function remove($name);

    /**
     * Returns whether a field with the given name exists.
     *
     * @param string $name
     *
     * @return Boolean
     */
    public function has($name);

    /**
     * Returns the children.
     *
     * @return array
     */
    public function all();

    /**
     * Returns the associated table factory.
     *
     * @return TableFactoryInterface The factory
     */
    public function getTableFactory();

    /**
     * Creates the table.
     *
     * @return Table The table
     */
    public function getTable();
  
}