TableBundle/TableFactoryInterface.php at master · Tactics/TableBundle · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license intableation, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tactics\TableBundle;

/**
 * @author Gert Vrebos <gert.vrebos at tactics.be>
 */
interface TableFactoryInterface
{

    public function createBuilder($type = '', array $options = array());


    /**
     * Returns a table.
     *
     * @param string                    $name    The name of the table
     * @param string|TableTypeInterface $type    The type of the table
     * @param array                    $options The options
     *
     * @return TableInterface The table
     *
     * @throws Exception\TableException if any given option is not applicable to the given type
     */
    public function createTable($name, $type = '', array $options = array());

    /**
     * Returns a column.
     *
     * @param string                    $name    The name of the table
     * @param string|TableTypeInterface $type    The type of the table
     * @param ColumnHeader              $columnHeader
     * @param array                    $options The options
     *
     * @return ColumnInterface The column
     *
     * @throws Exception\TableException if any given option is not applicable to the given type
     */
    public function createColumn($name, $type = '', ColumnHeaderInterface $columnHeader, array $options = array());


    /**
     * Returns a column header.
     *
     * @param string                    $name    The name of the table
     * @param string|TableTypeInterface $type    The type of the table
     * @param array                    $options The options
     *
     * @return ColumnHeaderInterface The table
     *
     * @throws Exception\TableException if any given option is not applicable to the given type
     */
    public function createColumnHeader($name, $type = '', array $options = array());

}