Configurable.php
2.78 KB
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<?php
/**
* i-Educar - Sistema de gestão escolar
*
* Copyright (C) 2006 Prefeitura Municipal de Itajaí
* <ctima@itajai.sc.gov.br>
*
* Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo
* sob os termos da Licença Pública Geral GNU conforme publicada pela Free
* Software Foundation; tanto a versão 2 da Licença, como (a seu critério)
* qualquer versão posterior.
*
* Este programa é distribuído na expectativa de que seja útil, porém, SEM
* NENHUMA GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU
* ADEQUAÇÃO A UMA FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral
* do GNU para mais detalhes.
*
* Você deve ter recebido uma cópia da Licença Pública Geral do GNU junto
* com este programa; se não, escreva para a Free Software Foundation, Inc., no
* endereço 59 Temple Street, Suite 330, Boston, MA 02111-1307 USA.
*
* @author Eriksen Costa Paixão <eriksen.paixao_bs@cobra.com.br>
* @category i-Educar
* @license @@license@@
* @package CoreExt_Configurable
* @since Arquivo disponível desde a versão 1.1.0
* @version $Id$
*/
/**
* CoreExt_Configurable interface.
*
* Essa interface tem como objetivo prover uma API uniforme para classes que
* definem parâmetros de configuração. Basicamente provê apenas o método
* público setOptions, que recebe um array de parâmetros. Como o PHP não
* permite herança múltipla, essa API apenas reforça a idéia de se criar uma
* uniformidade entre as diferentes classes configuráveis do i-Educar.
*
* Uma sugestão de implementação do método setOptions é dada pelo exemplo a
* seguir:
* <code>
* <?php
* protected $_options = array(
* 'option1' => NULL,
* 'option2' => NULL
* );
*
* public function setOptions(array $options = array())
* {
* $defaultOptions = array_keys($this->getOptions());
* $passedOptions = array_keys($options);
*
* if (0 < count(array_diff($passedOptions, $defaultOptions))) {
* throw new InvalidArgumentException(
* sprintf('A classe %s não suporta as opções: %s.', get_class($this), implode(', ', $passedOptions))
* );
* }
*
* $this->_options = array_merge($this->getOptions(), $options);
* return $this;
* }
*
* public function getOptions()
* {
* return $this->_options;
* }
* </code>
*
* @author Eriksen Costa Paixão <eriksen.paixao_bs@cobra.com.br>
* @category i-Educar
* @license @@license@@
* @package CoreExt_Configurable
* @since Interface disponível desde a versão 1.1.0
* @version @@package_version@@
*/
interface CoreExt_Configurable
{
/**
* Setter.
* @param array $options
* @return CoreExt_Configurable Provê interface fluída
*/
public function setOptions(array $options = array());
/**
* Getter.
* @return array
*/
public function getOptions();
}