Instituto Chico Mendes Manual dos componentes do SIAL - ICMBio

Manual dos componentes do SIAL 

Versão: 1.1.1 

Página 

1 / 236 

Data 

04/02/2012 

Instituto Chico Mendes 

Manual dos componentes do SIAL


Histórico de Revisão 


Data Versão Descrição Autor 

24/02/2012 0.0.1 Criação do documento André Borges 

05/03/2012 0.0.2 Agrupamento dos componentes por 

namespace. 

André Borges 

Documentação dos operadores e das 

funções SQL ANSI/92 

Página 

2 / 236 

Data 

04/02/2012

Sumário 



Página 

3 / 236 

Data 

04/02/2012 

br\gov\icmbio\sial\exception.......................................................................................................23 

ClassNotFoundxception...........................................................................................................23 

public function __construct ($message, $code = NULL, $previous = NULL).............23 

IllegalArgumentException.......................................................................................................23 

public function __construct ($message, $code = 0, $previous = NULL)....................24 

public static function argumentCantBeNull ($argument)...........................................24 

public static function invalidArgument ($argument)....................................................24 

IOException.................................................................................................................................24 


public static function notIsAValidFile ($file)...................................................................25 

SIALException.............................................................................................................................25 


public static function throwsExceptionIfParamIsNull ($avaliable, $message)........25 

br\gov\icmbio\sial\lang.................................................................................................................26 

Date..............................................................................................................................................26 

public function addDay ($number)...................................................................................26 

public function subDay ($number)...................................................................................26 

public function output ()....................................................................................................27 

public static function factory ($date = NULL, $formatIn = NULL, $formatOut = 

NULL).......................................................................................................................................27 

Enum............................................................................................................................................27 

public static function factory ($class, array $elements = array ()).............................27 

TFile..............................................................................................................................................28 

public function __construct ($name = NULL, $type = NULL, $source = NULL, $error 

= NULL, $size = NULL)...........................................................................................................28 

public function getName ()................................................................................................28 

public function getType ()..................................................................................................29 

public function getSource ()..............................................................................................29 

public function getError ().................................................................................................29 

public function getSize ()....................................................................................................29 

public function setName ($name = NULL)......................................................................29 

public function setType ($type = NULL)..........................................................................30 

public function setSource ($source = NULL)...................................................................30 

public function setError ($error = NULL).........................................................................30 

public function setSize ($size = NULL).............................................................................30 

TFileContent...............................................................................................................................31 

public function __construct ($content = NULL).............................................................31 

public function getContent ()............................................................................................31 

public function setContent ($content = NULL)..............................................................31 

br\gov\icmbio\sial\mvcb\business..............................................................................................32 

BusinessAbstract.......................................................................................................................32 

public function __construct ()............................................................................................32 

public function commit ()...................................................................................................32



Página 

4 / 236 

Data 

04/02/2012 

public function transaction ()............................................................................................32 

public function rollback ()..................................................................................................32 

public function find ($key)..................................................................................................33 

public function findAll ().....................................................................................................33 

public function findByParam (ValueObjectAbstract $valueObject, $limit = 10, 

$offSet = 0).............................................................................................................................33 

public function getModel ()...............................................................................................33 

public static function factory ($namespace)..................................................................34 

public function getModelPersist ($persist)....................................................................34 

public function registerAnnotation ($namespace).......................................................34 

BusinessCrudAbstract...............................................................................................................34 

public function save (ValueObjectAbstract $valueObject)..........................................35 

public function delete (ValueObjectAbstract $valueObject)......................................35 

public function findByParam (ValueObjectAbstract $valueObject)..........................35 

public function update (ValueObjectAbstract $valueObject).....................................35 

br\gov\icmbio\sial\mvcb\business\exception..........................................................................36 

BusinessException.....................................................................................................................36 

public static function businessNotImplemented ($businessName)...........................36 

br\gov\icmbio\sial\mvcb\controller...........................................................................................36 

ControllerAbstract.....................................................................................................................36 

public function __construct ()............................................................................................37 

public function setViewType ($type)...............................................................................37 

public function bootstrap ()...............................................................................................37 

public function constant ($name, $shortname = TRUE)...............................................37 

public function getBusiness ($target = NULL)...............................................................38 

public function getNamespaceFuncionality (self $ctrl = NULL)..................................38 

public function getView ()..................................................................................................38 

public function getValueObject ($target = NULL, $data = NULL)..............................38 

public function hasAction ($actionName).......................................................................39 

public function isCookie ()..................................................................................................39 

public function isGet ()........................................................................................................39 

public function isPost ()......................................................................................................39 

public function request ()...................................................................................................40 

final protected function _forward ($action, $controller = NULL, array $params = 

NULL).......................................................................................................................................40 

public function registryViewScriptPath (ControllerAbstract $ctrl)...........................41 

ErrorController...........................................................................................................................41 

public function __construct (\br\gov\icmbio\sial\exception\SIALException $siale) 

..................................................................................................................................................41 

public function errorAction ()............................................................................................41 

br\gov\icmbio\sial\mvcb\controller\exception........................................................................42 

ControllerException..................................................................................................................42 

public function __construct ($message = '', $code = 0, \Exception $previous = 

NULL).......................................................................................................................................42 

br\gov\icmbio\sial\mvcb\model..................................................................................................42 

ModelAbstract............................................................................................................................42 

public function __construct ($dsName)...........................................................................43



Página 

5 / 236 

Data 

04/02/2012 

public function __call($name, array $arguments = array()).........................................43 

public static function exists ($namespace).....................................................................43 

public function getPersist ()..............................................................................................43 




public function find ($idx)..................................................................................................44 



$offSet = 0).............................................................................................................................45 

public function getAllValueObject ()...............................................................................45 

public function getValueObject ()....................................................................................45 

public function getDataViewObject ().............................................................................45 

public function getAllDataViewObject ()........................................................................46 

public function registerAnnotation ($namespace).......................................................46 

public static function factory ($namespace, $dsName = NULL).................................46 

br\gov\icmbio\sial\mvcb\model\exception..............................................................................46 

ModelException.........................................................................................................................46 

public static function modelNotImplemented ($modelName)...................................47 

br\gov\icmbio\sial\mvcb\view.....................................................................................................47 

ViewAbstract..............................................................................................................................47 

public function __construct ($engine).............................................................................47 

public static function factory ($type, $namespace)......................................................48 

public abstract function addScriptPath ($scriptPath)...................................................48 

public abstract function clean ().......................................................................................48 

public abstract function get ($key)...................................................................................48 

public abstract function getAll ()......................................................................................49 

public abstract function isAssign ($key)..........................................................................49 

public abstract function remove ($key)...........................................................................49 

public abstract function render ($script)........................................................................49 

public abstract function set ($key, $value).....................................................................49 

public abstract function setEncoding ($encode)...........................................................50 

public abstract function setScriptPath ($scriptPath)....................................................50 

public abstract function getScriptPaths ()......................................................................50 

public abstract function registerViewScriptBasedFromController 

(ControllerAbstract $ctrl)....................................................................................................50 

Json..............................................................................................................................................51 

public function __construct (array $config = array())....................................................51 

public function registerViewScriptBasedFromController (ControllerAbstract $ctrl) 

..................................................................................................................................................51 

Html..............................................................................................................................................51 


public function addScriptPath ($scriptPath)...................................................................52 

public function clean ().......................................................................................................52 

public function get ($key)...................................................................................................52 

public function getAll ()......................................................................................................53 

public abstract function isAssign ($key)..........................................................................53



Página 

6 / 236 

Data 

04/02/2012 

public abstract function remove ($key)...........................................................................53 

public abstract function render ($script)........................................................................53 

public abstract function set ($key, $value).....................................................................54 

public abstract function setEncoding ($encode)...........................................................54 

public abstract function setScriptPath ($scriptPath)....................................................54 

public abstract function getScriptPaths ()......................................................................54 


(ControllerAbstract $ctrl)....................................................................................................54 

Helper..........................................................................................................................................55 

public function __call ($helper, $args).............................................................................55 

public static function registerNamespace ($namespace)............................................55 

br\gov\icmbio\sial\mvcb\view\exception.................................................................................56 

HelperException........................................................................................................................56 

ViewException............................................................................................................................56 

br\gov\icmbio\sial\mvcb\view\helper........................................................................................56 

BuildUrl........................................................................................................................................56 

public function buildUrl (array $urlParam, $appendParam = TRUE, $url = NULL, 

$friendlyMode = TRUE)........................................................................................................57 

public static function getDomain ($port)........................................................................57 

public static function makeQuery (array $urlParams, $appendParam, 

$friendlyMode, $externalLink)...........................................................................................57 

Downloader................................................................................................................................57 

public function downloader (ValueObjectAbstract $voFile).......................................58 

br\gov\icmbio\sial\persist............................................................................................................58 

Connect........................................................................................................................................58 

public function __construct (\br\gov\icmbio\sial\persist\PersistConfig $config). .58 

protected abstract function _connect (\br\gov\icmbio\sial\persist\PersistConfig 

$config)...................................................................................................................................59 

public abstract function commit ()...................................................................................59 

public function getAdapter ()............................................................................................59 

public function getDriver ()................................................................................................59 

public function getSource ()..............................................................................................59 

public abstract function hasTransactionRunning ()......................................................60 

public abstract function retrieve ()..................................................................................60 

public abstract function rollback ()..................................................................................60 

public abstract function transaction ()............................................................................60 

public abstract function update ()....................................................................................60 

public static function factory (\br\gov\icmbio\sial\persist\PersistConfig $config)61 

Persist..........................................................................................................................................61 

public function __construct (PersistConfig $config).....................................................61 

public static function exists ($namespace, $throws = FALSE).....................................61 


$config)...................................................................................................................................62 

public function annotation ().............................................................................................62 

public function getConnect ()............................................................................................62 

public function orderBy ($field, $order = 'ASC').............................................................62 

public function sorter ($query).........................................................................................63



Página 

7 / 236 

Data 

04/02/2012 

public function isAttrPersistable (\stdClass $attr, $adapter).....................................63 

public static function factory ($namespace, PersistConfig $config).........................63 

public function registerAnnotation ($annotation)........................................................63 

public function getConfig ()...............................................................................................64 

Persistable...................................................................................................................................64 





PersistConfig..............................................................................................................................65 


protected abstract function _valid (array $config)........................................................66 

public final static function adapaterAccepet ($adapter).............................................66 

public abstract function getDSN ()...................................................................................66 

public static function registerConfigs ($data)................................................................66 

public static function factory ($dsName = NULL)..........................................................67 

PersistLogAbstract....................................................................................................................67 

public static function bootstrap (BootstrapAbstract $bootstrap).............................67 

public function registerUser ($userid).............................................................................67 

public abstract function save (ValueObjectAbstract $valueObject, $operation)....68 

public abstract function isKeepHistory (ValueObjectAbstract $valueObject)........68 

public static function getValueRecursively (ValueObjectAbstract $valueObject, 

$get)........................................................................................................................................68 

public abstract function makeQuery (ValueObjectAbstract $valueObject, 

$operation).............................................................................................................................69 

public function fetch (ValueObjectAbstract $valueObject)........................................69 

public abstract function fields (\br\gov\icmbio\sial\util\Annotation $annon)........69 

public abstract function translante (\br\gov\icmbio\sial\util\Annotation $annon, 

array $list = NULL).................................................................................................................69 

public abstract static function factory (Persist $persist).............................................70 

ResultSet.....................................................................................................................................70 

public function __construct ($resultSet).........................................................................70 

public function query ()......................................................................................................70 

public abstract function fetch ().......................................................................................71 

public abstract function count ().......................................................................................71 

br\gov\icmbio\sial\persist\database..........................................................................................71 

Config...........................................................................................................................................71 


Connect........................................................................................................................................72 

public function __construct (\br\gov\icmbio\sial\persist\database\Config $config) 

..................................................................................................................................................72 

public function update ()....................................................................................................72 

public function retrieve ()..................................................................................................72 

public function prepare ($query, $params = NULL)......................................................73 

public function hasTransactionRunning ()......................................................................73 

public abstract function transaction ()............................................................................73 

public abstract function retrieve ()..................................................................................73



Página 

8 / 236 

Data 

04/02/2012 

public function commit ()...................................................................................................73 

public abstract function rollback ()..................................................................................74 

public abstract function update ()....................................................................................74 

public function closeCursor ()............................................................................................74 

public static function factory (\br\gov\icmbio\sial\persist\PersistConfig $config)74 

Persist - Database......................................................................................................................74 

public function __construct (\br\gov\icmbio\sial\persist\PersistConfig $config = 

NULL).......................................................................................................................................75 

public function execute ($query, $params = NULL)......................................................75 



public function findByParam (ValueObjectAbstract $valueObject, $limit = 'ALL', 

$offSet = 0).............................................................................................................................76 




protected function _connect (\br\gov\icmbio\sial\persist\PersistConfig $config) 77 

protected static function _injectResultOnValueObject (ValueObjectAbstract 

$valueObject, ResultSet $resultSet).................................................................................77 

public static function getValue (ValueObjectAbstract $valueObject, 

$accessorMethod, $dataType)...........................................................................................77 

public function sorter ($query).........................................................................................78 

public function log (ValueObjectAbstract $valueObject, $operation)......................78 

public function getEntityName (\stdClass $annon)......................................................78 

public function persistAttr (ValueObjectAbstract $valueObject, $operType = 

NULL).......................................................................................................................................78 

public function queryLimit ($limit)...................................................................................79 

PersistLog....................................................................................................................................79 

public function __construct (Persist $persist)................................................................79 

public function save (ValueObjectAbstract $valueObject, $operation)....................79 

public function makeQuery (ValueObjectAbstract $valueObject, $operation)......80 

public function isKeepHistory (ValueObjectAbstract $valueObject)........................80 

public function fields (\br\gov\icmbio\sial\util\Annotation $annon, array $list = 

NULL).......................................................................................................................................80 

public function translante (\br\gov\icmbio\sial\util\Annotation $annon, array $list 

= NULL)....................................................................................................................................81 

public abstract static function factory (Persist $persist).............................................81 

ResultSet.....................................................................................................................................81 

public function __construct (\PDOStatement $resultSet)...........................................81 

public function fetch ().......................................................................................................82 

public function count ().......................................................................................................82 

SQLInject.....................................................................................................................................82 

public function encode ($content)...................................................................................82 

public function decode ($content)...................................................................................83 

br\gov\icmbio\sial\persist\database\mysql..............................................................................83 

Config...........................................................................................................................................83 

public function __construct (array $config = array())....................................................83



Página 

9 / 236 

Data 

04/02/2012 

public function getDSN()....................................................................................................83 

protected function _valid (array $config)........................................................................84 

Connect........................................................................................................................................84 


..................................................................................................................................................84 

protected function _connect(\br\gov\icmbio\sial\persist\persistConfig $config).84 

Persist..........................................................................................................................................85 

public function __construct (PDatabase $persist).........................................................85 




$offSet = 0).............................................................................................................................86 





br\gov\icmbio\sial\persist\database\pgsql..............................................................................87 

Config...........................................................................................................................................87 




Connect........................................................................................................................................88 


..................................................................................................................................................88 


Persist..........................................................................................................................................89 





$offSet = 0).............................................................................................................................90 





br\gov\icmbio\sial\persist\database\sqlite..............................................................................91 

Config...........................................................................................................................................91 




Connect........................................................................................................................................92 


Método construtor................................................................................................................92 


Persist..........................................................................................................................................93 


public function execute ($query, $params = NULL)......................................................93



Página 

10 / 236 

Data 

04/02/2012 



$offSet = 0).............................................................................................................................94 





protected static final function _getEntityFields (\stdClass $annon).........................95 

protected static function _buildBasicQuery (\stdClass $annon)................................95 

br\gov\icmbio\sial\persist\exception.........................................................................................95 

PersistException........................................................................................................................95 

public function __construct($message = '', $code = 0, \Exception $previous = 

NULL).......................................................................................................................................96 

public static function propertyRequired ($property)...................................................96 

public static function adapterUnsupported ($adapter)...............................................96 

br\gov\icmbio\sial\persist\file.....................................................................................................97 

Config...........................................................................................................................................97 


public function _valid (array $config)...............................................................................97 

public function getDSN ()...................................................................................................97 


Connect........................................................................................................................................97 

public function __construct (\br\gov\icmbio\sial\persist\file\Config $config).......98 

protected function _connect(TFile $TFile)......................................................................98 

Persist..........................................................................................................................................98 

public function _connect (\br\gov\icmbio\sial\persist\persistConfig $config).......99 

public function find ($voFile).............................................................................................99 

public function save (ValueObjectAbstract $voFile).....................................................99 

public function update (ValueObjectAbstract $voFile)................................................99 

public function delete (ValueObjectAbstract $voFile).................................................99 

public function getQuery ($entity)................................................................................100 

public function getEntity ($entity, array $columns = array())...................................100 

br\gov\icmbio\sial\persist\ldap................................................................................................100 

Config.........................................................................................................................................100 

public function __construct (array $config = array())..................................................100 

public function getDSN()..................................................................................................100 

protected function _valid (array $config).....................................................................101 

public static function factory ($dsName = NULL)........................................................101 

Connect.....................................................................................................................................101 

public function __construct (\br\gov\icmbio\sial\persist\ldap\Config $config)...101 

protected function _connect(\br\gov\icmbio\sial\persist\persistConfig $config) 

................................................................................................................................................101 

public function update ()..................................................................................................102 

public function retrieve ()................................................................................................102 

public function getParams ()...........................................................................................102 

public function prepare ($query, $params)..................................................................102 

public function hasTransactionRunning ()....................................................................103



Página 

11 / 236 

Data 

04/02/2012 

public function transaction ()..........................................................................................103 

public function commit ().................................................................................................103 

public function rollback ()................................................................................................103 

public static function factory (\br\gov\icmbio\sial\persist\persistConfig $config) 

................................................................................................................................................103 

public function getResource ()........................................................................................104 

Persist........................................................................................................................................104 

public function __construct (\br\gov\icmbio\sial\persist\persistConfig $config = 

NULL).....................................................................................................................................104 

protected function _connect (\br\gov\icmbio\sial\persist\persistConfig $config) 

................................................................................................................................................104 

public function find ($key)...............................................................................................105 

public function save (ValueObjectAbstract $valueObject).......................................105 

public function update (ValueObjectAbstract $valueObject)..................................105 

public function delete (ValueObjectAbstract $valueObject) ...................................105 

ResultSet...................................................................................................................................106 

public function __construct (\br\gov\icmbio\sial\persist\ldap\Connect $connect, 

$resultset)............................................................................................................................106 

public function fetch ().....................................................................................................106 

public function count ()....................................................................................................106 

br\gov\icmbio\sial\persist\query..............................................................................................107 

AndAbstract..............................................................................................................................107 

abstract class AndAbstract extends LogicAbstract.....................................................107 

ClauseAbstract.........................................................................................................................107 

private function __construct ()........................................................................................107 

public function column ($columns)................................................................................107 

public function render ()..................................................................................................108 

public static function factory ().......................................................................................108 

Column.......................................................................................................................................108 

public function __construct ($column, $entity = NULL).............................................108 

public function name ().....................................................................................................109 

public function qualifiedName ()....................................................................................109 

public function alias ().......................................................................................................109 

public function entity ()....................................................................................................109 

public function setAlias ($alias)......................................................................................110 


public function __toString ()............................................................................................110 

public function ignoreColumn ($column, $entity, $dataSource)..............................110 

public function columnExists ($column, $entity, $dataSource)...............................111 

public static function factory ($column, Entity $entity, $type)................................111 

Entity..........................................................................................................................................111 

public function __construct ($entity, array $columns = array())...............................112 

public function column ($column)..................................................................................112 

protected function _setup (ValueObjectAbstract $valueObject, $columns).........112 

public function qualifiedName ()....................................................................................112 

public function schema ().................................................................................................113 

public function name ().....................................................................................................113



Página 

12 / 236 

Data 

04/02/2012 

public function alias ().......................................................................................................113 

public function columns ()................................................................................................113 

Expression.................................................................................................................................114 

public function __construct ($expression)....................................................................114 


ExpressionAbstract.................................................................................................................114 

FunctionAbstract.....................................................................................................................115 

public function __construct (Renderizable $element)...............................................115 


InstructAbstract.......................................................................................................................115 

JoinAbstract.............................................................................................................................116 


public static function factory (Entity $entity, RelationalAbstract $conditional). .116 

LogicAbstract...........................................................................................................................116 

private function __construct ()........................................................................................117 

public function add (OperatorAbstract $expression, $operator = 

self::T_AND_OPERATOR)...................................................................................................117 

public function setQuery (QueryAbstract $query).....................................................117 

public function __call ($name, $arguments).................................................................117 


public static function factory (QueryAbstract $query)..............................................118 

OperatorAbstract....................................................................................................................118 


QueryAbstract..........................................................................................................................119 

public function hasEntity ()..............................................................................................119 

public function entity ()....................................................................................................119 

public function __get ($column).....................................................................................119 

public function column ($column)...................................................................................120 

public function col ($column)..........................................................................................121 

public abstract function addColumn ($column);..........................................................121 

public abstract function expression ($alias, $expression);.........................................121 

public abstract function where (RelationalAbstract $conditional)..........................121 

public abstract function join (Entity $entity, RelationalAbstract $conditional);....121 

public abstract function leftJoin (Entity $entity, RelationalAbstract $conditional); 

................................................................................................................................................122 

public abstract function rightJoin (Entity $entity, RelationalAbstract $conditional); 

................................................................................................................................................122 

public abstract function groupBy ($columns);.............................................................122 

public abstract function having ($columns);.................................................................122 

public abstract function orderBy ($columns);...............................................................123 

public abstract function limit ($limit, $offset);.............................................................124 

public static function factory ($type, $entity = NULL)................................................124 

public function __toString ().............................................................................................125 

RelationalAbstract..................................................................................................................125 

SelectAbstract..........................................................................................................................125 

br\gov\icmbio\sial\persist\query\database...........................................................................126 

Avg..............................................................................................................................................126



Página 

13 / 236 

Data 

04/02/2012 

Between....................................................................................................................................126 

public function __construct (Column $column, $fParam, $sParam)........................126 

public function render ().......................................................................................................127 

Column.......................................................................................................................................127 

public function __call($method, $arguments)..............................................................127 

public function order ().....................................................................................................128 

public function orderBy ($order = 'ASC').......................................................................128 

public function distinct ()..................................................................................................128 

public function avg ().........................................................................................................129 


public function sum ()........................................................................................................129 

public function max ()........................................................................................................129 

public function min ().........................................................................................................129 

public function render ()...................................................................................................130 

Count..........................................................................................................................................130 

Distinct......................................................................................................................................130 

Equals.........................................................................................................................................130 

Expression.................................................................................................................................131 

public function __construct ($expression)....................................................................131 


From...........................................................................................................................................131 

public function __construct (Entity $entity = NULL)...................................................132 

public function entity ().....................................................................................................132 

public function alias ()........................................................................................................132 

public function qualifiedName ().....................................................................................132 


public static function factory (Entity $entity = NULL)................................................133 

GreaterThan..............................................................................................................................133 

GreaterThanOrEquals.............................................................................................................133 

GroupBy.....................................................................................................................................134 

Having........................................................................................................................................134 

In.................................................................................................................................................134 

InnerJoin...................................................................................................................................134 

LeftJoin.....................................................................................................................................135 

RightJoin...................................................................................................................................135 

IsNotNull...................................................................................................................................135 

public function __construct (Column $column)...........................................................136 


IsNull..........................................................................................................................................136 

public function __construct (Column $column)...........................................................136 


LessThan....................................................................................................................................137 

LessThanOrEquals...................................................................................................................137 

Like.............................................................................................................................................137 

LimitAbstract............................................................................................................................138 

public function set ($limit, $offset)...............................................................................138 

public static function factory ($driver)...........................................................................138



Página 

14 / 236 

Data 

04/02/2012 

Max.............................................................................................................................................139 

Min..............................................................................................................................................139 

NotEquals..................................................................................................................................139 

NotIn..........................................................................................................................................139 

OrderBy.....................................................................................................................................140 

public function getColumns ().........................................................................................140 


Query.........................................................................................................................................141 

private function __construct ($driver, Entity $entity = NULL)..................................141 

public function cleanColumn ()........................................................................................141 

public function addColumn ($column)............................................................................141 

public function expression ($alias, $expression)..........................................................142 

public function __call($method, $arguments)..............................................................142 

public function where (RelationalAbstract $conditional, $operator = 

Where::T_AND_OPERATOR).............................................................................................143 

public function join (Entity $entity, RelationalAbstract $conditional).....................143 

public function leftJoin (Entity $entity, RelationalAbstract $conditional).............144 

public function rightJoin (Entity $entity, RelationalAbstract $conditional)...........145 

public function groupBy ($columns)...............................................................................145 

public function having ($columns)..................................................................................146 

public function orderBy ($columns)................................................................................146 

public function limit ($limit, $offset)..............................................................................147 


public static function factory ($driver, $entity = NULL).............................................147 

RelationalAbstract..................................................................................................................148 

public function __construct (Column $column, $value)..............................................148 

public function converteValue ($value)..........................................................................149 


RightJoin...................................................................................................................................149 

SelectAbstract..........................................................................................................................149 

public function __construct (Entity $entity = NULL)...................................................150 

public function cleanrColumn ()......................................................................................150 

public function from (Entity $entity)..............................................................................150 

public function where (Where $where)..........................................................................150 

public function join (JoinAbstract $join)........................................................................151 

public function groupBy (GroupBy $groupBy)..............................................................151 

public function orderBy ($orderBy)................................................................................151 

public function having ($having)......................................................................................151 

public function limit (LimitAbstract $limit)...................................................................152 

public function valueCare ($value, $type).....................................................................152 

public function addColumn (Column $column)............................................................152 

public function hasColunm ($name)..............................................................................152 

public function getColumn ($name)..............................................................................153 


Sum.............................................................................................................................................153 

Where.........................................................................................................................................153 

br\gov\icmbio\sial\persist\query\database\pgsql................................................................154



Página 

15 / 236 

Data 

04/02/2012 

Limit...........................................................................................................................................154 

public function __construct ().........................................................................................154 


Query.........................................................................................................................................154 

public static function factory ($type, $entity = NULL, $columns = NULL)..............155 

Select.........................................................................................................................................155 

public function __construct(Entity $entity = NULL).....................................................155 

public static function factory (Entity $entity = NULL).................................................155 

br\gov\icmbio\sial\persist\reflection......................................................................................156 

Reflection..................................................................................................................................156 

public function __construct (Annotation $annotation, Connect $connect)...........156 

public static function factory ($source, Connect $connect)......................................156 

public abstract function property ($name = NULL)....................................................157 

public abstract function properties ()............................................................................157 

br\gov\icmbio\sial\persist\reflection\adapter\database\pgsql.........................................157 

Reflection..................................................................................................................................157 

public static function factory ($source, \br\gov\icmbio\sial\persist\Connect 

$connect)..............................................................................................................................157 

public function property ($name = NULL)....................................................................158 

public abstract function properties ()............................................................................158 

br\gov\icmbio\sial\persist\util..................................................................................................158 

Annotation................................................................................................................................158 

public function __construct (ValueObjectAbstract $valueObject)..........................159 

public function cache ()....................................................................................................159 

public function load ().......................................................................................................159 

public function getClassDoc ()........................................................................................159 

public function getAttrsDoc ().............................................................................................159 

br\gov\icmbio\sial\persist\webservice....................................................................................160 

Webservice...............................................................................................................................160 

public function __construct (array $config = array())..................................................160 

public function getDSN()..................................................................................................160 

protected function _valid (array $config).....................................................................160 

public static function factory ($dsName = NULL)........................................................161 

Connect.....................................................................................................................................161 

public function __construct (\br\gov\icmbio\sial\persist\webservice\Config 

$config).................................................................................................................................161 


................................................................................................................................................161 

public function update ()..................................................................................................161 

public function retrieve ()................................................................................................162 

public function prepare ($query, $params)..................................................................162 

public function hasTransactionRunning ()....................................................................162 

public function transaction ()..........................................................................................162 

public function commit ().................................................................................................162 

public function rollback ()................................................................................................163 


................................................................................................................................................163



Página 

16 / 236 

Data 

04/02/2012 

public function getResource ()........................................................................................163 

Persist........................................................................................................................................163 


NULL).....................................................................................................................................164 


................................................................................................................................................164 

public function find ($key)...............................................................................................164 

public function save (ValueObjectAbstract $valueObject).......................................164 

public function update (ValueObjectAbstract $valueObject)..................................164 

public function delete (ValueObjectAbstract $valueObject)....................................164 

ResultSet...................................................................................................................................164 

public function __construct (Connect $connect, $resultset)....................................165 

public function fetch ().....................................................................................................165 


br\gov\icmbio\sial\util................................................................................................................165 

Annotation................................................................................................................................165 

public function __construct(\br\gov\icmbio\sial\SIALAbstract $sial).....................166 

public function cache ()....................................................................................................166 

public function getClassName (self $sial = NULL).......................................................166 

public function getFileName ().......................................................................................166 

public function getClassDoc ()........................................................................................167 

public function getAttrsDoc ()........................................................................................167 

public function hasAttr ($attr, $persistType = NULL).................................................167 

public function getAttr ($attr, $persistType)...............................................................167 

public function getMethodsDoc ().................................................................................168 

AnnotationCache.....................................................................................................................168 

public function save (\br\gov\icmbio\sial\util\Annotation $annon)........................168 

public function load (\br\gov\icmbio\sial\util\Annotation $annon)........................168 

Config.........................................................................................................................................169 

public function __construct ($config, $section)...........................................................169 

public function hash ()......................................................................................................169 

public final function isSuported ($config)....................................................................169 

protected final function load ($config, $section)........................................................170 

ConfigAbstract.........................................................................................................................170 


public final function exists ($name)...............................................................................170 

public final function get ($name)...................................................................................171 

public function section ().................................................................................................171 

public abstract function isSuported ($config)..............................................................171 

public function toArray ().................................................................................................171 

public function toJSon()...................................................................................................172 

ConfigIni....................................................................................................................................172 


public final function load ($config, $section)...............................................................172 

public final function isSuported ($config)....................................................................173 

ConstantHandler.....................................................................................................................173 

public function __construct (BootstrapAbstract $bootstrap)..................................174



Página 

17 / 236 

Data 

04/02/2012 

public function get ($name, $shortname = TRUE)......................................................174 

public function getByName ($fullname).......................................................................175 

public function load ($fileContants)..............................................................................175 

public function loadIfExists ($fileContants).................................................................175 

public function loadModuleConstant ($namespace, $isModule = FALSE).............176 

public function requestConstantAutoload ()...............................................................176 

public static function factory (BootstrapAbstract $bootstrap)................................176 

ErrorHandler.............................................................................................................................176 

public function setError ()................................................................................................177 

public function errorHandlerSial ($errNo, $errStr, $errFile, $errLine)....................177 

public function getErroNumber ()..................................................................................177 

public function getErroStr ()...........................................................................................177 

Finder.........................................................................................................................................178 

public function name ($pattern).....................................................................................178 

public function notName ($pattern)..............................................................................178 

public function in ($path).................................................................................................179 

public function notIn ($path)...........................................................................................179 

Location.....................................................................................................................................179 

public static function hasNamespace ($namespace)..................................................179 

public static function hasClassInNamespace ($namespace).....................................180 

public static function realpathFromNamespace ($target)........................................180 

ProtectionAbstract..................................................................................................................180 

public abstract function encode ($content);................................................................181 

public abstract function decode ($content);................................................................181 

Registry.....................................................................................................................................181 

public static function get ($index)..................................................................................181 

public static function isRegistered ($index).................................................................182 

public static function set ($index, $value)....................................................................182 

Request.....................................................................................................................................182 

public function clearParams ($scope)............................................................................183 

public function isPost ()....................................................................................................183 

public function isFile ().....................................................................................................183 

public function isCookie ()...............................................................................................183 

public function isGet ().....................................................................................................184 

public function redirect ($url, $preservePostStantment = FALSE)..........................184 

public function getParam ($key, $scope = NULL)........................................................184 

public function getParams ($scope = NULL).................................................................185 

public function getModuleKey ()....................................................................................185 

public function getFuncionalityKey ()............................................................................185 

public function getActionKey ()......................................................................................186 

public function getModule ()...........................................................................................186 

public function getFuncionality ()..................................................................................186 

public function getAction ($wSuffix = FALSE)..............................................................186 

public function jQueryUnserialize ($scope = 'post')...................................................187 

public function jQueryUnserializeArray ($scope = 'post')..........................................187 

public function setParam ($key, $value, $scope = NULL)..........................................187 

public function setParams (array $params, $scope = 'GET')......................................187



Página 

18 / 236 

Data 

04/02/2012 

public function setModuleKey ($key)............................................................................188 

public function setFuncionalityKey ($key)....................................................................188 

public function setActionKey ($key)..............................................................................188 

public function setModule ($module)...........................................................................188 

public function setFuncionality ($funcionality)...........................................................189 

public function setAction ($action)................................................................................189 

public static function isValidMethod ($method).........................................................189 

public static function isValidKey ($key).........................................................................189 

public static function defaultStorageParam ($name = NULL)..................................190 


Session.......................................................................................................................................190 

private function __construct ($sessName, $namespace, $lifeTime = NULL, 

$security = FALSE, $httpOnly = TRUE)............................................................................190 

public function set($key, $value)....................................................................................191 

public function get ($key)................................................................................................191 

public function regenerationIdent ().............................................................................191 

public function destroy ().................................................................................................191 

public static function start ($namespace = NULL, $lifeTime = NULL, $security = 

FALSE, $httpOnly = TRUE).................................................................................................192 

br\gov\icmbio\sial\util\client.....................................................................................................192 

JQuery.......................................................................................................................................192 

public function serialize ($content)................................................................................192 

public function unserialize ($content)...........................................................................193 

public function unserializeArray ($content).................................................................193 


br\gov\icmbio\sial\util\file.........................................................................................................193 

Folder.........................................................................................................................................193 

public function createFolderStructure ($source)........................................................194 

public function permission ()...........................................................................................194 


James.........................................................................................................................................194 

public function __construct (ValueObjectAbstract $voFile).....................................195 

public function filePersist ()............................................................................................195 

public function fileDownloadRecover ().......................................................................195 

public function factory (ValueObjectAbstract $voFile)..............................................195 

Tamburete.................................................................................................................................196 

public function __construct (ValueObjectAbstract $valueObject, $pathLeaf = 

NULL, $upload = NULL)......................................................................................................196 

protected function createStruct ().................................................................................196 

protected function createContent ().............................................................................196 

protected function createLogAll ()................................................................................197 

protected function createLogByAttr ().........................................................................197 

protected function createLeaf ()....................................................................................197 

public function save ().......................................................................................................197 

public function update ($content).................................................................................198 

public function delete ($content)...................................................................................198 

public function find ().......................................................................................................198



Página 

19 / 236 

Data 

04/02/2012 

Bibliotecas externas ao SIAL......................................................................................................198 

FPDF...........................................................................................................................................198 

ClassLoader...............................................................................................................................199 

br\gov\icmbio\sial\util\mail.......................................................................................................199 

Mail.............................................................................................................................................199 

public function __construct (\br\gov\icmbio\sial\util\ConfigAbstract $config)...199 

public function addAttachment ($attachment, $name = NULL)..............................199 

public function addBCC ($email, $name = NULL)........................................................200 

public function addAddress ($email, $name = NULL).................................................200 

public function addCC ($email, $name = NULL)...........................................................200 

public function addReplyTo ($email, $name = NULL).................................................200 

public function alternativeBody ($alternativeBody)..................................................201 

public function body ($body, $altBody = NULL)..........................................................201 

public function charSet ($charSet).................................................................................201 

public function contentType ($contentType)...............................................................201 

public function encoding ($encoder).............................................................................202 

public function from ($email, $name= NULL)..............................................................202 

public function port ($port).............................................................................................202 

public function priority ($priority)..................................................................................202 

public function replyTo ($email, $name = NULL).........................................................203 

public function send ()......................................................................................................203 

public function sender (array $config = array())..........................................................203 

public function senderSmtp (array $config = array()).................................................203 

public function subject ($subject)..................................................................................204 

public function to ($email, $name = NULL)...................................................................204 

public function wordWrap ($maxLen)............................................................................204 

br\gov\icmbio\sial\util\mask.....................................................................................................205 

Cpf..............................................................................................................................................205 

public function __construct ($content = NULL)...........................................................205 

public static function remove ($content)......................................................................205 

Mask...........................................................................................................................................205 


public function apply ().....................................................................................................206 

public abstract static function remove ($content);.....................................................206 

public function registerRepo ($namespace)................................................................206 

br\gov\icmbio\sial\util\pdf........................................................................................................207 

Mask...........................................................................................................................................207 

public function __construct ($orientation = 'P', $unit = 'mm', $size = 'A4')............207 

public function addPage ($orientation = NULL, $size = NULL).................................207 

public function addFont ($family, $style = NULL, $file = NULL)...............................208 

public function header ()..................................................................................................208 

public function footer ()...................................................................................................209 

public function image ($filename, $posX = NULL, $posY = NULL, $width = 0, 

$height = 0, $type = NULL)................................................................................................209 

public function line ($posXOne, $posYOne, $postXTwo, $postYTwo)....................210 

public function outPut ($name = '', $destination = '').................................................211 

public function open ().....................................................................................................211



Página 

20 / 236 

Data 

04/02/2012 

public function close ().....................................................................................................211 

public function write ($text = '', $link = '').....................................................................211 

public function writeHTML ($html, $align = 'C')..........................................................212 

public function text ($posX, $posY, $text)...................................................................212 

public function cell ($width, $height = 0 , $text = NULL, $border = 0, $ln = 0, $align 

= 'L', $fill = FALSE, $link = NULL).......................................................................................212 

public function setFont ($family, $style = '', $size = 0)...............................................213 

public function setFontSize ($size).................................................................................213 

public function setMargins ($left, $top, $right = NULL)............................................213 

function Ln($h=null)..........................................................................................................214 

public function setTopMargin ($margin).......................................................................214 

public function setLeftMargin ($margin)......................................................................214 

public function getX ()......................................................................................................214 

public function getY ()......................................................................................................215 

public function setAuthor ($author)..............................................................................215 

public function setAutoPageBreak ($enableMode, $margin = 2.0).........................215 

public function setCreator ($creator)............................................................................215 

public function setY ($posY)............................................................................................216 

public function setX ($posX)...........................................................................................216 

public function setRightMargin ($margin)....................................................................216 

public function setTitle ($title).......................................................................................216 

public function rect ($posX, $posY, $width, $height, $style = NULL).....................217 

public function setDrawColor ($r, $g, $b).....................................................................217 

public function setFillColor ($r, $g, $b).........................................................................217 

public function setTextColor ($r, $g = 0, $b = 0)..........................................................217 

public function getStringWidth ($text).........................................................................218 

public function setLineWidth ($width)..........................................................................218 

public function multiCell ($width, $height, $text, $border = 0, $align = 'J', $fill = 

FALSE)...................................................................................................................................218 

public function pageNo ()................................................................................................219 

public function onError ($message)...............................................................................219 

br\gov\icmbio\sial\util\stack.....................................................................................................219 

FIFO............................................................................................................................................219 

public function peek ()......................................................................................................220 

public function pop ()........................................................................................................220 

public function push ($element).....................................................................................220 

public function flush().......................................................................................................220 

public function hasNext ()................................................................................................220 

public function isEmpty ()................................................................................................221 

public function init (array $elements = array())...........................................................221 


Stack...........................................................................................................................................221 

public abstract function peek ();.....................................................................................222 

public function pop ()........................................................................................................222 

public function push ($element).....................................................................................222 

public function flush().......................................................................................................223 

public function hasNext ()................................................................................................223



Página 

21 / 236 

Data 

04/02/2012 


public function init (array $elements = array())...........................................................223 

br\gov\icmbio\sial\valueObject................................................................................................224 

ValueObjectAbstract..............................................................................................................224 


public final function annotation ()..................................................................................224 

public final function loadData ($data = array())...........................................................224 

public final function hasMethod ($method, array $prefixes = array())...................225 

public function toArray ().................................................................................................225 


public function toJson ()..................................................................................................226 

public function toXml ()....................................................................................................226 

public static function factory ($namespace, $data = NULL)......................................226 

public function hash ()......................................................................................................226 

public function __toString().............................................................................................226 

br\gov\icmbio\sial\valueObject\exception.............................................................................227 

ValueObjectException............................................................................................................227 


NULL).....................................................................................................................................227 

public static function valueObjectNotImplemented ($valueObject)......................227 

br\gov\icmbio\sial........................................................................................................................228 

BootstrapAbstract...................................................................................................................228 

public function __construct (ConfigAbstract $config)................................................228 

public abstract function run ().........................................................................................228 

public abstract function persistLog (PersistLogAbstract $persistLog)...................228 

public function config ($key = NULL).............................................................................229 

public function request ().................................................................................................229 

public function getModule ()...........................................................................................229 

public function getFuncionality ()..................................................................................229 

public function getAction ().............................................................................................230 

public function getParam ($key, $scope = NULL)........................................................230 

public function getParams ($scope = NULL).................................................................230 

public function constant ($name, $shortname = TRUE).............................................231 

public function constantHandler ()................................................................................231 

public static function setupEnvironment (\br\gov\icmbio\sial\util\ConfigAbstract 

$config).................................................................................................................................231 

Factorable.................................................................................................................................231 

public static function factory()........................................................................................232 

Version.......................................................................................................................................232 

public static function get ()..............................................................................................232 

SialAbstract...............................................................................................................................232 

public final function __get ($name)...............................................................................233 

public final function __set ($name, $value)..................................................................233 

public function __call($name, $arguments).................................................................233 


public function getClassName (self $sial = NULL).......................................................234 

public function hasMethod ($method)..........................................................................234



Página 

22 / 236 

Data 

04/02/2012 

public static function realpathFromNamespace ($target)........................................234 

public final function toggle ($fParam, $sParam).........................................................234 

public function erReplace (array $patterns, $subject)...............................................235 

public static function getIfDefined($container, $el)..................................................235 

public static function has ($container, $el, $equalsTo = NULL)................................236

\gov\icmbio\sial\exception 

ClassNotFoundxception 

SIAL. 



Página 

23 / 236 

Data 

04/02/2012 

O componente ClassNotFoundxception trata as chamadas de classes dentro do 

Package: 

sial.exception 

Namespace: 

br\gov\icmbio\sial\valueObject\ClassNotFoundxception 

Camadas de utilização: 

Controller 

Business 

Model 

Persist 

Métodos: 

public function __construct ($message, $code = NULL, $previous = NULL) 

Método construtor. Prepara a mensagem de erro. 

IllegalArgumentException 

O componente IllegalArgumentException verifica argumentos que não podem 

ser nulos e valida argumentos inválidos. 

Package: 


Namespace: 

br\gov\icmbio\sial\valueObject\IllegalArgumentException 


Controller 

Business 

Model 

Persist 

Métodos:

IOException 



public function __construct ($message, $code = 0, $previous = NULL) 


public static function argumentCantBeNull ($argument) 

Método que valida se um argumento pode ser nulo. 

@param string $argument 

Retorno: 

\br\gov\icmbio\sial\exception\IllegalArgumentException 

Exceção: 

br\gov\icmbio\sial\exception\SIALException 

public static function invalidArgument ($argument) 

Método que verifica se o argumento informado é inválido. 

@param string $argument 

Retorno: 


Exceção: 


O componente IOException verifica se um arquivo é válido. 

Package: 


Namespace: 

br\gov\icmbio\sial\valueObject\IOException 


Controller 

Business 

Model 

Persist 


Página 

24 / 236 

Data 

04/02/2012





public static function notIsAValidFile ($file) 

SIALException 

Método que verifica se um arquivo é válido. 

@param string $file 

Retorno: 

\br\gov\icmbio\sial\exception\IOException 

Exceção: 


Página 

25 / 236 

Data 

04/02/2012 

O componente SIALException é uma superclasse para manipulação de exceções. 

Package: 


Namespace: 

br\gov\icmbio\sial\valueObject\ValueObjectAbstract 


Controller 

Business 

Model 

Persist 


NULL. 



public static function throwsExceptionIfParamIsNull ($avaliable, $message) 

Método que lança uma exceção quando um parâmetro informado for 

@param mixed $avaliable 

@param string $message 

Retorno: 

void


Exceção: 

\br\gov\icmbio\sial\persist\exception\PersistException 

br\gov\icmbio\sial\lang 

Date 


Página 

26 / 236 

Data 

04/02/2012 

O componente Date manipula um objeto com a data informada e valida pelo 

padrão europeu e americano. 

Package: 

br.gov.imcbio.sial.lang 

Namespace: 

br\gov\icmbio\sial\lang\Date 


Controller 

Business 

Model 

Persist 


public function addDay ($number) 

Método que adiciona um número em dias a uma data. 

@param integer 

Retorno: 

\br\gov\icmbio\sial\lang\Date 

Exceção: 


public function subDay ($number) 

Método que remove um número em dias de uma data. 


Retorno: 


Exceção: 

\br\gov\icmbio\sial\exception\SIALException

Enum 

public function output () 


Método que retorna uma data formatada. 

Retorno: 

string 

Exceção: 

\br\gov\icmbio\sial\exception\SIALException 


Página 

27 / 236 

Data 

04/02/2012 

public static function factory ($date = NULL, $formatIn = NULL, $formatOut = 

NULL) 

Fábrica de objeto date. 

@param string $date 

@param DATE_PARAM $formatIn 

@param DATE_PARAM $formatOut 

Retorno: 


Exceção: 


O componente Enum é uma superclasse para enumeração. 

Package: 


Namespace: 

br\gov\icmbio\sial\lang\Enum 


Controller 

Business 

Model 

Persist 


public static function factory ($class, array $elements = array ()) 

Fábrica de objetos enum. 

@param string $class

TFile 


@param string[] $elements 

Retorno: 

void 


Exceção: 


Componente ValueObject para manter arquivos 

Package: 


Namespace: 

br\gov\icmbio\sial\lang\TFile 


Controller 

Business 

Model 

Persist 


Página 

28 / 236 

Data 

04/02/2012 

public function __construct ($name = NULL, $type = NULL, $source = NULL, 

$error = NULL, $size = NULL) 

Método construtor. Cria o cache para o objeto TFile. 

@param string $name 

@param string $type 

@param string $source 

@param integer $error 

@param integer $size 

Exceção: 


public function getName () 

Método que retorna o nome do objeto TFile. 

Retorno: 

string 

Exceção:



public function getType () 

Método que retorna o tipo do objeto TFile. 

Retorno: 

string 

Exceção: 


public function getSource () 

Método que retorna a fonte – origem, do objeto TFile. 

Retorno: 

string 

Exceção: 


public function getError () 

Método que retorna o código do erro do objeto TFile. 

Retorno: 

integer 

Exceção: 


public function getSize () 


Método que retorna o tamanho, em bytes, do objeto TFile. 

Retorno: 

integer 

Exceção: 


public function setName ($name = NULL) 

Método que atribui um valor para o Tfile->name. 


Retorno: 

\br\gov\icmbio\sial\lang\FileValueObject 

Página 

29 / 236 

Data 

04/02/2012


Exceção: 


public function setType ($type = NULL) 

Método que atribui um valor para o Tfile->type. 


Retorno: 


Exceção: 


public function setSource ($source = NULL) 

Método que atribui um valor para Tfile->source. 


Retorno: 


Exceção: 


public function setError ($error = NULL) 

Método que atribui um valor para TFile->error. 

@param integer $error 

Retorno: 


Exceção: 


public function setSize ($size = NULL) 

Método que atribui um valor para Tfile->size. 

@param integer $size 

Retorno: 


Exceção: 


Página 

30 / 236 

Data 

04/02/2012

TFileContent 




Componente ValueObject para manter arquivos com conteúdo 

Package: 


Namespace: 

br\gov\icmbio\sial\lang\TFileContent 


Controller 

Business 

Model 

Persist 


public function __construct ($content = NULL) 

Método construtor. Cria o cache para o objeto TfileContent. 

@param string $ content 

Exceção: 


public function getContent () 

Página 

31 / 236 

Data 

04/02/2012 

Método que recupera o conteúdo armazenado no objeto TfileContent. 

Retorno: 

string 

Exceção: 


public function setContent ($content = NULL) 

Método que atribui um valor a TfileContent->content. 


Retorno: 

\br\gov\icmbio\sial\lang\TFileContent 

Exceção:



br\gov\icmbio\sial\mvcb\business 

BusinessAbstract 


O componente BusinessAbstract é a superclasse da camada de negócio 

Package: 

br.gov.imcbio.sial.mvcb.business 

Namespace: 

br\gov\icmbio\sial\mvcb\business\BusinessAbstract 


Business 


public function __construct () 

@deprecated será removido na versao 2.0 

public function commit () 

Método que envia uma transação. 

Retorno: 


Exceção: 

br\gov\icmbio\sial\persist\exception\PersistException 

public function transaction () 

Método que inicializa uma transação. 

Retorno: 


Exceção: 


public function rollback () 

Método que desfaz todas as transações pendentes. 

Retorno: 

Página 

32 / 236 

Data 

04/02/2012



Exceção: 


public function find ($key) 

Método que recupera por chave identificadora. 

@param integer $idx 

Retorno: 


Exceção: 


public function findAll () 


Página 

33 / 236 

Data 

04/02/2012 

Método que recupera por um array de ValueObject correspondente. 

Retorno: 

br\gov\icmbio\sial\valueObject\ValueObjectAbstract[] 

Exceção: 

br\gov\icmbio\sial\exception\IllegalArgumentException 


$offSet = 0) 

Método que recupera por parametrização um ValueObject 

correspondente. 

@param \br\gov\icmbio\sial\valueObject\ValueObjectAbstract $filter 

Retorno: 

br\gov\icmbio\sial\valueObject\ValueObjectAbstract[] 

Exceção: 


public function getModel () 

Fábrica de model. 

Retorno: 

br\gov\icmbio\sial\mvcb\model\ModelAbstract 

Exceção: 

br\gov\icmbio\sial\mvcb\business\exception\BusinessException


public static function factory ($namespace) 

Fábrica de objeto BusinessAbstract. 

@param string | ControllerAbstract $namespace 

Retorno: 



Exceção: 

br\gov\icmbio\sial\mvcb\business\exception\BusinessException 

public function getModelPersist ($persist) 

Fábrica de model por persistência. 

@param string $persist 

Retorno: 


Exceção: 


public function registerAnnotation ($namespace) 

BusinessCrudAbstract 

Método que registra o annotation para o ValueObject. 

@param string $namespace 

Retorno: 


Exceção: 

br\gov\icmbio\sial\exception\IOException 


Página 

34 / 236 

Data 

04/02/2012 

O componente BusinessCrudAbstract fornece um crud para a camada de negócio. 

Package: 

br.gov.imcbio.sial.mvcb.business 

Namespace: 

br\gov\icmbio\sial\mvcb\business\BusinessCrudAbstract 

Camadas de utilização:


Business 


public function save (ValueObjectAbstract $valueObject) 

Método que persiste um ValueObject. 


@param br\gov\icmbio\sial\valueObject\ValueObjectAbstract 

Retorno: 

\br\gov\icmbio\sial\mvcb\model\ModelAbstract 

Exceção: 


\br\gov\icmbio\sial\mvcb\model\exception\ModelException 

public function delete (ValueObjectAbstract $valueObject) 


Método que exclui da persistência um ValueObject. 

Retorno: 

void 

Exceção: 



public function findByParam (ValueObjectAbstract $valueObject) 

Método que recupera um ValueObject por parametrização. 


Página 

35 / 236 

Data 

04/02/2012 

Retorno: 

ArrayObject 

Exceção: 


public function update (ValueObjectAbstract $valueObject) 

Método que atualiza na persistência um ValueObject. 


Retorno: 

\br\gov\icmbio\sial\mvcb\model\ModelAbstract



Exceção: 



br\gov\icmbio\sial\mvcb\business\exception 

BusinessException 

Página 

36 / 236 

Data 

04/02/2012 

O componente BusinessException trata das exceções específicas da camada de 

negócio 

Package: 

br.gov.imcbio.sial.mvcb.business.exception 

Namespace: 



Business 

Método: 

public static function businessNotImplemented ($businessName) 

Método que verifica se uma business não foi implementada. 

@param string $businessName 

Retorno: 


Exceção: 


br\gov\icmbio\sial\mvcb\controller 

ControllerAbstract 

O componente ControllerAbstract é a superclasse da camada de controle. 

Package: 

br.gov.imcbio.sial.mvcb.controller 

Namespace:


br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 


Controller 




Página 

37 / 236 

Data 

04/02/2012 

Método construtor. Carrega as configurações a partir do bootstrap e 

registra o repositório de scripts. 

Exceção: 

br\gov\icmbio\sial\mvcb\controller\exception\ControllerException 

public function setViewType ($type) 

Define o tipo da view 


Retorno: 

br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 

Exceção: 


public function bootstrap () 

Retorna a referência do Bootstrap 


Retorno: 

br\gov\icmbio\sial\Bootstrap 

Exceção: 


public function constant ($name, $shortname = TRUE) 

Retorna o conteúdo da constant do SIAL (ConstantHandler) informada. 

Se o segundo @param for informado, será assumido que a chamada do 

método foi realizada informando apenas o nome da consntant deixando a cargo da 

classe montar o nome completo. 


@param boolean $shortname 

Retorno:

método. 


br\gov\icmbio\sial\Bootstrap 


Página 

38 / 236 

Data 

04/02/2012 

Exceção: 


public function getBusiness ($target = NULL) 

Fábrica de Business 

@param Controller 

Retorno: 


Exceção: 


public function getNamespaceFuncionality (self $ctrl = NULL) 

Retorna o namespace da funcionalidade da controller informada. 

Caso o controller seja omitido será usado o controller que invocar esse 

@param \br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 

Retorno: 

String 

Exceção: 


public function getView () 

Certifica que o bootstrap foi inicializado para instanciar a view 

correspondente a controller . 

Retorno: 

br\gov\icmbio\sial\mvcb\view\View 

Exceção: 


public function getValueObject ($target = NULL, $data = NULL) 

Cria um ValueObject com base no Controller informado. 

Obs.: Caso deseje definir os valores na criação do ValueObject informe um 

array com chave correspondente attr=value - vide ValueObject::load. 

@param Controller

@param string[] 


Retorno: 



Página 

39 / 236 

Data 

04/02/2012 

Exceção: 


public function hasAction ($actionName) 

Verifica se uma action existe em um controller. 

@param string 

Retorno: 

• TRUE – Caso a action exista; 

• FALSE – Caso a action não exista. 

Exceção: 


public function isCookie () 

Verifica se o tipo de requisição é através de cookie. 

Retorno: 

• TRUE – Caso a requisição seja através de cookie; 

• FALSE – Caso contrário. 

Exceção: 


public function isGet () 

Verifica se o tipo de requisição é através de método GET. 

Retorno: 

• TRUE – Caso a requisição seja através de GET; 


Exceção: 


public function isPost () 

Verifica se o tipo de requisição é através de método POST. 

Retorno: 

• TRUE – Caso a requisição seja através de POST;




Exceção: 


public function request () 

Página 

40 / 236 

Data 

04/02/2012 

Verifica se uma requisição foi feita, caso contrário retorna a requisição 

default do Bootstrap 

Retorno: 

br\gov\icmbio\sial\util\Request 

Exceção: 


final protected function _forward ($action, $controller = NULL, array $params = 

NULL) 

Método que redireciona o fluxo de uma requisição entre actions de uma 

controller ou controllers diferentes. 

Controller 

Obs.: Após executar o método designado o processamento é interrompido. 

Retorno: 

void 

Exceção: 

\br\gov\icmbio\sial\exception\ControllerException 

Exemplos 



public function registryViewScriptPath (ControllerAbstract $ctrl) 

ErrorController 

Registra o repositório de scripts para a Controller 

@param \br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 

Retorno: 

\br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 

Página 

41 / 236 

Data 

04/02/2012 

Exceção: 


O componente ErrorController trata de todos os erros de configuração na 

Controller 

Package: 

br.gov.imcbio.sial.mvcb.controller 

Namespace: 

br\gov\icmbio\sial\mvcb\controller\ErrorController 


Controller 


public function __construct (\br\gov\icmbio\sial\exception\SIALException $siale) 

Método construtor. 

@param \br\gov\icmbio\sial\exception\SIALException 

Exceção: 


public function errorAction () 

Método executado automaticamente quando ocorre um comportamento 

não previstro na camada controller. 

Retorno: 

string (Html) 

Exceção: 

br\gov\icmbio\sial\exception\SIALException



br\gov\icmbio\sial\mvcb\controller\exception 

ControllerException 

O componente ControllerException trata de todos os erros de Controller. 

Package: 

br.gov.imcbio.sial.mvcb.exception 

Namespace: 



Controller 


Página 

42 / 236 

Data 

04/02/2012 

public function __construct ($message = '', $code = 0, \Exception $previous = 

NULL) 


@param string 


@param \Exception 

Exceção: 


br\gov\icmbio\sial\mvcb\model 

ModelAbstract 

O componente ModelAbstract é a superclasse da camada Model. 

Package: 

br.gov.imcbio.sial.mvcb.model 

Namespace: 



Controller


public function __construct ($dsName) 


@param string 



Exceção: 


public function __call($name, array $arguments = array()) 

Página 

43 / 236 

Data 

04/02/2012 

Método que intercepta uma chamada a outro método. Caso o método seja 

inexistente o fluxo é redirecionado para funcionalidade predefinida em parent. 

@param string 


Retorno: 


Exceção: 


public static function exists ($namespace) 

Método que verifica a existência de uma Model. 

@param string 

Retorno: 

• TRUE – Caso a model exista; 

• FALSE – Caso a model não exista. 

Exceção: 


public function getPersist () 

Método que retorna a referência da persistência. 

Retorno: 

br\gov\icmbio\sial\persist\Persist 

Exceção: 

br\gov\icmbio\sial\mvcb\model\exception\ModelException

entidade. 



Método que realiza exclui um ValueObject. 

@param br\gov\icmbio\sial\valueObject\ValueObject 

Retorno: 



Exceção: 

br\gov\icmbio\sial\mvcb\model\exception\ModelException 


Método que realiza a persistência dos dados em um ValueObject. 


Retorno: 


Exceção: 



Método que atualiza os dados de persistência em um ValueObject. 


Retorno: 


Exceção: 


public function find ($idx) 

Página 

44 / 236 

Data 

04/02/2012 

Método que realiza busca pelo tipo assumido como chave primária na 

@param mixed $key 

Retorno: 

br\gov\icmbio\sial\persist\ResultSet 

Exceção: 

br\gov\icmbio\sial\persist\exception\PersistException



Método que recupera todos os dados de uma entidade. 

Retorno: 


Exceção: 



Página 

45 / 236 

Data 

04/02/2012 


$offSet = 0) 

Método que realiza pesquisa com base nos parâmetros preenchidos no 

ValueObject informado. 


Retorno: 

ArrayObject 

Exceção: 


public function getAllValueObject () 

Método que retorna um array de ValueObject. 

Retorno: 

ArrayObject 

Exceção: 


public function getValueObject () 

Método que retorna um ValueObject para cada linha recuperada do 

repositório e NULL quando não houver mais registros para retornar. 

Retorno: 


Exceção: 


public function getDataViewObject () 

Método que retorna os registros armazenados em um DataViewObject. 

Retorno:


br\gov\icmbio\sial\valueObject\DataViewObject 

Exceção: 


public function getAllDataViewObject () 

Método que retorna um array de DataViewObject. 


Retorno: 

ArrayObject \br\gov\icmbio\sial\valueObject\DataViewObject 

Exceção: 


public function registerAnnotation ($namespace) 

Método que registra o Annotation para o ValueObject. 

@param string 

Retorno: 


Exceção: 



public static function factory ($namespace, $dsName = NULL) 

Fábrica de model. 


@param string $dsName 

Retorno: 


Exceção: 


br\gov\icmbio\sial\mvcb\model\exception 

ModelException 

Página 

46 / 236 

Data 

04/02/2012 

O componente ModelException trata de todas os erros de configuração na Model

Package: 

br.gov.imcbio.sial.exception 


Namespace: 



Model 


public static function modelNotImplemented ($modelName) 

Método que verifica a existência de uma model. 

@param string 


Retorno: 


Exceção: 


br\gov\icmbio\sial\mvcb\view 

ViewAbstract 

O componente ViewAbstract é a superclasse da camada de view. 

Package: 

br.gov.imcbio.sial.mvcb.view 

Namespace: 

br\gov\icmbio\sial\mvcb\view\ViewAbstract 


View 


public function __construct ($engine) 

Página 

47 / 236 

Data 

04/02/2012 

Método construtor que registra os scripts básicos do SIAL para a view 

selecionada e registra o repositório principal de helpers. 

@param string[]



Exceção: 

br\gov\icmbio\sial\mvcb\view\exception\HelperException 

public static function factory ($type, $namespace) 

Fábrica de views. 

@param string 

Retorno: 

br\gov\icmbio\sial\mvcb\view\ViewAbstract 

Exceção: 


public abstract function addScriptPath ($scriptPath) 

Método que adiciona um diretório de scripts. 

@param string 

Retorno: 


Exceção: 


public abstract function clean () 

Método que destrói todas as variáveis. 

Retorno: 


Exceção: 


public abstract function get ($key) 

Método que recupera um valor armazenado em uma view. 

@param string 

Retorno: 

Mixed 

Exceção: 


Página 

48 / 236 

Data 

04/02/2012

public abstract function getAll () 



Página 

49 / 236 

Data 

04/02/2012 

Método que recupera a relação de todas as variáveis registradas na view. 

Retorno: 

Mixed[] 

Exceção: 


public abstract function isAssign ($key) 

Método que verifica se uma variável está registrada. 

@param string 

Retorno: 

• TRUE – Caso a variável esteja registrada. 

• FALSE – Caso a variável não esteja registrada. 

Exceção: 


public abstract function remove ($key) 

Método que remove uma variável registrada na view 

@param string 

Retorno: 


Exceção: 


public abstract function render ($script) 

Método que renderiza um template. 

@param string 

Retorno: 

string 

Exceção: 


public abstract function set ($key, $value) 

Método que registra uma variável na view.

informado. 

@param string 

Retorno: 

mixed 


Exceção: 


public abstract function setEncoding ($encode) 


Método que define o tipo de codificação a ser utilizado na view. 

@param string 

Retorno: 


Exceção: 


public abstract function setScriptPath ($scriptPath) 

Método que define o caminho dos scripts utilizados na view. 

@param string 

Retorno: 


Exceção: 


public abstract function getScriptPaths () 

Método que retorna os caminhos dos scripts utilizados pela view. 

Retorno: 

string[] 

Exceção: 



(ControllerAbstract $ctrl) 

Página 

50 / 236 

Data 

04/02/2012 

Método que registra o caminho dos scripts da view baseado no controller 

@param br\gov\icmbio\sial\mvcb\controller\ControllerAbstract

Json 


Retorno: 


Exceção: 


Componente para manipulação de dados no formato JSON. 

Package: 


Namespace: 

br\gov\icmbio\sial\mvcb\view\Json 


View 



Html 

public function __construct (array $config = array()) 




Exceção: 

br\gov\icmbio\sial\mvcb\view\exception\ViewException 

Página 

51 / 236 

Data 

04/02/2012 

public function registerViewScriptBasedFromController (ControllerAbstract $ctrl) 

Método que registra o caminhos dos scripts de view baseado no controller 

@param br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 

Retorno: 


Exceção: 


Componente para manipulação de dados em HTML.

Package: 


Namespace: 

br\gov\icmbio\sial\mvcb\view\Html 


View 





Página 

52 / 236 

Data 

04/02/2012 

Método construtor que define o diretório base para scripts do tipo HTML. 

Obs.: Utiliza Zend/View. 

Exceção: 


public function addScriptPath ($scriptPath) 

Método que adiciona um diretório de scripts. 

@param string 

Retorno: 

br\gov\icmbio\sisicmbio\library\mvcb\view\View 

Exceção: 


public function clean () 

Método que destrói todas as variáveis. 

Retorno: 

br\gov\icmbio\sisicmbio\library\mvcb\view\View 

Exceção: 


public function get ($key) 

Método que recupera um valor armazenado em view. 

@param string 

Retorno: 

mixed



Exceção: 


public function getAll () 

Página 

53 / 236 

Data 

04/02/2012 

Método que recupera a relação de todas as variáveis registradas na view. 

Retorno: 

mixed[] 

Exceção: 


public abstract function isAssign ($key) 

Método que verifica se uma variável está registrada. 

@param string 

Retorno: 

• TRUE – Caso a variável esteja registrada. 

• FALSE – Caso a variável não esteja registrada. 

Exceção: 

br\gov\icmbio\sial\mvcb\view\exception\ViewExceptio 

public abstract function remove ($key) 

Método que remove uma variável registrada na view. 

@param string 

Retorno: 


Exceção: 


public abstract function render ($script) 

Método que renderiza um template. 

@param string 

Retorno: 

string 

Exceção: 

br\gov\icmbio\sial\mvcb\view\exception\ViewException


public abstract function set ($key, $value) 

Método que registra uma variável na view. 

@param string 

Retorno: 

mixed 


Exceção: 


public abstract function setEncoding ($encode) 

Método que define o tipo de codificação a ser utilizado na view. 

@param string 

Retorno: 


Exceção: 


public abstract function setScriptPath ($scriptPath) 

Método que define o caminho dos scripts utilizados na view. 

@param string 

Retorno: 


Exceção: 


public abstract function getScriptPaths () 

Método que retorna os caminhos dos scripts utilizados pela view. 

Retorno: 

string[] 

Exceção: 



(ControllerAbstract $ctrl) 

Página 

54 / 236 

Data 

04/02/2012 

Método que registra o caminho dos scripts da view baseado no controller


Helper 



@param br\gov\icmbio\sial\mvcb\controller\ControllerAbstract 

Retorno: 


Exceção: 


Componente para manipulação de helpers no SIAL. 

Package: 


Namespace: 

br\gov\icmbio\sial\mvcb\view\Helper 


View 


public function __call ($helper, $args) 

Método que intercepta a chamada e executa o helper solicitado. 

@param string 

@param string 

Retorno: 

• Mixed function result 

• FALSE – Quando ocorrer um erro 

Exceção: 


public static function registerNamespace ($namespace) 

Método que registra o local de armazenamento do Helper. 

@param string 

Retorno: 

br\gov\icmbio\sial\mvcb\view\Helper 

Página 

55 / 236 

Data 

04/02/2012



Exceção: 



br\gov\icmbio\sial\mvcb\view\exception 

HelperException 

Componente para manipulação de erros nas helpers. 

Package: 

br.gov.imcbio.sial.mvcb.view.exception 

Namespace: 

br\gov\icmbio\sial\mvcb\view\exception\HelperException 

ViewException 

Package: 

br.gov.imcbio.sial.mvcb.view.exception 

Namespace: 



View 

br\gov\icmbio\sial\mvcb\view\helper 

BuildUrl 

Package: 

br.gov.imcbio.sial.mvcb.view.helper 

Namespace: 

br\gov\icmbio\sial\mvcb\view\helper\BuildUrl 


View 


Página 

56 / 236 

Data 

04/02/2012



Página 

57 / 236 

Data 

04/02/2012 

public function buildUrl (array $urlParam, $appendParam = TRUE, $url = NULL, 

$friendlyMode = TRUE) 

Método que gera uma url. 

@param string[] $urlParam 

@param boolean $appendParam 

@param string $url 

@param boolean $friendlyMode 

Retorno: 

String 

Exceção: 



public static function getDomain ($port) 

Método que retorna o domínio url. 


Retorno: 

String 

Exceção: 



public static function makeQuery (array $urlParams, $appendParam, 

$friendlyMode, $externalLink) 

Downloader 

Método que monta a query de parâmetros. 

@param string[] $urlParams 

@param boolean $appendParam 

@param boolean $friendlyMode 

Retorno: 

String 

Exceção: 


br\gov\icmbio\sial\exception\IllegalArgumentException

Package: 

br.gov.imcbio.sial.mvcb.view.helper 


Namespace: 

br\gov\icmbio\sial\mvcb\view\helper\Downloader 


View 


public function downloader (ValueObjectAbstract $voFile) 

Helper que realiza o download. 

@param br\gov\icmbio\sial\lang\TFile 

Retorno: 

String 

Exceção: 


br\gov\icmbio\sial\persist 

Connect 

Classe que estabelece a conexão com a persistência. 

Package: 

br.gov.imcbio.sial.persist 

Namespace: 

br\gov\icmbio\sial\persist\Connect 


Persist 



Página 

58 / 236 

Data 

04/02/2012 

public function __construct (\br\gov\icmbio\sial\persist\PersistConfig $config) 

Método construtor que define o resource, o adapter, o driver e o source da 

persistência. 

@param \br\gov\icmbio\sial\persist\PersistConfig $config


Exceção: 



Página 

59 / 236 

Data 

04/02/2012 


$config) 

Método que efetua a conexão com o respositório. 

@param \br\gov\icmbio\sial\persist\PersistConfig 

Retorno: 


Exceção: 


public abstract function commit () 

Método que grava os dados pendentes e encerra a transação. 

Retorno: 


Exceção: 


public function getAdapter () 

Método que retorna o adaptador em uso. 

Retorno: 

string 

Exceção: 


public function getDriver () 

Método que retorna o driver em uso. 

Retorno: 

string 

Exceção: 


public function getSource () 

Método que retorna a source de trabalho.

Retorno: 

string 


Exceção: 


public abstract function hasTransactionRunning () 


Método que verifica transações pendentes em execução. 

Retorno: 

• TRUE – Caso haja alguma transação pendente. 

• FALSE – Caso não haja transações pendentes. 

Exceção: 


public abstract function retrieve () 

Método que executa comandos de consulta no repositório. 

Retorno: 


Exceção: 


public abstract function rollback () 

Método que desfaz a transação. 

Retorno: 


Exceção: 


public abstract function transaction () 


Retorno: 


Exceção: 


public abstract function update () 

Método que executa comando de atualização no repositório. 

Página 

60 / 236 

Data 

04/02/2012

Persist 


Retorno: 


Exceção: 



Página 

61 / 236 

Data 

04/02/2012 

public static function factory (\br\gov\icmbio\sial\persist\PersistConfig $config) 

Fábrica de conexões. 

@param \br\gov\icmbio\sial\persist\persistConfig $config 

Retorno: 


Exceção: 


Classe de persistência. 

Package: 


Namespace: 



Persist 


public function __construct (PersistConfig $config) 

Método construtor que define o objeto de configuração de persistência. 

Exceção: 


public static function exists ($namespace, $throws = FALSE) 

Método que verifica a existência de uma persistência. 


@param boolean $throws 

Retorno:


• TRUE – Caso a persistência exista. 

• FALSE – Caso a persistência não exista. 


Exceção: 


Página 

62 / 236 

Data 

04/02/2012 


$config) 

Método que realiza a conexão de persistência. 

@param \br\gov\icmbio\sial\persist\PersistConfig 

Retorno: 


Exceção: 


public function annotation () 

Método que retorna a referência de anotação para a persistência. 

Retorno: 

\stdClass 

Exceção: 


public function getConnect () 

Recupera o objeto de conexão de persistência. 

Retorno: 


Exceção: 


public function orderBy ($field, $order = 'ASC') 

Método que registra a ordenação de uma pesquisa 

@param string $field 

@param string $order 

Exceção: 

br\gov\icmbio\sial\exception\IllegalArgumentException

public function sorter ($query) 


Método que aplica a ordenação em uma consulta. 

@param string $query 

Retorno: 

string 

Exceção: 


public function isAttrPersistable (\stdClass $attr, $adapter) 

Verifica se um atributo pode ser persistido. 

@param stdClass $attrAnnon 

@param string $adapter 


Retorno: 

• TRUE – Caso o atributo possa ser persistido. 

• FALSE – Caso o atributo não possa ser persistido. 

Exceção: 


public static function factory ($namespace, PersistConfig $config) 

Fábrica de persistência. 

@param [string | Model] $namespace 

@param \br\gov\icmbio\sial\persist\PersistConfig $config 

Retorno: 


Exceção: 


public function registerAnnotation ($annotation) 

Registra a anotação do ValueObject de três maneiras: 

• String: namespace do valueObject 

• ValueObject: instância do ValueObject 

• Annotation: Instância da anotação do ValueObject 

@param [string | ValueObjectAbstract | Annotation] $param 

Retorno: 

Página 

63 / 236 

Data 

04/02/2012

Persistable 




Exceção: 



public function getConfig () 

Método que recupera a configuração de persistência. 

Retorno: 

br\gov\icmbio\sial\persist\persistConfig 

Exceção: 


Interface da camada de persistência. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\Persistable 


Persist 



Método que persiste dados no repositório. 

@param ValueObjectAbstract $valueObject 

Retorno: 


Exceção: 



Método que altera dados no repositório. 


Página 

64 / 236 

Data 

04/02/2012


Retorno: 


Exceção: 



Método que deleta dados no repositório. 


Retorno: 


Exceção: 



PersistConfig 


Método que recupera um registro através de um atributo chave. 

@param integer $key 

Retorno: 


Exceção: 


Classe que configura a camada de persistência. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\PersistConfig 


Persist 




Página 

65 / 236 

Data 

04/02/2012

epositório. 

de dados. 

@param string[] $config 



Exceção: 


protected abstract function _valid (array $config) 

Página 

66 / 236 

Data 

04/02/2012 

Método que valida se os dados informados são válidos para a persistência. 


Exceção: 


public final static function adapaterAccepet ($adapter) 

Método que verifica se o adaptador é suportado pela persistência. 

@param string $adpater 

Retorno: 

bool 

• TRUE – Caso o adaptador seja suportado pela persistência. 

• FALSE – Caso o adaptador não seja suportado pela persistência. 

Exceção: 


public abstract function getDSN () 

Método que retorna o data source name – DSN, de conexão com o 

Retorno: 

string 

Exceção: 


public static function registerConfigs ($data) 

Método que registra as configurações de conexão com o(s) repositório(s) 

Obs.: 

1. string: Para indicar o arquivo de configuração (.ini) 

2. string[]: Para indicar um array de configurações 

@param [string | string[]] $data

Retorna: 

string[] 



Exceção: 


public static function factory ($dsName = NULL) 

PersistLogAbstract 

Fábrica de PersistConfig 


Retorna: 

br\gov\icmbio\sial\persist\PersistConfig 

Exceção: 


Classe para persistência de dados de Log de auditoria. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\PersistLogAbstract 


Persist 


public static function bootstrap (BootstrapAbstract $bootstrap) 

Método que registra o bootstrap. 

@param br\gov\icmbio\sial\BootstrapAbstract 

Retorno: 

br\gov\icmbio\sial\BootstrapAbstract 

Exceção: 


public function registerUser ($userid) 

Método que registra o usuário responsável pela execução de uma 

Página 

67 / 236 

Data 

04/02/2012

operação na camada de persistência. 

@param integer $userid 


Retorna: 


Exception: 



Página 

68 / 236 

Data 

04/02/2012 

public abstract function save (ValueObjectAbstract $valueObject, $operation) 

Método que efetua o registro do Log. 


@param string $operation 

Retorno: 


Exceção: 


public abstract function isKeepHistory (ValueObjectAbstract $valueObject) 

Método que verifica se um ValueObject representa uma entidade que 

precise manter seu histórico de seus atributos. 


Retorno: 

boolean 

• TRUE – Caso atenda a condição do método. 

• FALSE – Caso não atenda a condição do método. 

Exceção: 


public static function getValueRecursively (ValueObjectAbstract $valueObject, 

$get) 

Método que recupera recursivamente um valor de ValueObject. 

@param string $get 

@param ValueObjectAbstract $value 

Retorno: 

string


Exceção: 



public abstract function makeQuery (ValueObjectAbstract $valueObject, 

$operation) 

Método que monta a instrução SQL para registro do Log. 


$valueObject 

@param char $operation 

Retorno: 

string 

Exceção: 


public function fetch (ValueObjectAbstract $valueObject) 

Método que recupera os campos que compõem a entidade. 

@param \br\gov\icmbio\sial\persist\database\Persist $persist 

Retorno: 

string[] 

Exceção: 


public abstract function fields (\br\gov\icmbio\sial\util\Annotation $annon) 

Página 

69 / 236 

Método que recupera toda a relação de campos que serão logados. 

@param \br\gov\icmbio\sial\util\Annotation 

Retorno: 

string[] 

Exceção: 


Data 

04/02/2012 

public abstract function translante (\br\gov\icmbio\sial\util\Annotation $annon, 

array $list = NULL) 

Método que converte a relação dos atributos que serão logados com os 

atributos do repositório. 


@param string[] $list

ResultSet 

Retorno: 

string[] 


Exceção: 


public abstract static function factory (Persist $persist) 

Fábrica de persistência. 

@param \br\gov\icmbio\sial\persist\Persist $persist 

Retorno: 

br\gov\icmbio\sial\persist\database\PersistLog 

Exceção: 


Classe para manipulação de dados da camada de persistência. 

Package: 


Namespace: 



Persist 


public function __construct ($resultSet) 


@param resource $resultSet 

Exceção: 


public function query () 

Método que retorna a query a ser executada. 

Retorno: 

string 


Página 

70 / 236 

Data 

04/02/2012


Exceção: 


public abstract function fetch () 

Método que recupera um objeto stdClass. 

Retorno: 

\stdClass 

Exceção: 


public abstract function count () 

Método que retorna a quantidade de linhas. 

Retorno: 

integer 

Exceção: 


br\gov\icmbio\sial\persist\database 

Config 

Classe de configuração persistência do tipo database. 

Package: 

br.gov.imcbio.sial.persist.database 

Namespace: 

br\gov\icmbio\sial\persist\database\Config 


Persist 



Fábrica de configuração. 



Página 

71 / 236 

Data 

04/02/2012

Connect 


Retorno: 



Exceção: 


Classe de conexão de persistência do tipo database. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\Connect 


Persist 


Página 

72 / 236 

Data 

04/02/2012 




Exceção: 


public function update () 

Método que altera os dados na persistência. 

Retorno: 


Exceção: 


public function retrieve () 

Método que recupera os dados na persistência. 

Retorno: 


Exceção: 



public function prepare ($query, $params = NULL) 


Página 

73 / 236 

Data 

04/02/2012 

Método que prepara o comando SQL a ser executado no repositório. 


@param stdClass[] $params 

Retorno: 


Exceção: 


public function hasTransactionRunning () 


Retorno: 



Exceção: 


public abstract function transaction () 


Retorno: 


Exceção: 


public abstract function retrieve () 


Retorno: 


Exceção: 




Retorno:

Persist 



Exceção: 


public abstract function rollback () 


Retorno: 


Exceção: 


public abstract function update () 


Método que executa comando de atualização no repositório. 

Retorno: 


Exceção: 


public function closeCursor () 

Método que fecha o cursor statement. 

Retorno: 


Exceção: 


Página 

74 / 236 

Data 

04/02/2012 

public static function factory (\br\gov\icmbio\sial\persist\PersistConfig $config) 

Fábrica de conexões. 


Retorno: 


Exceção: 


Classe de persistência para database. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\Persist 


Persist 




Página 

75 / 236 

Data 

04/02/2012 

public function __construct (\br\gov\icmbio\sial\persist\PersistConfig $config = 

NULL) 



Exceção: 


public function execute ($query, $params = NULL) 

Método que executa uma consulta de forma direta. 

Obs.: Esse método deve ser evitado pois em versão futura estará em 

desuso - depecrated. 

entidade. 


@param \stdClass $params 

Retorno: 


Exceção: 



Método que realiza busca pelo tipo assumido como chave primária na 

Obs.: Esse método suporta pesquisa com apenas uma chave simples. Caso a 

consulta necessite de chave composta, o método deverá ser especializado. 

@param mixed $key 

Retorno:



Exceção: 




Método que recupera todos os registros de uma entidade. 

Retorno: 


Exceção: 


Página 

76 / 236 

Data 

04/02/2012 

public function findByParam (ValueObjectAbstract $valueObject, $limit = 'ALL', 

$offSet = 0) 

Método que efetua uma pesquisa parametrizada. 


@param integer $limit 

@param integer $offSet 

Retorno: 


Exceção: 



Método que persiste os dados no repositório. 


Retorno: 


Exceção: 



Método que altera dados no repositório. 


Retorno: 

br\gov\icmbio\sial\persist\ResultSet


Exceção: 



Método que exclui dados no repositório. 


Retorno: 


Exceção: 



Página 

77 / 236 

Data 

04/02/2012 

protected function _connect (\br\gov\icmbio\sial\persist\PersistConfig $config) 



Exceção: 


protected static function _injectResultOnValueObject (ValueObjectAbstract 

$valueObject, ResultSet $resultSet) 

Método que injeta valores recuperados do banco de dados em um 

ValueObject. 


@param \StdClass $value 

Exceção: 


public static function getValue (ValueObjectAbstract $valueObject, 

$accessorMethod, $dataType) 

Método que recupera o valor do ValueObject através de annotation para 

montar o comando SQL. 


@param string $accessorMethod 

@param string $dataType 

Retorno: 

\stdClass


Exceção: 


public function sorter ($query) 

Método que define a ordenação dos registros. 


Retorno: 

string 

Exceção: 



public function log (ValueObjectAbstract $valueObject, $operation) 

Método que efetua o log de operação. 



Exceção: 


public function getEntityName (\stdClass $annon) 

Método que recupera o nome da entidade que será persistida. 

@param \stdClass $annon 

Retorno: 

string 

Exceção: 


Página 

78 / 236 

Data 

04/02/2012 

public function persistAttr (ValueObjectAbstract $valueObject, $operType = 

NULL) 

Retorna todos os atributos do ValueObject que podem ser utilizados na 

camada de persistência, definida por self::PERSIST_TYPE. 

delete. 

Opcionalmente, o tipo da operação poderá ser informada - insert, update, 

Nota: Por padrão os atributos selecionados serão válidos para pesquisa. 


@param string $operType

PersistLog 

Retorno: 

\stdClass 


Exceção: 


public function queryLimit ($limit) 


Método que retorna no limite a ser aplicado em uma consulta. 

@param string|integer 

Retorno: 

string 

Exceção: 


Classe de log da camada de persistência. 

Package: 


Namespace: 



Persist 


public function __construct (Persist $persist) 


@param br\gov\icmbio\sial\persist\Persist $persist 

Exceção: 


public function save (ValueObjectAbstract $valueObject, $operation) 

Método que salva os dados de persistência. 


Página 

79 / 236 

Data 

04/02/2012



Retorno: 


Exceção: 



Página 

80 / 236 

Data 

04/02/2012 

public function makeQuery (ValueObjectAbstract $valueObject, $operation) 

Método que monta a instrução SQL a ser executada. 


$valueObject 

@param char $operation 

Retorno: 

string 

Exceção: 


public function isKeepHistory (ValueObjectAbstract $valueObject) 

Método que verifica se um ValueObject representa uma entidade que 

precise manter seu histórico de seus atributos. 


Retorno: 

boolean 

• TRUE – Caso atenda a condição do método. 

• FALSE – Caso não atenda a condição do método. 

Exceção: 


public function fields (\br\gov\icmbio\sial\util\Annotation $annon, array $list = 

NULL) 

Método que recupera a relação dos campos que serão persistidos no Log. 


Retorno: 

string[] 

Exceção: 




Página 

81 / 236 

Data 

04/02/2012 

public function translante (\br\gov\icmbio\sial\util\Annotation $annon, array $list = 

NULL) 

Método que converte a relação dos campos que serão persistidos no Log 

para os respectivos atributos no repositório. 

ResultSet 


@param string[] $list 

Retorno: 

string[] 

Exceção: 


public abstract static function factory (Persist $persist) 

Fábrica de persistência de log. 

@param \br\gov\icmbio\sial\persist\Persist $persist 

Retorno: 


Exceção: 


Classe de resultset da camada de persistência. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\ResultSet 


Persist 


public function __construct (\PDOStatement $resultSet) 


@param \PDOStatement $resultSet

SQLInject 


Exceção: 


public function fetch () 

Método que obtém os dados de um resultset. 

Retorno: 

/stdClass 

Exceção: 


public function count () 


Método que retorna a quantidade de linhas em um resultset. 

Retorno: 

interger 

Exceção: 


Componente que realiza a conexão com o repositório de dados. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\SQLInject 


Persist 


public function encode ($content) 

Página 

82 / 236 

Método que analisa e aplica um conjunto de regras para proteger o 

conteúdo informado de código malicioso. 

@param string $content 

@param string 

Retorno: 

string 

Data 

04/02/2012


Exceção: 


public function decode ($content) 


Página 

83 / 236 

Data 

04/02/2012 

Método que desaplica o conjunto de regras do método encode para obter o 

conteúdo original. 


@param string 

Retorno: 

string 

Exceção: 


br\gov\icmbio\sial\persist\database\mysql 

Config 

Classe de configuração da persistência do tipo database para MySQL. 

Package: 

br.gov.imcbio.sial.persist.database.mysql 

Namespace: 

br\gov\icmbio\sial\persist\database\mysql\Config 


Persist 


repositório. 




Exceção: 


public function getDSN() 

Método que retorna o data source name – DSN, de conexão com o

Connect 

Retorno: 

string 


Exceção: 


protected function _valid (array $config) 


Página 

84 / 236 

Data 

04/02/2012 



Exceção: 


Classe de conexão da persistência do tipo database para MySQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\mysql\Connect 


Persist 


MySQL. 




Exceção: 



Método que realiza a conexão com a persistência do tipo database para 


Exceção:

Persist 



Classe de persistência do tipo database para MySQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\mysql\Persist 


Persist 


public function __construct (PDatabase $persist) 




Exceção: 



Método que executa uma consulta. 


Retorno: 


Exceção: 



Página 

85 / 236 

Data 

04/02/2012 

Método que realiza consulta em todos os elementos de uma entidade. 

Retorno: 


Exceção: 




Página 

86 / 236 

Data 

04/02/2012 


$offSet = 0) 

Método que realiza consulta parametrizada nos elementos de um objeto. 




Retorno: 


Exceção: 



Método que realiza consulta por campo chave da entidade. 


Retorno: 


Exceção: 



Método que salva os dados na persistência. 


Retorno: 


Exceção: 





Retorno: 


Exceção:




Método que exclui os dados na persistência. 


Retorno: 


Exceção: 



br\gov\icmbio\sial\persist\database\pgsql 

Config 

Página 

87 / 236 

Classe de configuração da persistência do tipo database para PostgreSQL. 

Package: 

br.gov.imcbio.sial.persist.database.pgsql 

Namespace: 

br\gov\icmbio\sial\persist\database\pgsql\Config 


Persist 


repositório. 




Exceção: 




Retorno: 

string 

Data 

04/02/2012

Connect 


Exceção: 




Página 

88 / 236 

Data 

04/02/2012 



Exceção: 


Classe de conexão da persistência do tipo database para PostgreSQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\pgsql\Connect 


Persist 





Exceção: 




PostgreSQL. 


Exceção: 


Persist 


Classe de persistência do tipo database para PostgreSQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\pgsql\Persist 


Persist 






Exceção: 





Retorno: 


Exceção: 



Página 

89 / 236 

Data 

04/02/2012 


Retorno: 


Exceção: 




Página 

90 / 236 

Data 

04/02/2012 


$offSet = 0) 





Retorno: 


Exceção: 





Retorno: 


Exceção: 





Retorno: 


Exceção: 





Retorno: 


Exceção:






Retorno: 


Exceção: 



br\gov\icmbio\sial\persist\database\sqlite 

Config 

Classe de configuração da persistência do tipo database para Sqlite. 

Package: 

br.gov.imcbio.sial.persist.database.sqlite 

Namespace: 

br\gov\icmbio\sial\persist\database\sqlite\Config 


Persist 


repositório. 




Exceção: 




Página 

91 / 236 

Data 

04/02/2012 

Retorno: 

Instrução para criação do banco de dados em memória – sqlite::memory.

Connect 


Exceção: 




Página 

92 / 236 

Data 

04/02/2012 



Exceção: 


Classe de conexão da persistência do tipo database para Sqlite. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\sqlite\Connect 


Persist 


Sqlite. 




Exceção: 





Exceção: 


Persist 


Classe de persistência do tipo database para Sqlite. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\database\sqlite\Persist 


Persist 






Exceção: 





Retorno: 


Exceção: 



Página 

93 / 236 

Data 

04/02/2012 


Retorno: 


Exceção: 




Página 

94 / 236 

Data 

04/02/2012 


$offSet = 0) 





Retorno: 


Exceção: 





Retorno: 


Exceção: 





Retorno: 


Exceção: 





Retorno: 


Exceção:






Retorno: 


Exceção: 



protected static final function _getEntityFields (\stdClass $annon) 

Método que retorna a relação dos campos da entidade. 


Retorno: 

string 

Exceção: 


protected static function _buildBasicQuery (\stdClass $annon) 

Método que cria o comando SQL de consulta – Select. 


Retorno: 

string 

Exceção: 


br\gov\icmbio\sial\persist\exception 

PersistException 

Componente que realiza a conexão com o repositório de dados. 

Package: 

br.gov.imcbio.sial.persist.exception 

Página 

95 / 236 

Data 

04/02/2012


Namespace: 



Persist 



Página 

96 / 236 

Data 

04/02/2012 


NULL) 


@param string 


@param \Exception 

Exceção: 


public static function propertyRequired ($property) 

Método que verifica a obrigatoriedade de uma propriedade em 

persistência. 

@param string 

Retorno: 

String 

Exceção: 


public static function adapterUnsupported ($adapter) 

Método que verifica se um adaptador de persistência é suportado. 

@param string 

Retorno: 

string 

Exceção: 


\gov\icmbio\sial\persist\file 

Config 


Componente que configura a persistência em arquivos. 

Package: 

br.gov.imcbio.sial.persist.file 

Namespace: 

br\gov\icmbio\sial\persist\file\Config 


Persist 


Connect 


Método construtor para persistir arquivos. 



Exceção: 


public function _valid (array $config) 

Método não implementado para esse tipo de persistência. 

public function getDSN () 

Método não implementado para esse tipo de persistência. 


Fábrica de conectores para a persistência de arquivos. 


Retorno: 

\br\gov\icmbio\sial\persist\Connect 

Exceção: 


Página 

97 / 236 

Data 

04/02/2012



Componente que configura a conexão para a persistência em arquivos. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\file\Connect 


Persist 


Persist 

Página 

98 / 236 

public function __construct (\br\gov\icmbio\sial\persist\file\Config $config) 



Exceção: 


protected function _connect(TFile $TFile) 

Método de conexão da persistência de arquivos. 

@param \br\gov\icmbio\sial\lang\TFile $TFile 

Retorno: 

String 

Exceção: 


Componente de persistência para arquivos. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\file\Persist 


Persist 


Data 

04/02/2012



public function _connect (\br\gov\icmbio\sial\persist\persistConfig $config) 

Método não implementado. 

@todo recuperar a permissao do config.ini 

public function find ($voFile) 

Método que recupera um arquivo de acordo com a sua chave 

identificadora. 

Obs.: Esse método suporta apenas pesquisa com chave simples. 

@param string $key 

Retorno: 

\br\gov\icmbio\sial\persist\ResultSet 

Exceção: 


public function save (ValueObjectAbstract $voFile) 

Método que realiza a persistência do arquivo em um repositório. 

Página 

99 / 236 

Data 

04/02/2012 

@param br\gov\icmbio\sial\valueObject\ValueObjectAbstract $voFile 

Retorno: 

\br\gov\icmbio\sial\persist\Persist 

Exceção: 


public function update (ValueObjectAbstract $voFile) 

Método que provê a alteração do arquivo em repositório. 


Retorno: 


Exceção: 


public function delete (ValueObjectAbstract $voFile) 

Método que remove um arquivo do repositório. 


Retorno:



Exceção: 


public function getQuery ($entity) 


public function getEntity ($entity, array $columns = array()) 


br\gov\icmbio\sial\persist\ldap 

Config 

Componente que configura a persistência em LDAP. 

Package: 

br.gov.imcbio.sial.persist.ldap 

Namespace: 

br\gov\icmbio\sial\persist\ldap\Config 


Persist 






Exceção: 



Método que obtém o nome da fonte de dados. 

Retorno: 

string 

Exceção: 


Página 

100 / 236 

Data 

04/02/2012

Connect 




Método que verifica se os dados são válidos para a persistência. 


Exceção: 



Fábrica de config para persistência em LDAP. 


Retorno: 


Exceção: 


Componente que realiza a conexão da persistência em LDAP. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\ldap\Connect 


Persist 


Página 

101 / 236 

Data 

04/02/2012 

public function __construct (\br\gov\icmbio\sial\persist\ldap\Config $config) 



Exceção: 



Método que efetua a conexão com o servidor LDAP.




Retorno: 

LDAP resource 

Exceção: 



Método que atualiza os dados de persistência LDAP. 

Retorno: 


Exceção: 



Método que recupera os dados da persistência em LDAP. 

Retorno: 


Exceção: 


public function getParams () 

Método que retorna os parâmetros da persistência LDAP. 

Retorno: 

string[] 

Exceção: 


public function prepare ($query, $params) 

Página 

102 / 236 

Data 

04/02/2012 

Método que prepara o comando a ser executado no repositório LDAP. 

@param [string|string[] $query 


Retorno: 


Exceção: 






Retorno: 



Exceção: 




Retorno: 


Exceção: 




Retorno: 


Exceção: 




Retorno: 


Exceção: 


Página 

103 / 236 

Data 

04/02/2012 


Fábrica de conexões para persistência em LDAP. 


Retorno: 

br\gov\icmbio\sial\persist\Connect

Persist 


Exceção: 


public function getResource () 

Método que recupera a conexão LDAP. 

Retorno: 

resource 

Exceção: 


Componente de persistência para LDAP. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\ldap\Persist 


Persist 



Página 

104 / 236 

Data 

04/02/2012 


NULL) 



Exceção: 



Método que realiza a conexão da persistência em LDAP. 

@param \br\gov\icmbio\sial\persist\ldap\Config 

Retorno: 


Exceção: 





Método que recupera um registro de acordo com atributo chave. 


Retorno: 


Exceção: 



Método que persiste os dados no repositório. 


Retorno: 


Exceção: 



Método que atualiza os dados no repositório. 


Retorno: 


Exceção: 



Método que exclui os dados do repositório. 


$valueObject 

Retorno: 


Exceção: 


Página 

105 / 236 

Data 

04/02/2012

ResultSet 


Componente de conjunto de dados de persistência para LDAP. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\ldap\ResultSet 


Persist 



Página 

106 / 236 

Data 

04/02/2012 

public function __construct (\br\gov\icmbio\sial\persist\ldap\Connect $connect, 

$resultset) 


@param \br\gov\icmbio\sial\persist\ldap\Connect 

@param resource $resultSet 

Exceção: 



Método que recupera o próximo registro em \stdClass. 

Retorno: 

\stdClass[] 

Exceção: 



Método que retorna o total de registros persistidos. 

Retorno: 

integer 

Exceção: 



br\gov\icmbio\sial\persist\query 

AndAbstract 

Componente de abstração para o operador condicional AND. 

Package: 

br.gov.imcbio.sial.persist.query 

Namespace: 

br\gov\icmbio\sial\persist\query\AndAbstract 


Persist 


abstract class AndAbstract extends LogicAbstract 

ClauseAbstract 

Método abstrato. 

Componente de abstração para cláusulas em SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\ClauseAbstract 


Persist 


private function __construct () 


Obs.: Obriga o uso da factory. 

public function column ($columns) 


Página 

107 / 236 

Data 

04/02/2012 

Método responsável por preparar as colunas a serem manipuladas por uma 

instrução SQL. 

@param Column[] $columns

Column 

Retorno: 

Array 



Exceção: 


Exemplos: 

self::column(Column $column); 

self::column(array(Column $column, ..., Column $column)); 

public function render () 

Método responsável pela renderização da representação textual. 

Retorno: 

String 

Exceção: 


public static function factory () 

Fábrica de ClauseAbstract. 

Retorno: 

\br\gov\icmbio\sial\persist\query\ClauseAbstract 

Exceção: 


Componente de colunas utilizadas em instruções SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\Column 


Persist 


public function __construct ($column, $entity = NULL) 


Página 

108 / 236 

Data 

04/02/2012

$entity); 

@param string $column 

@param string $entity 



Exceção: 


Página 

109 / 236 

Data 

04/02/2012 

Exemplos: 

Column::__construct(string $column, string $entity); 

Column::__construct(Expression $expression, string $entity); 

Column::__construct(array(string $alias => $name), string $entity); 

Column::__construct(array(string $alias => Expression $expression), string 

public function name () 

Método responsável por atribuir o nome da coluna da instrução SQL. 

Retorno: 

String 

Exceção: 


public function qualifiedName () 

Método responsável por retornar o nome da coluna precedido do nome, 

alias ou entidade correspondente. 

SQL. 

Retorno: 

String 

Exceção: 


public function alias () 

Método responsável por atribuir o apelido – alias, a coluna da instrução 

Retorno: 

String 

Exceção: 


public function entity () 

Método responsável por retornar o nome da entidade detentora da coluna 

da instrução SQL.

Retorno: 

String 


Exceção: 


public function setAlias ($alias) 


Página 

110 / 236 

Data 

04/02/2012 

Método que atribui um apelido – alias, a uma coluna da instrução SQL. 

@param string 

Retorno: 

\br\gov\icmbio\sial\persist\query\Column 

Exceção: 



Método responsável pela renderização da representação textual. 

Retorno: 

String {entity}{column} AS {alias} 

Exceção: 


public function __toString () 

Método que executa render(). 

Retorno: 

String 

Exceção: 


public function ignoreColumn ($column, $entity, $dataSource) 

Método responsável por ignorar uma coluna em um repositório. 


@param Entity $entity 

@param string $dataSource 

Retorno: 

Boolean

Entity 


• TRUE: Caso a coluna for ignorada. 

• FALSE: Caso a coluna não for ignorada. 

Exceção: 


public function columnExists ($column, $entity, $dataSource) 


Método que verifica se uma coluna existe em uma entidade. 



@param string $dataSource 

Retorno: 

Boolean 

• TRUE: Caso a coluna exista na entidade. 

• FALSE: Caso a coluna não exista na entidade. 

Exceção: 


public static function factory ($column, Entity $entity, $type) 

Página 

111 / 236 

Data 

04/02/2012 

Fábrica de Column. 

Onde, 

• $column define o nome da coluna que será criada; 

• $entity define a entidade que a coluna será associada; 

• $type define a fonte de dados - database, ldap, webservice, etc. 

Retorno: 


Exceção: 


Componente de entidades utilizadas em instruções SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\Entity 

Camadas de utilização:


Persist 

$column); 


public function __construct ($entity, array $columns = array()) 


@param mixed $entity 

@param string[]|Column[] $columns 

Exceção: 



Página 

112 / 236 

Data 

04/02/2012 

Exemplos: 

Entity::__construct(string $namespace, string[] $column); 

Entity::__construct(ValueObject $valueObject, string[] $column); 

Entity::__construct(array(string $alias => string $namespace), strin[] 

Entity::__construct(array(string $alias => ValueObject $valueObject), 

string[] $column); 

utilização. 

public function column ($column) 

Método que verifica a disponibilidade de uma coluna para a entidade em 


Retorno: 


Exceção: 


protected function _setup (ValueObjectAbstract $valueObject, $columns) 

Método responsável pela configuração da entidade de acordo com as 

anotações em seu respectivo ValueObject. 

@param \br\gov\icmbio\sial\valueObject\ValueObjectAbstract 

$valueObject 

Exceção: 



Método responsável por recuperar o nome completo da entidade.



Obs.: Retorna o nome da entidade com o alias quando houver. 

Retorno: 

String 

Exceção: 


public function schema () 

Método que recupera o schema da entidade. 

Retorno: 

String 

Exceção: 


public function name () 

Método que recupera o nome da entidade. 

Retorno: 

String 

Exceção: 



Método que recupera o alias da entidade. 

Retorno: 

String 

Exceção: 


public function columns () 

Método que recupera todas as colunas da entidade. 

Retorno: 

\stdClass 

Exceção: 


Página 

113 / 236 

Data 

04/02/2012

Expression 


Componente para renderização de expressões SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\Expression 


Persist 


public function __construct ($expression) 


Página 

114 / 236 

Data 

04/02/2012 

Método construtor. Verifica se a expressão é válida para renderização. 

@param string|Renderizable $expression 

Exceção: 



Método responsável por renderizar a expressão SQL. 

Retorno: 

String 

ExpressionAbstract 

Exceção: 


Componente abstrato de renderização de expressões SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\ExpressionAbstract 


Persist 


Nenhum. 

FunctionAbstract 


Componente abstrato para utilização de funções de SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\FunctionAbstract 


Persist 


public function __construct (Renderizable $element) 


@param Renderizable $element 

Exceção: 



InstructAbstract 

Método de renderização para as expressões de SQL. 

Retorno: 

String 

Exceção: 


Componente abstrato para utilização de instruções de SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\InstructAbstract 


Persist 


Página 

115 / 236 

Data 

04/02/2012


Nenhum. 

JoinAbstract 


Componente abstrato para utilização de joins no SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\JoinAbstract 


Persist 



Método que renderiza um comando de Join. 

Retorno: 

String 

Exceção: 



Página 

116 / 236 

Data 

04/02/2012 

public static function factory (Entity $entity, RelationalAbstract $conditional) 

LogicAbstract 

Package: 

Fábrica de JoinAbstract. 

@param Entity 

@param Column $column 

@param RelationalAbstract $conditional 

Retorno: 

\br\gov\icmbio\sial\persist\query\JoinAbstract 

Exceção: 


Componente abstrato para utilização de comandos lógicos em SQL.

.gov.imcbio.sial.persist.query 


Namespace: 

br\gov\icmbio\sial\persist\query\LogicAbstract 


Persist 


private function __construct () 


Obs.: Obriga a utilização da factory. 


public function add (OperatorAbstract $expression, $operator = 

self::T_AND_OPERATOR) 

Método que implementa o uso dos operadores lógicos and e or. 

@param OperatorAbstract $operator 

@param string $oper – and / or 

Constantes utilizadas para $oper: 

const T_AND_OPERATOR = ' AND '; 

const T_OR_OPERATOR = ' OR '; 

Retorno: 

\br\gov\icmbio\sial\persist\query\LogicAbstract 

Exceção: 


public function setQuery (QueryAbstract $query) 

Método que estabelece a query que está sendo manipulada. 

Retorno: 

String 

Exceção: 


public function __call ($name, $arguments) 

Método que verifica o tipo de operador a utilizar no comando SQL. 


@param mixed[] $arguments 

Página 

117 / 236 

Data 

04/02/2012


Retorno: 


Exceção: 




Método responsável por renderizar as expressões lógicas de SQL. 

Retorno: 

String 

Exceção: 


public static function factory (QueryAbstract $query) 

OperatorAbstract 

Fábrica de LogicAbstract. 

@param br\gov\icmbio\sial\persist\query\QueryAbstract $query 

Retorno: 


Exceção: 


Componente abstrato para utilização de operadores em SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\OperatorAbstract 


Persist 



Método responsável pela representação textual do operador. 

Retorno: 

Página 

118 / 236 

Data 

04/02/2012

QueryAbstract 

string 


Exceção: 


Componente abstrato para manipulação de queries em SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\QueryAbstract 


Persist 


public function hasEntity () 


Método que verifica a existência de uma entidade registrada. 

Retorno: 

boolean 

• TRUE: Caso a entidade esteja registrada. 

• FALSE: Caso a entidade não esteja registrada. 

Exceção: 



Método que retorna a entidade registrada. 

Exceção: 


public function __get ($column) 

Método que recupera o valor persistido em uma coluna. 


Retorno: 

mixed 

Página 

119 / 236 

Data 

04/02/2012



Exceção: 


Exemplo: 

public function col ($column) 


Atalho para o método self::column(); 

public abstract function addColumn ($column); 

Adiciona uma coluna a query. 

Obs.: O nome da coluna deve estar presente em entity. 

@param string|Column $column 

Retorno: 



Exceção: 


public abstract function expression ($alias, $expression); 

Método abstrato para aplicar um apelido a uma expressão. 

@param string $alias 

@param string $expression 

Retorno: 


Exceção: 


public abstract function where (RelationalAbstract $conditional) 

Método abstrato que aplica a condicional WHERE em uma query. 


Retorno: 

Where 

Exceção: 


Página 

121 / 236 

Data 

04/02/2012 

public abstract function join (Entity $entity, RelationalAbstract $conditional); 

Método abstrato que aplica instrução INNER JOIN em uma query. 



Retorno:




Exceção: 


Página 

122 / 236 

Data 

04/02/2012 

public abstract function leftJoin (Entity $entity, RelationalAbstract $conditional); 

Método abstrato que aplica instrução LEFT JOIN em uma query. 



Retorno: 


Exceção: 


public abstract function rightJoin (Entity $entity, RelationalAbstract $conditional); 

Método abstrato que aplica instrução RIGHT JOIN em uma query. 



Retorno: 


Exceção: 


public abstract function groupBy ($columns); 

Método abstrato que implementa a instrução de GROUP BY em uma query. 

@param Column[] $columns 

Retorno: 

GroupBy 

Exceção: 


public abstract function having ($columns); 

Método abstrato que implementa o filtro HAVING em uma query. 

@param Column[] $columns


Retorno: 



Exceção: 


public abstract function orderBy ($columns); 

Página 

123 / 236 

Data 

04/02/2012 

Método abstrato que implementa o comando de ordenação – ORDER BY, 

em uma query. 


Retorno: 


Exceção: 


Exemplo: 

 

# cria objeto de consulta 

$query = QueryAbstract::factory($type, new 

fullnamespace\valeuObject\Foo); 

# coluna que sera agrupada 

$column = $query->bar; 

# configura a ordernacao 

$column->sort = 'asc'; 

/* 

alternativamente, a operacao de configurar a sentido de ordenacao 

pode ser definida 

usando o metodo Column::sort('asc|desc') ou Column::sortDesc() e 

Column::SortAsc() 

*/ 

# aplica ordenacao 

$query->orderBy($column);

esultset. 


public abstract function limit ($limit, $offset); 


Página 

124 / 236 

Data 

04/02/2012 

Método abstrato que limita a quantidade de registros retornados por um 

@param mixed $limit (integer | ALL) 

@param integer $offset 

Retorno: 


Exceção: 


public static function factory ($type, $entity = NULL) 

Fábrica de QueryAbstract. 



• $type define o tipo de query a ser criada; 

• $entity define a entidade que será manipulada. 

◦ Namespace da entidade ou objeto de ValueObject. 

Obs.: Caso $entity não seja informada, apenas estão disponíveis os 

métodos Expresion e Function. 

Retorno: 


Exceção: 


Exemplo: 

?> 



Página 

125 / 236 

Data 

04/02/2012 

# cria objeto de consulta para banco de dados postgres na entidade 

's_foo' 

# dando-lhe um apelido de 'foo' 

$query = Query::factory('psql', array('foo' => 

'fullNamespace\FooValueObject')); 

# cria objeto de consulta para arquivo texto 

$query = Query::factory('text'); 

# cria objeto de consulta para arquivo csv 

$query = Query::factory('csv'); 

# uma vez criado o objeto de consulta todos os comandos disponivel 

# para pesquisa selecionada estarao disponiveis 

$query->addColumn('bar'); 


Método que retorna a representação da query. 

Retorno: 

String 

RelationalAbstract 

Exceção: 


Componente abstrato para operadores relacionais em SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\RelationalAbstract 


Persist 


Nenhum 

SelectAbstract 

Componente abstrato para comandos em SQL.

Package: 



Namespace: 

br\gov\icmbio\sial\persist\query\SelectAbstract 


Persist 


Nenhum 


br\gov\icmbio\sial\persist\query\database 

Avg 

Classe que implementa a função SQL ANSI/92 AVG. 

Package: 

br.gov.imcbio.sial.persist.query.database 

Namespace: 

br\gov\icmbio\sial\persist\query\database\Avg 


Persist 


Nenhum 

Between 

Classe que implementa a função SQL ANSI/92 BETWEEN. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Between 


Persist 


public function __construct (Column $column, $fParam, $sParam) 


Página 

126 / 236 

Data 

04/02/2012

Column 



@param \br\gov\icmbio\sial\persist\query\Column $column 

@param mixed $fParam 

@param mixed $sParam 

Exceção: 



Página 

127 / 236 

Método que retorna a representação textual do comando between. 

Retorno: 

String 

Exceção: 


Classe para manipulação de colunas em uma instrução em SQL. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Column 


Persist 


public function __call($method, $arguments) 

Método interpretador das chamadas aos operadores: 

SIAL SQL ANSI/92 

Column::in IN 

Column::equals == 

Column::isnull IS NULL 

Column::isnotnull IS NOT NULL 

Column::greaterthan > 

Column::lessthan < 

Data 

04/02/2012


Column::notequals 

Column::greaterthanorequals >= 

Column::lessthanorequals



public function avg () 

Método que aplica o comando AVG a coluna. 

Retorno: 


Exceção: 



Método que aplica o comando COUNT a coluna. 

Retorno: 


Exceção: 


public function sum () 

Método que aplica o comando SUM a coluna. 

Retorno: 


Exceção: 


public function max () 

Método que aplica o comando MAX a coluna. 

Retorno: 


Exceção: 


public function min () 

Método que aplica o comando MIN a coluna. 

Retorno: 


Exceção: 


Página 

129 / 236 

Data 

04/02/2012

Count 





Página 

130 / 236 

Data 

04/02/2012 

Método responsável por apresentar a representação textual da coluna. 

Retorno: 

String 

Exceção: 


Classe que implementa a função COUNT em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Count 


Persist 


Nenhum. 

Distinct 

Classe que implementa a funcionalidade DISTINCT em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Distinct 


Persist 


Nenhum. 

Equals 

Classe que implementa a funcionalidade EQUALS em SQL ANSI/92. 

Package: 

br.gov.imcbio.sial.persist.query.database


Namespace: 

br\gov\icmbio\sial\persist\query\database\Equals 


Persist 


Nenhum. 

Expression 

Classe renderizadora de expressões SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Expression 


Persist 


From 

public function __construct ($expression) 



Exceção: 



Método que renderiza as expressões SQL ANSI/92. 

Retorno: 

String 

Exceção: 



Página 

131 / 236 

Data 

04/02/2012 

Componente de montagem e renderização de instruções em SQL para a cláusula 

FROM. 

Package: 

br.gov.imcbio.sial.persist.query.database


Namespace: 

br\gov\icmbio\sial\persist\query\database\From 


Persist 


public function __construct (Entity $entity = NULL) 



@param br\gov\icmbio\sial\persist\query\Entity $entity 

Exceção: 



Método que recupera o nome da entidade. 

Retorno: 

String 

Exceção: 



Método que recupera o apelido – alias, da entidade. 

Retorno: 

String 

Exceção: 



Página 

132 / 236 

Data 

04/02/2012 

Método que recupera o nome completo, inclusive alias, da entidade. 

Retorno: 

String 

Exceção: 



Método responsável por renderizar a forma textual do comando FROM.

GreaterThan 

Retorno: 

String 


Exceção: 


public static function factory (Entity $entity = NULL) 

Fábrica do componente From. 



Retorno: 

br\gov\icmbio\sial\persist\query\database\From 

Exceção: 


Página 

133 / 236 

Data 

04/02/2012 

Classe que implementa a funcionalidade “>” - Greater than, em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\GreaterThan 


Persist 


Nenhum. 

GreaterThanOrEquals 

Classe que implementa a funcionalidade “>=” - Greater than or equals, em SQL 

ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\GreaterThanOrEquals 


Persist 


Nenhum.

GroupBy 



Classe que implementa o comando GROUP BY em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\GroupBy 


Persist 


Nenhum. 

Having 

Classe que implementa o comando HAVING em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Having 


Persist 


Nenhum. 

In 

Classe que implementa o comando IN em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\In 


Persist 


Nenhum. 

InnerJoin 

Classe que implementa o comando INNER JOIN em SQL ANSI/92. 

Página 

134 / 236 

Data 

04/02/2012

Package: 



Namespace: 

br\gov\icmbio\sial\persist\query\database\InnerJoin 


Persist 


Nenhum. 

LeftJoin 


Classe que implementa o comando LEFT JOIN em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\LeftJoin 


Persist 


Nenhum. 

RightJoin 

Classe que implementa o comando RIGHT JOIN em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\RightJoin 


Persist 


Nenhum. 

IsNotNull 

Classe que implementa o comando IS NOT NULL em SQL ANSI/92. 

Package: 


Página 

135 / 236 

Data 

04/02/2012


Namespace: 

br\gov\icmbio\sial\persist\query\database\IsNotNull 


Persist 


NOT NULL. 

IsNull 

public function __construct (Column $column) 



Página 

136 / 236 

Data 

04/02/2012 

@param br\gov\icmbio\sial\persist\query\database\Column $column 

Exceção: 



Método responsável por retornar a representação textual do comando IS 

Retorno: 

String 

Exceção: 


Classe que implementa o comando IS NULL em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\IsNull 


Persist 


public function __construct (Column $column) 


@param br\gov\icmbio\sial\persist\query\database\Column $column 

Exceção: 


NULL. 

LessThan 




Página 

137 / 236 

Data 

04/02/2012 


Retorno: 

String 

Exceção: 


Classe que implementa o operador relacional “


br\gov\icmbio\sial\persist\query\database\Like 


Persist 


Nenhum. 

LimitAbstract 

Classe abstração para cláusula LIMIT em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\LimitAbstract 


Persist 


query. 

public function set ($limit, $offset) 


Página 

138 / 236 

Data 

04/02/2012 

Método que aplica o número de registros a serem recuperados por uma 



Retorno: 

Void 

Exceção: 


public static function factory ($driver) 

Fábrica de objetos de LIMIT. 

@param string driver 

Retorno: 

br\gov\icmbio\sial\persist\query\database\LimitAbstract 

Exceção: 

\br\gov\icmbio\sial\exception\IOException

Max 


Classe que implementa a função MAX em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Max 


Persist 


Nenhum. 

Min 

Classe que implementa a função MIN em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Min 


Persist 


Nenhum. 

NotEquals 


Classe que implementa a função “” - Not equals, em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\NotEquals 


Persist 


Nenhum. 

NotIn 

Classe que implementa o operador relaciona NOT IN em SQL ANSI/92. 

Página 

139 / 236 

Data 

04/02/2012

Package: 



Namespace: 

br\gov\icmbio\sial\persist\query\database\NotIn 


Persist 


Nenhum. 

OrderBy 

Classe que implementa a cláusula ORDER BY em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\OrderBy 


Persist 


NULL. 

public function getColumns () 

Método que recupera todas as colunas da entidade. 

Retorno: 

Column[] 

Exceção: 




Página 

140 / 236 

Data 

04/02/2012 


Retorno: 

String 

Exceção: 


Query 



Classe de objetos de consulta em persistência para banco de dados. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Query 


Persist 


private function __construct ($driver, Entity $entity = NULL) 

Página 

141 / 236 

Data 

04/02/2012 

Método construtor. Define o banco de dados e a entidade a manipular. 

@param string $driver (pgsql, mysql, sqlite, etc) 


(valueObject | namespace) 

Exceção: 


public function cleanColumn () 

Método que remove a relação de colunas utilizadas em uma consulta. 

Retorno: 


Exceção: 


Exemplo: 

 

public function addColumn ($column) 

Método responsável por adicionar uma coluna a uma query. 

Obs.: Será verificado em br\gov\icmbio\sial\persist\query\Entity a 

existência da coluna a adicionar. 


Retorno:




Exceção: 


Exemplo: 

 

# Adiciona uma coluna informando um objeto 

Query::addColumn(Column $column) 

public function expression ($alias, $expression) 

Método responsável por adicionar expressões a query. 

@param string $alias 


Retorno: 


Exceção: 


Exemplo: 

 

public function __call($method, $arguments) 

Página 

142 / 236 

Data 

04/02/2012 

Método que intercepta a chamada dos métodos Query::and e Query::or. 

@param RelationalAbstract $expression 

Retorno: 


Exceção: 


Exemplo: 

?> 


# aplica codicao where a pesquisa 

$query->where($conditional) 

# aplica segunda condicao (AND) a pesquisa 

->and($conditional) 

# aplica terceira condicao (OR) a pesquisa 

->or($conditional) 

# obtem representacao textual da pesquisa 

->render(); 


public function where (RelationalAbstract $conditional, $operator = 

Where::T_AND_OPERATOR) 

Método que adiciona a condicional WHERE a uma query. 


Retorno: 


Exceção: 


Exemplo: 

 

# foo = 'foo' 

$filter = $query->foo->equals('foo'); 

# aplica condicao a query 

$query->where($filter); 

public function join (Entity $entity, RelationalAbstract $conditional) 

Método que implementa o comando INNER JOIN a uma query. 



Retorno: 


Página 

143 / 236 

Data 

04/02/2012



Exceção: 


Exemplo: 

 

# aplica o join 

$query->join($bar, $joinConditional) 

# aplica condicao a query 

->where(...); 

public function leftJoin (Entity $entity, RelationalAbstract $conditional) 

Método que implementa o comando LEFT JOIN a uma query. 



Retorno: 


Exceção: 


Exemplo: 

 


$query->leftJoin($bar, $joinConditional); 

Página 

144 / 236 

Data 

04/02/2012



public function rightJoin (Entity $entity, RelationalAbstract $conditional) 

Método que implementa o comando RIGHT JOIN a uma query. 



Retorno: 


Exceção: 


Exemplo: 

 


$query->rightJoin($bar, $joinConditional); 

public function groupBy ($columns) 

Método que implementa o comando GROUP BY a uma query. 


Retorno: 


Exceção: 


Exemplo: 

?> 


# aplica agrupamento 

$query->groupBy($column) 

public function having ($columns) 


Método que implementa o comando HAVING a uma query. 


Retorno: 


Exceção: 


Exemplo: 

 


$column = $query->bar; 

# aplica condicao ao agrupamento 

$query->having($column->greaterTehn(10)); 

public function orderBy ($columns) 

Método que implementa o comando ORDER BY a uma query. 


Retorno: 


Exceção: 


Exemplo: 

 


$query = Query::factory(...); 

# coluna que será agrupada 

$query->orderBy(array('foo' => 'desc', 'bar' => 'asc')); 

Página 

146 / 236 

Data 

04/02/2012

public function limit ($limit, $offset) 



Página 

147 / 236 

Data 

04/02/2012 

Método que limita a quantidade de registros retornados por um resultset. 

@param mixed $limit (integer | ALL) 


Retorno: 


Exceção: 


Exemplo: 

 



$query = Query::factory(...); 


$query->limit(10, 0); 

Método que retorna a representação textual da query. 

Retorno: 

String 

Exceção: 


public static function factory ($driver, $entity = NULL) 

Fábrica de objetos para Query. 

@param string $driver 


Retorno: 


Exceção: 


Exemplo: 


entidade sera usado esta definicao) 

Foo { $foor, $bar, $fooBar, $barFoo } 

?> 

RelationalAbstract 

# define o driver que sera utilizado 

$driver = 'pgsql'; 


Página 

148 / 236 

Data 

04/02/2012 

# cria entidade que sera utilizada para definicao da Query 

# esta entidade dara subsidios ao objeto Query na obtencao do 

nome/apelido da entidade bem como 

# informara a relacao de colunas que poderao ser utilizadas na 

pesquisa. a decisao de qual coluna 

# podera ser utilizada sera decidida com base na anotacao da 

mesma. 

$entity = new Entity('fulnamespace\Foo'); 

# cria query especifico para o banco de dados Postgres 

$query = Query::factory($driver, $entity); 

# exibe representacao textual da query 

echo $query->render(); 

Classe de abstração de operações relacionais para query. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\RelationalAbstract 


Persist 


public function __construct (Column $column, $value) 



@param mixed $value 

Exceção: 


RightJoin 

public function converteValue ($value) 


Método para conversão de valor para banco de dados. 


Retorno: 

String 


Exceção: 



Página 

149 / 236 

Data 

04/02/2012 

Método para renderização da representação textual de RelationalAbstract. 

Retorno: 

String 

Exceção: 


Classe que implementa o comando RIGHT JOIN em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\RightJoin 


Persist 


Nenhum. 

SelectAbstract 

Classe que implementa o comando SELECT em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\SelectAbstract 


Persist



public function __construct (Entity $entity = NULL) 


Página 

150 / 236 

Data 

04/02/2012 


Obs.: Se informado uma entidade todas as colunas de Entity referente a 

banco de dados serão usadas para compor a relação de colunas do Select. 


Exceção: 


public function cleanrColumn () 

Método que remove todas as colunas do SELECT. 

Retorno: 


Exceção: 


public function from (Entity $entity) 

Método que define a entidade de consulta. 


Retorno: 


Exceção: 


public function where (Where $where) 

Método que adiciona o comando WHERE a uma query. 

@param Where $where 

Retorno: 


Exceção: 

\br\gov\icmbio\sial\exception\IllegalArgumentException

public function join (JoinAbstract $join) 



Método que adiciona o comando INNER JOIN a uma query. 

@param JoinAbstract 

Retorno: 


Exceção: 


public function groupBy (GroupBy $groupBy) 

Método que adiciona o comando GROUP BY a uma query. 

@param GroupBy $groupBy 

Retorno: 


Exceção: 


public function orderBy ($orderBy) 

Método que adiciona o comando ORDER BY a uma query. 

@param OrderBy $orderBy 

Retorno: 


Exceção: 


public function having ($having) 

Método que adiciona o comando HAVING a uma query. 

@param having $having 

Retorno: 


Exceção: 


Página 

151 / 236 

Data 

04/02/2012

public function limit (LimitAbstract $limit) 


Método que adiciona o comando LIMIT a uma query. 

@param LimitAbstract $limit 


Retorno: 


Exceção: 


public function valueCare ($value, $type) 

Método que trata o tipo de valor do filtro. 



Retorno: 

mixed 

Exceção: 


public function addColumn (Column $column) 

Método que adiciona uma coluna a uma query. 


@param string $registerAs 

Retorno: 


Exceção: 


public function hasColunm ($name) 

Página 

152 / 236 

Data 

04/02/2012 

Método que verifica se uma coluna está registrada para uma entidade. 


Retorno: 

boolean 

• TRUE: Caso a coluna esteja registrada; 

• FALSE: Caso a coluna não esteja registrada.

Sum 



Exceção: 


public function getColumn ($name) 

Método que recupera uma coluna registrada em uma entidade. 


Retorno: 

br\gov\icmbio\sial\persist\query\database\Column 

Exceção: 



Método que retorna a representação textual do SELECT. 

Retorno: 

String 

Exceção: 


Classe que implementa o comando SUM em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Sum 


Persist 


Nenhum. 

Where 

Classe que implementa o comando WHERE em SQL ANSI/92. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\Where 

Página 

153 / 236 

Data 

04/02/2012


Persist 


Nenhum. 



Página 

154 / 236 

Data 

04/02/2012 

br\gov\icmbio\sial\persist\query\database\pgsql 

Limit 

Classe que implementa o comando LIMIT para o database PostgreSQL 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\pgsql\Limit 


Persist 





Método que retorna a representação textual de LIMIT para o database 

PostgreSQL. 

Query 

Retorno: 

String 

Exceção: 


Classe para manipulação de objeto de consulta para o database PostgreSQL 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\pgsql\Query


Persist 


Select 



public static function factory ($type, $entity = NULL, $columns = NULL) 

Fábrica de objeto Query. 



@param string[] $columns 

Retorno: 

br\gov\icmbio\sial\persist\query\database\pgsql\Query 

Exceção: 


Classe para manipulação comando SELECT para o database PostgreSQL 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\query\database\pgsql\Select 


Persist 


public function __construct(Entity $entity = NULL) 



Exceção: 


public static function factory (Entity $entity = NULL) 

Fábrica de Select. 

@param Entity 

Página 

155 / 236 

Data 

04/02/2012



Retorno: 

br\gov\icmbio\sial\persist\query\database\pgsql\Select 

Exceção: 


br\gov\icmbio\sial\persist\reflection 

Reflection 

Componente de superclasse de reflexão do repositório. 

Package: 

br.gov.imcbio.sial.persist.reflection 

Namespace: 

br\gov\icmbio\sial\persist\reflection\Reflection 


Persist 


public function __construct (Annotation $annotation, Connect $connect) 


Página 

156 / 236 

Data 

04/02/2012 

@param \br\gov\icmbio\sial\persist\util\Annotation $annotation 

@param \br\gov\icmbio\sial\persist\Connect $connect 

Exceção: 


public static function factory ($source, Connect $connect) 

Fábrica de reflection. 

Trabalha utilizando a annotation do ValueObject para obter a entidade e 

suas propriedades. 

@param [string | Valueobject] $source 


Retorno: 


Exceção:




public abstract function property ($name = NULL) 

Método que recupera uma propriedade específica de um objeto. 


Retorno: 

\stdClass 

Exceção: 


public abstract function properties () 

Método que recupera todas as propriedades de um objeto. 

Retorno: 

\stdClass 

Exceção: 


Página 

157 / 236 

Data 

04/02/2012 

br\gov\icmbio\sial\persist\reflection\adapter\datab 

ase\pgsql 

Reflection 

Componente de superclasse de reflexão do repositório PostgreSQL. 

Package: 

br.gov.imcbio.sial.persist.reflection.adapter.database.pgsql 

Namespace: 

br\gov\icmbio\sial\persist\reflection\adapter\database\pgsql\Reflection 


Persist 


public static function factory ($source, \br\gov\icmbio\sial\persist\Connect 

$connect) 

Fábrica de reflection de repositório PostgreSQL.




Retorno: 



Exceção: 


public function property ($name = NULL) 

Método que recupera uma propriedade específica de um objeto. 


Retorno: 

\stdClass 

Exceção: 


public abstract function properties () 

Método que recupera todas as propriedades de um objeto. 

Retorno: 

string[] 

Exceção: 


br\gov\icmbio\sial\persist\util 

Annotation 

Componente de superclasse de manipulação de annotation. 

Package: 

br.gov.imcbio.sial.persist.util 

Namespace: 

br\gov\icmbio\sial\persist\util\Annotation 


Persist 


Página 

158 / 236 

Data 

04/02/2012

eflection. 



public function __construct (ValueObjectAbstract $valueObject) 



Exceção: 


public function cache () 

Método que grava a anotação em cache. 

Retorno: 

br\gov\icmbio\sial\util\AnnotationCache 

Exceção: 


public function load () 

Método que carrega a anotação em cache. 

Retorno: 

\stdClass 

Exceção: 


public function getClassDoc () 

Método que recupera a documentação da classe de reflection. 

Retorno: 

string[] 

Exceção: 


public function getAttrsDoc () 

Método que recupera a documentação dos atributos da classe de 

Retorno: 

string[] 

Exceção: 


Página 

159 / 236 

Data 

04/02/2012


br\gov\icmbio\sial\persist\webservice 

Webservice 

Componente que configura a persistência em Webservice. 

Package: 

br.gov.imcbio.sial.persist.webservice 

Namespace: 

br\gov\icmbio\sial\persist\webservice\Config 


Persist 


repositório. 





Exceção: 




Retorno: 

string 

Exceção: 



Método que valida as propriedades da persistência. 

@param array $config 

Exceção: 


Página 

160 / 236 

Data 

04/02/2012

Connect 



Fábrica de persistência para Webservice. 


Retorna: 

br\gov\icmbio\sial\persist\webservice\Config 


Exceção: 


Componente realiza a conexão para a persistência em Webservice. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\webservice\Connect 


Persist 


Página 

161 / 236 

Data 

04/02/2012 

public function __construct (\br\gov\icmbio\sial\persist\webservice\Config $config) 



Exceção: 



Método que realiza a conexão para a persistência em Webservice. 

@param persistConfig 

Exceção: 



Método que atualiza os dados persistidos.


Retorno: 

\br\gov\icmbio\sial\persist\ResultSet 

Exceção: 





Retorno: 

br\gov\icmbio\sial\persist\webservice\ResultSet 

Exceção: 


public function prepare ($query, $params) 

Método que prepara o comando a ser executado na persistência. 



Retorno: 

\br\gov\icmbio\sial\persist\database\Connect 

Exceção: 



Método que não aplicável para persistência em webservice. 

Retorno: 

FALSE 


Método que inicia uma transação. 

Retorno: 


Exceção: 



Método que finaliza uma transação pendente. 

Página 

162 / 236 

Data 

04/02/2012

Persist 


Retorno: 


Exceção: 



Método que descarta a transação pendente. 

Retorno: 


Exceção: 



Página 

163 / 236 

Data 

04/02/2012 


Fábrica de persistência para webservice. 


Retorno: 


Exceção: 


public function getResource () 

Método que retorna a conexão da persistência. 

Retorno: 

resource 

Exceção: 


Componente realiza a persistência em Webservice. 

Package: 


Namespace: 

br\gov\icmbio\sial\persist\webservice\Persist


Persist 


ResultSet 



Página 

164 / 236 

Data 

04/02/2012 


NULL) 



Exceção: 



Método que realiza a conexão da persistência para webservice. 


Retorna: 


Exceção: 










Componente para manipulação de dados da camada de persistência. 

Package: 


Namespace:


br\gov\icmbio\sial\persist\webservice\ResultSet 


Persist 


public function __construct (Connect $connect, $resultset) 



Página 

165 / 236 

@param \br\gov\icmbio\sial\persist\webservice\Connect $connect 

@param br\gov\icmbio\sial\persist\ResultSet 

Exceção: 



Data 

04/02/2012 

Método que recupera as informações consumidas em um webservice. 

Retorno: 

resource 

Exceção: 



Método que retorna a quantidade elementos no objeto. 

Retorno: 

interger 

Exceção: 


br\gov\icmbio\sial\util 

Annotation 

Componente de manipulação de anotações. 

Package: 

br.gov.imcbio.sial.util 

Namespace:

\gov\icmbio\sial\util\Annotation 


Model 

View 

Controller 

Business 

Persist 




public function __construct(\br\gov\icmbio\sial\SIALAbstract $sial) 

Página 

166 / 236 

Data 

04/02/2012 

Método construtor. Recebe o objeto de uma subclasse de SIALAbstract e 

constrói o objeto ReflectionClass. 

@param \br\gov\icmbio\sial\SIALAbstract $sial 

Exceção: 


public function cache () 

Método responsável por disponibilizar o objeto de cache. 

Retorno: 

\br\gov\icmbio\sial\util\AnnotationCache 

Exceção: 


public function getClassName (self $sial = NULL) 

Método que recupera o nome da classe utilizada pela anotação. 

@param string $sial 

Retorno: 

string 

Exceção: 


public function getFileName () 

Método que recupera o nome de um arquivo – filename. 

Retorno: 

string


Exceção: 


public function getClassDoc () 

Método que retorna o bloco de comentário da classe. 

Retorno: 

string 

Exceção: 


public function getAttrsDoc () 


Página 

167 / 236 

Data 

04/02/2012 

Método que retorna o bloc de comentário de todos os atributos da clase. 

Retorno: 

string[] 

Exceção: 


public function hasAttr ($attr, $persistType = NULL) 

Método que verifica a existência de um atributo. 

@param string $attr 

@param string $persistType 

Retorno: 

• TRUE – Caso o atributo exista. 

• FALSE – Caso o atributo não exista. 

Exceção: 


public function getAttr ($attr, $persistType) 

Método que recupera o atributo de uma persistência. 

@param string $attr 

@param string $persistType 

Retorno: 

string 

Exceção: 


classe. 

public function getMethodsDoc () 



Página 

168 / 236 

Data 

04/02/2012 

Método que recupera todo bloco de documentação dos métodos de uma 

Retorno: 

string[] 

AnnotationCache 

Exceção: 


Componente de manipulação de cache de anotações. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\AnnotationCache 


Model 

View 

Controller 

Business 

Persist 


public function save (\br\gov\icmbio\sial\util\Annotation $annon) 

Método que cria o cache da anotação. 

@param \br\gov\icmbio\sial\util\Annotation $annon 

Retorno: 

\br\gov\icmbio\sial\util\AnnotationCache 

Exceção: 


public function load (\br\gov\icmbio\sial\util\Annotation $annon) 

Método que carrega o conteúdo de uma anotação em cache. 

@param \br\gov\icmbio\sial\util\Annotation $annon

Config 

Retorno: 

stdClass 


Exceção: 


Componente de configuração dos utilitários do SIAL. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\Config 


Util 


public function __construct ($config, $section) 



@param string $section 

Exceção: 


public function hash () 

Método que retorna o hash dos dados de configuração. 

Retorno: 

string 

Exceção: 


public final function isSuported ($config) 


Método que verifica se o tipo da configuração é suportado. 


Retorno: 

Página 

169 / 236 

Data 

04/02/2012



• TRUE – Caso o tipo da configuração seja suportado. 

• FALSE – Caso o tipo da configuração não seja suportado. 

Exceção: 


protected final function load ($config, $section) 

ConfigAbstract 

Método que carrega as configurações para uma seção específica. 



Retorno: 

resource 

Exceção: 



Package: 


Namespace: 

br\gov\icmbio\sial\util\ConfigAbstract 


Util 




@param mixed $config 


Exceção: 


public final function exists ($name) 

Página 

170 / 236 

Data 

04/02/2012 

Método que verifica a existência de um elemento registrado como índice.

utilizado. 




Retorno: 

• TRUE – Se o elemento estiver registrado como índice. 

• FALSE – Se o elemento não estiver registrado como índice. 

Exceção: 


public final function get ($name) 

Método que recupera o valor de um atributo de configuração. 


Retorno: 

string 

Exceção: 


public function section () 

Página 

171 / 236 

Data 

04/02/2012 

Recupera uma seção de valores de configuração de acordo com o ambiente 

Retorno: 

string 

Exceção: 


public abstract function isSuported ($config) 

Método que verifica se $config é suportado como arquivo de configuração. 


Retorno: 

• TRUE – Se o arquivo de configuração for válido 

• FALSE – Se o arquivo de configuração for inválido. 

Exceção: 


public function toArray () 

Método que converte um _resource em array.

ConfigIni 

Retorno: 

toArray 


Exceção: 


public function toJSon() 


Método que converte um array para representação Json. 

Retorno: 

mixed value in json 

Exceção: 



Package: 


Namespace: 

br\gov\icmbio\sial\util\ConfigIni 


Util 


específica. 



@param string $config 


Exceção: 


public final function load ($config, $section) 

Método que carrega as configurações de ambiente em uma seção 

Página 

172 / 236 

Data 

04/02/2012




Retorno: 

\br\gov\icmbio\sial\util\ConfigAbstract 


Exceção: 


public final function isSuported ($config) 

ConstantHandler 

Método que verifica se o arquivo de configuração é suportado. 


Página 

173 / 236 

Data 

04/02/2012 

Retorno: 

• TRUE – Caso o arquivo de configuração se válido. 

• FALSE – Caso o arquivo de configuração não exista ou seja inválido. 

Exceção: 


Componente que define o funcionamento das constantes no SIAL. 

Cada sistema terá um diretório nomeado de 'constant' que conterá um ou mais 

arquivos. 

O arquivo principal será criado com o nome do diretório base. 

Exemplo: Diretório base 'tools' então'(1)tools/(2)constant/(3)tools.php' 

onde, 

1 - Nome do diretório base; 

2 - Nome da pasta das constantes; 

3 - Nome do arquivo que contém as contantes gerais do sistema. 

Nota: Para minimizar o uso de recurso de memória, o SIAL sempre irá buscar por 

arquivos de constantes de mesmo nome do módulo de execução. 

Exemplo: Tomando como exemplo o sistema 'tools' que é composto de: 

/column 

/database 

/entity 

/schema 

/vom 

/wizard

onde, 


o modulo 'wizard' é carregado o SIAL tentará carregar o arquivo 

tools/constant/tools.php e tools/constant/wizard.php. 


Página 

174 / 236 

Data 

04/02/2012 

Dessa maneira permite-se fracionamento de constantes, carregando apenas o 

necessário. 

Regra: Para definição do nome da constante: 

1: 'SIAL' 

2: SISTEMA 

3: SUBSISTEMA 

4: FUNCIONALIDADE (se houver) 

5: CONSTANTE_NAME 

Definição: 

1: Define como constante do SIAL; 

2: Nome do sistema que deu origem a constante; 

3: Nome do subsistema; 

4: Nome da funcionalidade; 

5: Nome da constante. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\ConstantHandler 


Util 


principal. 

public function __construct (BootstrapAbstract $bootstrap) 

Método construtor responsável pela configuração do cache do sistema 

@param string BootstrapAbstract 

Exceção: 


public function get ($name, $shortname = TRUE) 

Método responsável por recuperar o valor de uma constante. Quando 

$shortname for TRUE, esse método se encarrega de montar o nome da constante de



Página 

175 / 236 

Data 

04/02/2012 

acordo com o sistema / subsistema / funcionalidade. Caso contrário será utilizado 

apenas o nome da constante. 


@param boolean $shortname 

Retorno: 

Mixed 

• O valor da constante informando seu nome completo ou; 

• NULL se a constante não tiver sido carregada posteriormente. 

Exceção: 


public function getByName ($fullname) 

Método que verifica se uma constante existe afim de retornar o valor 

atribuído a ela. 

@param string $fullname 

Retorno: 

string 

• Caso a constante exista, retorna o valor atribuído a ela. 

• Caso a constante não exista retorna NULL. 

Exceção: 


public function load ($fileContants) 

Método responsável por carregar um arquivo de constantes através de 

require_once. 

@param string $fileContants 

Retorno: 

Void 

Exceção: 


public function loadIfExists ($fileContants) 

Método semelhante a public function load ($fileContants), porém verifica 

se uma exceção foi lançada afim de suprimí-la. 

@param string $fileContants

Retorno: 

Void 



Exceção: 


public function loadModuleConstant ($namespace, $isModule = FALSE) 

Página 

176 / 236 

Data 

04/02/2012 

Método responsável por carregar através do namespace as constantes do 

sistema/subsistema/modulo. 


@param boolean $isModule 

Retorno: 

void 

Exceção: 


public function requestConstantAutoload () 

Método que realiza o auto carregamento do arquivo de constantes de 

acordo com o namespace da aplicação, configurado em application/config/config.ini. 

Retorno: 

void 

Exceção: 


public static function factory (BootstrapAbstract $bootstrap) 

ErrorHandler 

Método responsável por instanciar o bootstrap da aplicação. 

@param string $bootstrap 

Retorno: 


Exceção: 


Componente de manipulação de erros do SIAL. 

Package: 

br.gov.imcbio.sial.util

Namespace: 

br\gov\icmbio\sial\util\ErrorHandler 


Util 


public function setError () 



Página 

177 / 236 

Método construtor responsável por definir o manipulador de erros. 

Retorno: 

void 

Exceção: 


public function errorHandlerSial ($errNo, $errStr, $errFile, $errLine) 

Método responsável por tratar qualquer erro gerado na aplicação. 

@param integer $errNo 

@param string_type $errStr 

@param unknown_type $errFile 

@param unknown_type $errLine 

Retorno: 

ErrorHandler 

Exceção: 


public function getErroNumber () 

Método responsável por retornar o número do erro detectado. 

Retorno: 

integer 

Número do erro detectado. 

Exceção: 


public function getErroStr () 

Método responsável por retornar a descrição do erro 

Retorno: 

Data 

04/02/2012

Finder 

string 


Descrição do erro detectado. 

Exceção: 


Componente de registro de caminhos e padrões de pesquisa. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\Finder 


Util 


public function name ($pattern) 


Página 

178 / 236 

Data 

04/02/2012 

Método que registra um arquivo ou padrão – extensão a ser considerado 

em pesquisa. 

@param string $pattern 

Retorno: 

Finder 

Exceção: 


public function notName ($pattern) 

Ignora um arquivo ou padrão – extensão a ser considerado em pesquisa. 

@param string $pattern 

Retorno: 

void 

Exceção: 


Location 

public function in ($path) 


Ignora o registro de um caminho para pesquisa. 

@param string $path 

Retorno: 

void 

Exceção: 


public function notIn ($path) 

Ignora um caminho para pesquisa. 

@param string $path 

Retorno: 

void 

Exceção: 



Componente responsável pelo tratamento das localizações no SIAL. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\Location 


Util 


public static function hasNamespace ($namespace) 

Página 

179 / 236 

Data 

04/02/2012 

Método responsável pela verificação da existência de um namespace. 


Retorno: 

boolean 

• TRUE – Quando o namespace existir.


• FALSE – Quando o namespace não existir. 

Exceção: 


public static function hasClassInNamespace ($namespace) 


Página 

180 / 236 

Data 

04/02/2012 

Método responsável por verificar a existência de classe - arquivo com 

extensão .php, em um namespace. 


Retorno: 

boolean 

• TRUE – Quando o arquivo da classe existir. 

• FALSE – Quando o arquivo da classe não existir. 

Exceção: 


public static function realpathFromNamespace ($target) 

Método responsável por montar o caminho real de uma classe através do 

namespace informado. 

@param \br\gov\icmbio\sial\SIALAbstract | string $target 

Retorno: 

string 

ProtectionAbstract 

Exceção: 


Superclasse de abstração de proteção contra códigos maliciosos. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\ProtectionAbstract 


Util 



public abstract function encode ($content); 


Página 

181 / 236 

Data 

04/02/2012 

Método responsável por analisar um conteúdo e aplicar um conjunto de 

regras com a finalidade de proteger os dispositivos contra códigos maliciosos. 


Retorno: 

void 

Exceção: 


public abstract function decode ($content); 

Método responsável por desfazer o conjunto de regras aplicado no método 

encode, afim de recuperar o conteúdo original. 

Registry 


Retorno: 

void 

Exceção: 


Componente responsável por prover o repositório de elementos alcançáveis em 

qualquer camada da aplicação. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\Registry 


Util 


public static function get ($index) 

Método responsável por recuperar o conteúdo registrado por 

Registry::set(). 

@param string $index

Request 

Retorno: 

mixed 


Exceção: 


public static function isRegistered ($index) 


Método responsável por verificar se um valor está registrado. 

Obs.: Utiliza o método \Zend_Registry::isRegistered($index). 

@param string $index 

Retorno: 

boolean 

• TRUE – Se o valor estiver registrado. 

• FALSE – Se o valor não estiver registrado. 

Exceção: 


public static function set ($index, $value) 

Método que registra um novo elemento. 

Obs.: Utiliza o método \Zend_Registry::set($index, $value). 

@param string $index 


Retorno: 

void 

Exceção: 


Página 

182 / 236 

Data 

04/02/2012 

Componente responsável pela configuração e gerenciamento das requisições 

realizadas na aplicação. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\Request


Util 


requisição. 

public function clearParams ($scope) 



Método responsável por remover um escopo dos parâmetros de 

@param string $scope 

Retorno: 

void 

Exceção: 


public function isPost () 

Página 

183 / 236 

Data 

04/02/2012 

Método responsável por verificar se a requisição foi realizada por POST. 

Retorno: 

boolean 

• TRUE – Caso a requisição for realizada via POST. 

• FALSE – Caso a requisição não for realizada via POST. 

Exceção: 


public function isFile () 

Método responsável por verificar se a requisição foi realizada por um 

arquivo - $_FILES. 

Retorno: 

boolean 

• TRUE – Caso a requisição for realizada via arquivo. 

• FALSE – Caso a requisição não for realizada via arquivo. 

Exceção: 


public function isCookie () 

Método responsável por verificar se a requisição foi realizada por Cookie. 

Retorno:



boolean 

• TRUE – Caso a requisição for realizada via Cookie. 

• FALSE – Caso a requisição não for realizada via Cookie. 

Exceção: 


public function isGet () 

Página 

184 / 236 

Data 

04/02/2012 

Método responsável por verificar se a requisição foi realizada por GET. 

Retorno: 

boolean 

• TRUE – Caso a requisição for realizada via GET. 

• FALSE – Caso a requisição não for realizada via GET. 

Exceção: 


public function redirect ($url, $preservePostStantment = FALSE) 

Método responsável por redirecionar o fluxo de url preservando ou não os 

valores enviados via POST. 

TRUE); 

@param string $url 

@param boolean $preservePostStantment 

Retorno: 

Void 

• Se preservPostStantment for TRUE - header('HTTP/1.0 307 

Temporary redirect'); 

• Se preservPostStantment for FALSE - header('Location: {$url}'). 

Exceção: 


Exemplos: 

// Descarta $_POST 

Request::redirect('/system/module/action/paramname/paramvalue'); 

// Preserva $_POST 

Request::redirect('/system/module/action/paramname/paramvalue', 

public function getParam ($key, $scope = NULL) 

Método responsável por recuperar o conteúdo do índice chave informado -

$key. 



@param string ('get', 'post', 'cookie', 'files') $scope 

Retorno: 

• Mixed – se o índice chave existir. 

• NULL – se o índice chave não existir. 

Exceção: 


Exemplo: 

$this->request()->getParam('filter','post'); 

public function getParams ($scope = NULL) 

Retorna todos os parâmetros. 


Obs.: Quando o escopo não é informado são retornados todos os 

parâmetros de todos os escopos. 

módulo. 

@param string[] $scope 

Página 

185 / 236 

Data 

04/02/2012 

Retorno: 

• mixed[] – Se existir algum parâmetro independente de escopo. 

• NULL – Quando nenhum parâmetro existir. 

Exceção: 


Exemplo: 

$this->request()->getParams('post'); 

public function getModuleKey () 

Método que retorna a chave de identificação dos parâmetros de um 

Retorno: 

string 

Exceção: 


public function getFuncionalityKey () 

Método que retorna a chave de identificação dos parâmetros de uma 

funcionalidade.

action. 

Retorno: 

string 


Exceção: 


public function getActionKey () 


Página 

186 / 236 

Data 

04/02/2012 

Método que retornar a chave de identificação dos parâmetros de uma 

Retorno: 

string 

Exceção: 


public function getModule () 

Método que recupera os parâmetros de um módulo. 

Retorno: 

string 

Exceção: 


public function getFuncionality () 

Método que recupera os parâmetros de uma funcionalidade. 

Retorno: 

string 

Exceção: 


public function getAction ($wSuffix = FALSE) 

Método que recupera o nome da action que será executada. 

@param boolean $wSuffix 

Obs.: Quando $wSuffix for TRUE, o sufixo Action será removido. 

Retorno: 

string 

Exceção:



public function jQueryUnserialize ($scope = 'post') 


Método que cria uma representação de valor serializada em 

Jquery::serialize. 

Retorno: 

string[] 

Exceção: 


public function jQueryUnserializeArray ($scope = 'post') 

Método que cria uma representação de valor serializada em 

Jquery::serializeArray. 

Retorno: 

array 

Exceção: 


public function setParam ($key, $value, $scope = NULL) 

Página 

187 / 236 

Data 

04/02/2012 

Método responsável por atribuir valor a um parâmetro de acordo com a 

sua chave de identificação. 



@param string $method 

Retorno: 

\br\gov\icmbio\sial\util\Request 

Exceção: 


public function setParams (array $params, $scope = 'GET') 

Método que implementa Request::setParam para 'n' parâmetros. 

@param array $params 

@param string $scope 

Retorno: 


Exceção:




public function setModuleKey ($key) 

Página 

188 / 236 

Data 

04/02/2012 

Método responsável por atribuir a chave de identificação do módulo a um 

array de parâmetros. 


Retorno: 


Exceção: 


public function setFuncionalityKey ($key) 

Método responsável por atribuir a chave de identificação do módulo a uma 

funcionalidade. 

action. 


Retorno: 


Exceção: 


public function setActionKey ($key) 

Método responsável por atribuir a chave de identificação do módulo a uma 


Retorno: 


Exceção: 


public function setModule ($module) 

Método responsável por configurar o nome do módulo. 

@param string $module 

Retorno: 

\br\gov\icmbio\sial\util\Request



Exceção: 


public function setFuncionality ($funcionality) 

Página 

189 / 236 

Data 

04/02/2012 

Método responsável por configurar o nome de uma funcionalidade. 

@param string $funcionality 

Retorno: 


Exceção: 


public function setAction ($action) 

Método responsável por configurar o nome de uma action. 

@param string $action 

Retorno: 


Exceção: 


Exemplos: 

Request::setAction('add'); 

Request::getAction(); 

// Output: (string) addAction 

public static function isValidMethod ($method) 

Método responsável por verificar se um método informado é válido. 


Retorno: 

String 

Exceção: 


public static function isValidKey ($key) 

Método responsável por verificar se uma chave de identificação é valida. 

@param string $key

Retorno: 

String 



Exceção: 


public static function defaultStorageParam ($name = NULL) 

Página 

190 / 236 

Data 

04/02/2012 

Método responsável por definir e retornar o armazenamento padrão para 

os parâmetros. 

Session 

Retorno: 

String 

Exceção: 



Método responsável por criar e retornar um objeto Request. 

Retorno: 


Exceção: 


Componente responsável pelo gerenciamento de sessão na aplicação. 

Package: 


Namespace: 

br\gov\icmbio\sial\util\Session 


Util 


private function __construct ($sessName, $namespace, $lifeTime = NULL, 

$security = FALSE, $httpOnly = TRUE) 

Método construtor responsável por registrar o nome da sessão, iniciar a 

sessão e iniciar os parâmetros de sessão para cookie. 

@param string $sessName



@param integer $lifeTime 

@param boolean $security 

@param boolean $httpOnly 

Exceção: 


public function set($key, $value) 

Método responsável por registrar conteúdo em sessão. 



Retorno: 

\br\gov\icmbio\sial\util\Session 

Exceção: 


public function get ($key) 


Página 

191 / 236 

Método responsável por recuperar conteúdo registrado em sessão. 


Retorno: 

mixed 

Exceção: 


public function regenerationIdent () 

Método que gera uma nova identificação para a sessão. 

Retorno: 

mixed 

Exceção: 


public function destroy () 

Método responsável por destruir a sessão. 

Retorno: 

void 

Data 

04/02/2012


Exceção: 



Página 

192 / 236 

Data 

04/02/2012 

public static function start ($namespace = NULL, $lifeTime = NULL, $security = 

FALSE, $httpOnly = TRUE) 

Método responsável por iniciar uma nova sessão. 


@param integer $lifeTime 

@param boolean $security 

@param boolean $httpOnly 

Retorno: 

\br\gov\icmbio\sial\util\Session 

Exceção: 


br\gov\icmbio\sial\util\client 

JQuery 

Componente responsável pelo tratamento de conteúdo para elementos de arrays 

ou strings 

Package: 

br.gov.imcbio.sial.util.client 

Namespace: 

br\gov\icmbio\sial\util\client\JQuery 


View 


public function serialize ($content) 

Método responsável por gerar uma representação de valor para um 

conteúdo informado. 

@param array $element 

Retorno: 

string


Exceção: 


public function unserialize ($content) 


Página 

193 / 236 

Data 

04/02/2012 

Método responsável por gerar um conteúdo através de uma representação 

de valor armazenada. 

@param string 

Retorno: 

string[] 

Exceção: 


public function unserializeArray ($content) 

Método responsável por gerar um conteúdo através de uma representação 

de valor armazenada em array. 

@param array 

Retorno: 

array 

Exceção: 



Método responsável por criar e retornar um objeto JQuery. 

Retorno: 

\br\gov\icmbio\sial\util\client\JQuery 

Exceção: 


br\gov\icmbio\sial\util\file 

Folder 

Componente responsável pela gestão da estrutura de arquivos de persistência. 

Package: 

br.gov.imcbio.sial.util.file

Namespace: 

br\gov\icmbio\sial\util\file\Folder 


View 



public function createFolderStructure ($source) 


Página 

194 / 236 

Data 

04/02/2012 

Método que realiza checagem da estrutura de persistência de arquivos. 

@param 

br\gov\icmbio\sisicmbio\application\james\folder\valueObject\FolderValueObject 

$voFolder 

James 

Retorno: 

string 

Exceção: 


public function permission () 

Método responsável por retornar a permissão das pastas a serem criadas. 

Retorno: 

string 

Exceção: 



Método responsável por criar e retornar um objeto Folder. 

Retorno: 

\br\gov\icmbio\sial\util\file\Folder 

Exceção: 


Componente responsável pela gestão de arquivos de persistência. 

Package: 

br.gov.imcbio.sial.util.file

Namespace: 

br\gov\icmbio\sial\util\file\James 


View 



public function __construct (ValueObjectAbstract $voFile) 


Página 

195 / 236 

Data 

04/02/2012 

Método construtor responsável por verificar se um ValueObject é uma 

instância válida de \br\gov\icmbio\sial\lang\TFile. 

@param ValueObjectAbstract $voFile 

Exceção: 


public function filePersist () 

Método que efetua a persistência de arquivo. 

@param FileValueObject $voFile 

Retorno: 

ValueObjectAbstract 

Exceção: 


public function fileDownloadRecover () 

Método responsável por retornar o diretório para efetuar o download do 

arquivo em persistência. 

Obs.: Esse método deverá ser utilizado através de Helper. 

Retorno: 


Exceção: 


public function factory (ValueObjectAbstract $voFile) 

Método responsável por criar e retornar um objeto James. 

Retorno: 

\br\gov\icmbio\sial\util\file\James

Tamburete 


Exceção: 



Componente responsável pela persistência de arquivos em XML. 

Package: 

br.gov.imcbio.sial.util.file 

Namespace: 

br\gov\icmbio\sial\util\file\Tamburete 


Persist 


Página 

196 / 236 

Data 

04/02/2012 

public function __construct (ValueObjectAbstract $valueObject, $pathLeaf = 

NULL, $upload = NULL) 


Recupera a relação dos campos a realizar o log de auditoria e a relação dos 

atributos do VO. 


@param string $pathLeaf 

@param boolean $upload 

Exceção: 


protected function createStruct () 

Método responsável por criar a estrutura XML de atributos de um 

ValueObject. 

Retorno: 

string 

Exceção: 


protected function createContent () 

Método responsável por persistir os valores atuais dos atributos de um 

ValueObject.

Retorno: 

string 


Exceção: 


protected function createLogAll () 


Página 

197 / 236 

Data 

04/02/2012 

Método responsável por persistir o log de todos os atributos de um 

ValueObject. 

Retorno: 

string 

Exceção: 


protected function createLogByAttr () 

Método responsável por persistir o log apenas dos atributos informados 

no ValueObject. 

Retorno: 

string 

Exceção: 


protected function createLeaf () 

Método responsável por gerar o conteúdo XML para persistência de 

arquivos submetidos via upload. 

Retorno: 

string 

Exceção: 


public function save () 

Método responsável por persistir arquivos em XML. 

Obs.: Para gerar a persistência do log de auditoria para o ValueObject, 

deve-se informar na anotação do mesmo da seguinte maneira: 

• @log(name="all") – Para registrar em log todos os atributos do 

ValueObject; 

• @log(name="foo, bar") – Para registrar em log apenas os atributos

Retorno: 

\stdClass 


foo e bar do ValueObject; 

Exceção: 


public function update ($content) 


Página 

198 / 236 

Data 

04/02/2012 

Método que atualiza os valores do conteúdo dos atributos do ValueObject 

registra o log de auditoria quando necessário. 

XML. 

Retorno: 

\stdClass 

Exceção: 


public function delete ($content) 

Método que reseta os valores da estrutura de persistência de arquivo em 

Retorno: 

\stdClass 

Exceção: 


public function find () 

Método que realiza a busca pelas referências de persistência em um 

arquivo XML. 

Retorno: 

\stdClass 

Exceção: 


Bibliotecas externas ao SIAL 

FPDF 

FPDF is a PHP class which allows to generate PDF files with pure PHP.

Documentação: 

http://www.fpdf.org/en/doc/index.php 

ClassLoader 



Página 

199 / 236 

Data 

04/02/2012 

SplClassLoader implementation that implements the technical interoperability 

standards for PHP 5.3 namespaces and class names. 

Documentação: 

https://github.com/Graphity/graphitycore/blob/master/src/main/php/Graphity/Loader.php 

Exemplo: 

$classLoader = new SplClassLoader('Doctrine\Common', '/path/to/doctrine'); 

$classLoader->register(); 

br\gov\icmbio\sial\util\mail 

Mail 

Componente utilitário de e-mail. 

Package: 

br.gov.imcbio.sial.util.mail 

Namespace: 

br\gov\icmbio\sial\util\mail\Mail 


View 


public function __construct (\br\gov\icmbio\sial\util\ConfigAbstract $config) 

Método construtor que valida as configurações de 

\br\gov\icmbio\sial\util\ConfigAbstract e as aplica no objeto mail. 

Exceção: 


public function addAttachment ($attachment, $name = NULL) 

Método responsável por anexar arquivos ao e-mail. 

Obs.: O parâmetro $name é utilizado para substituir o nome de exibição do

arquivo anexado. 


Retorno: 

\br\gov\icmbio\sial\util\mail\Mail 

Exceção: 


public function addBCC ($email, $name = NULL) 


Método para adicionar destinatário em cópia oculta no e-mail. 

@param string $email 


Retorno: 


Exceção: 


public function addAddress ($email, $name = NULL) 

Método que adiciona um destinatário ao e-mail. 

@param string $address 


Retorno: 


Exceção: 


public function addCC ($email, $name = NULL) 

Método que adiciona um destinatário a cópia do e-mail. 

@param string $address 


Retorno: 


Exceção: 


public function addReplyTo ($email, $name = NULL) 

Página 

200 / 236 

Data 

04/02/2012 

Método que configura uma conta de e-mail para receber a resposta do e-

mail. 




Retorno: 


Exceção: 


public function alternativeBody ($alternativeBody) 


Página 

201 / 236 

Data 

04/02/2012 

Método que fornece a alternativa de adição de outro corpo ao e-mail. 

Retorno: 


Exceção: 


public function body ($body, $altBody = NULL) 

Método que define o corpo da mensagem do e-mail. 

@param string $body 

@param string $altBody 

Retorno: 


Exceção: 


public function charSet ($charSet) 

Método que define o charset a ser utilizado no conteúdo do e-mail. 

@param string $charSet 

Retorno: 


Exceção: 


public function contentType ($contentType) 

Método que define o tipo de conteúdo na mensagem do e-mail.

eletrônica. 


@param string $contentType 

Retorno: 


Exceção: 


public function encoding ($encoder) 


Método que define o tipo de codificação da mensagem do e-mail. 

@param string $encoder 

Retorno: 


Exceção: 

\br\gov\icmbio\sial\util\mail\exception\MailException 

public function from ($email, $name= NULL) 

Método que configura a conta de e-mail para envio da mensagem 



Retorno: 


Exceção: 


public function port ($port) 

Método que configura a porta de saída SMPT. 

@param integer $port 

Retorno: 


Exceção: 


public function priority ($priority) 

Método que define a prioridade da mensagem eletrônica. 

Página 

202 / 236 

Data 

04/02/2012


@param string (high | normal | low) 

Retorno: 


Exceção: 


public function replyTo ($email, $name = NULL) 


Método que configura a conta de e-mail para receber as respostas 

vinculadas a mensagem eletrônica. 



Retorno: 


Exceção: 


public function send () 

Método responsável por enviar a mensagem eletrônica. 

Retorno: 


Exceção: 

\br\gov\icmbio\sial\util\mail\exception\MailException 

public function sender (array $config = array()) 

Método que configura o transmissor da mensagem eletrônica. 


Retorno: 


Exceção: 

\br\gov\icmbio\sial\util\mail\exception\IllegalArgumentException 

public function senderSmtp (array $config = array()) 

Página 

203 / 236 

Data 

04/02/2012 

Método que configura o transmissor SMPT da mensagem eletrônica. 

@param string[] $config


Retorno: 


Exceção: 

\br\gov\icmbio\sial\util\mail\exception\SIALException 

public function subject ($subject) 

Método que define o título da mensagem eletrônica. 

@param string $subject 

Retorno: 


Exceção: 


public function to ($email, $name = NULL) 


Método que define o destinatário da mensagem eletrônica. 



Retorno: 


Exceção: 


public function wordWrap ($maxLen) 

Página 

204 / 236 

Data 

04/02/2012 

Método responsável por limitar a quantidade de caracteres por linha na 

mensagem eletrônica. 

@param integer $maxLen 

Retorno: 


Exceção: 

\br\gov\icmbio\sial\util\mail\exception\SIALException

\gov\icmbio\sial\util\mask 

Cpf 



Componente responsável por aplicar e remover a máscara de CPF. 

Package: 

br.gov.imcbio.sial.util.mask 

Namespace: 

br\gov\icmbio\sial\util\mask\Cpf 


View 


Cpf. 

conteúdo. 

Mask 

public function __construct ($content = NULL) 

Página 

205 / 236 

Data 

04/02/2012 

Método construtor. Define a máscara a ser aplicada para formatação do 


Exceção: 


public static function remove ($content) 

Método responsável por remover a formatação aplicada para um 

@var string 

Retorno: 

string 

Exceção: 


Componente responsável por aplicar e remover a máscara customizada. 

Package: 

br.gov.imcbio.sial.util.mask

Namespace: 

br\gov\icmbio\sial\util\mask\Mask 


View 





Página 

206 / 236 

Data 

04/02/2012 

Método construtor. Registra namespace no repositório de máscaras. 

Exceção: 


public function apply () 

Método responsável por aplicar uma máscara customizada. 

Retorno: 

string 

Exceção: 


public abstract static function remove ($content); 

Método responsável por remover uma máscara customizada. 

@param mixed 

Retorno: 

string 

Exceção: 


public function registerRepo ($namespace) 

Método que registra o namespace no repositório de máscaras. 


Retorno: 

void 

Exceção: 

\br\gov\icmbio\sial\util\mail\exception\SIALException

\gov\icmbio\sial\util\pdf 

Mask 



Componente utilitário para manipulação de arquivos em pdf utilizando a 

biblioteca FPDF. 

Package: 

br.gov.imcbio.sial.util.pdf 

Namespace: 

br\gov\icmbio\sial\util\pdf\Pdf 


View 


public function __construct ($orientation = 'P', $unit = 'mm', $size = 'A4') 

Página 

207 / 236 

Data 

04/02/2012 

Método construtor. Cria o documento pdf customizando orientação, 

medida e tamanho do papel. 

pdf. 

@param string $orientation 

@param string $unit 

@param strin mixed $size 

Exceção: 


Exemplo: 

 

# Cria o documento no tamanho A4 

$pdf = new Pdf('P', 'mm', 'A4'); 

public function addPage ($orientation = NULL, $size = NULL) 

Método responsável por adicionar uma nova página a um documento em 

@param string $orientation 

@param int $size

$this. 


Retorno: 

\br\gov\icmbio\sial\util\pdf\Pdf 

Exceção: 

\br\gov\icmbio\sial\exception\SialException 


public function addFont ($family, $style = NULL, $file = NULL) 

Página 

208 / 236 

Data 

04/02/2012 

Método responsável pela importação de fonte tipográfica ao documento. 

@param string $family 

@param string $style 

@param string $file 

Retorno: 


Exceção: 


public function header () 

Método que renderiza o cabeçalho do documento. 

Obs.: Esse método deverá ser reescrito em uma subclasse retornando 

Retorno: 


Exceção: 


Exemplo: 

$this. 

?> 

public function footer () 

} 

} 


$this->ln(20); 

return $this; 

Método que renderiza o rodapé do documento. 


Página 

209 / 236 

Data 

04/02/2012 

Obs.: Esse método deverá ser reescrito em uma subclasse retornando 

Retorno: 


Exceção: 


Exemplo: 

 

# define uma nova classe baseando-se na em util\Pdf; 

class MyPdf extends Pdf 

{ 

public function footer () 

{ 

# define a posicao do rodape 

$this->setY(-15); 

} 

return $this; 

} 

# define a fonte que sera utilizada no rodape 

$this->setFont('Arial', 'I', 8); 

# imprime o numero da pagina ao centro 

$this->cell(0, 10, 'Pagina # ' . $this->pageNo(), 0, 0, 'C'); 

public function image ($filename, $posX = NULL, $posY = NULL, $width = 0, 

$height = 0, $type = NULL) 

Método que adiciona uma imagem ao documento.

@param string $filename 

@param float $posX 

@param float $posY 

@param float $width 

@param float $height 



Formatos suportados: 

• JPEG 

◦ gray scales 

◦ true color (24 bits) 

◦ CMYK (32 bits) 

• PNG 

◦ gray scales, 8 bits (256 levels) 

◦ indexed colors 

◦ true colors (24 bits) 

• GIF 

◦ A extensão GD é requerida ao usar esse tipo. 

A transparência de imagem é suportada. 

Retorno: 


Exceção: 


Exemplo: 

$pdf->image('logo.png', 10, 10, -300); 


public function line ($posXOne, $posYOne, $postXTwo, $postYTwo) 

Método que desenha uma linha entre dois pontos. 

@param float $posXOne 

@param float $posYOne 

@param float $postXTwo 

@param float $postYTwo 

Retorno: 


Exceção: 


Página 

210 / 236 

Data 

04/02/2012

Pdf::open(). 

hyperlink. 


public function outPut ($name = '', $destination = '') 


Página 

211 / 236 

Método responsável por enviar ao cliente o documento pdf pronto. 

@param type $name 

@param type $destination 

Retorno: 


Exceção: 


public function open () 

Método responsável por abrir o documento pdf. 

Retorno: 


Exceção: 


public function close () 

Data 

04/02/2012 

Método responsável por fechar o documento pdf aberto pelo método 

Retorno: 


Exceção: 


public function write ($text = '', $link = '') 

Método que adiciona um texto ao documento, opcionalmente como 

@param string $text 

@param string $link 

Retorno: 


Exceção: 

\br\gov\icmbio\sial\exception\SialException


public function writeHTML ($html, $align = 'C') 


Método que adiciona um conteúdo em HTML ao documento. 

@param string $html 

@param string $align (C => center | L => left | R => right) 

Retorno: 


Exceção: 


public function text ($posX, $posY, $text) 

Método que posiciona um texto no documento. 

@param int $posX 

@param int $posY 


Retorno: 


Exceção: 


Página 

212 / 236 

Data 

04/02/2012 

public function cell ($width, $height = 0 , $text = NULL, $border = 0, $ln = 0, 

$align = 'L', $fill = FALSE, $link = NULL) 

Método que desenha uma célula no documento. 




@param mixed $border 

@param integer $ln 

@param string $align 

@param boolean $fiil 

@param mixed $link 

Retorno: 


Exceção: 


documento. 

documento. 


public function setFont ($family, $style = '', $size = 0) 


Página 

213 / 236 

Data 

04/02/2012 

Método responsável por definir a fonte tipográfica a ser utilizada no 

@param string $family 


@param float $size 

Retorno: 


Exceção: 


Exemplo: 

 

// Arial bold 14 

$pdf->setFont('Arial','B',14); 

// Removes bold 

$pdf->setFont(''); 

// Times bold, italic and underlined 14 

$pdf->setFont('Times','BIU'); 

public function setFontSize ($size) 

Método que configura o tamanho em points da fonte tipográfica do 

@param float $size 

Retorno: 


Exceção: 


public function setMargins ($left, $top, $right = NULL) 

Método que configura as margens do documento. 

@param int $left 

@param int $top

@param int $right 


Retorno: 


Exceção: 


function Ln($h=null) 


Método que implementa a quebra de linha no documento. 

@param float $heigthBreak 

Retorno: 


Exceção: 


public function setTopMargin ($margin) 

Método que configura a margem para o topo do documento. 

@param float $margin 

Retorno: 


Exceção: 


public function setLeftMargin ($margin) 

Método que configura a margem para a esquerda do documento. 


Retorno: 


Exceção: 


public function getX () 

Método que retorna a abscissa. 

Retorno: 

float 

Página 

214 / 236 

Data 

04/02/2012


Exceção: 


public function getY () 

Método que retorna a ordenada. 

Retorno: 

float 

Exceção: 


public function setAuthor ($author) 

Método que define o autor do documento. 

@param string $author 

Retorno: 


Exceção: 



public function setAutoPageBreak ($enableMode, $margin = 2.0) 

Página 

215 / 236 

Data 

04/02/2012 

Método que configura a quebra automática de linha no documento. 

@param boolean $enableMode 


Retorno: 


Exceção: 


public function setCreator ($creator) 

Método que define o criador do documento. 

@param string $creator 

Retorno: 


Exceção: 


public function setY ($posY) 



Página 

216 / 236 

Data 

04/02/2012 

Método que posiciona o cursor no plano cartesiano y do documento. 


Retorno: 


Exceção: 


public function setX ($posX) 

Método que posiciona o cursor no plano cartesiano x do documento. 


Retorno: 


Exceção: 


public function setRightMargin ($margin) 

Método que define a margem a direita do documento. 


Retorno: 


Exceção: 


public function setTitle ($title) 

Método que define o título do documento. 

@param string $title 

Retorno: 


Exceção: 




public function rect ($posX, $posY, $width, $height, $style = NULL) 

Método que desenha um retângulo no documento. 






Retorno: 


Exceção: 


public function setDrawColor ($r, $g, $b) 

Página 

217 / 236 

Data 

04/02/2012 

Método que define cor no padrão RGB para um elemento do documento. 

@param integer $r 

@param integer $g 

@param integer $b 

Retorno: 


Exceção: 


public function setFillColor ($r, $g, $b) 

Método que define a cor de preenchimento no padrão RGB para um 

elemento do documento. 




Retorno: 


Exceção: 


public function setTextColor ($r, $g = 0, $b = 0) 

Método que define a cor de texto no padrão RGB para um elemento do 

documento.





Retorno: 


Exceção: 


public function getStringWidth ($text) 


Página 

218 / 236 

Data 

04/02/2012 

Método que retorna o comprimento de uma string de acordo com a fonte 

aplicada no documento. 


Retorno: 

integer 

Exceção: 


public function setLineWidth ($width) 

Método que define o comprimento de uma linha. 


Retorno: 


Exceção: 


public function multiCell ($width, $height, $text, $border = 0, $align = 'J', $fill = 

FALSE) 

Método que cria células no documento. 




@param integer $border 

@param char $align 

@param boolean $fill 

Retorno:



Exceção: 


public function pageNo () 


Método que retorna o número da página corrente do documento. 

Retorno: 

integer 

Exceção: 


public function onError ($message) 

Página 

219 / 236 

Data 

04/02/2012 

Método que exibe mensagem customizada de erro sempre que ocorrer um 

erro ao gerar o documento. 

Obs.: A chamada desse método interrompe a execução do script com a 

função die(). 

@param string $message 

Retorno: 

void 

br\gov\icmbio\sial\util\stack 

FIFO 

Componente manipulador de filas. 

Package: 

br.gov.imcbio.sial.util.stack 

Namespace: 

br\gov\icmbio\sial\util\stack\FIFO 


Model 

Controller 

Business 

View 


public function peek () 


Método que identifica o próximo elemento da fila. 

Retorno: 

mixed 

Exceção: 


public function pop () 


Método que desloca o elemento atual e adiciona o próximo. 

@var mixed[] 

Retorno: 

• Sucesso – array; 

• Falha – NULL para array vazio ou array inválido. 

Exceção: 


public function push ($element) 

Método que insere um elemento na frente da fila. 

@param mixed[] $element 

Retorno: 

\br\gov\icmbio\sial\util\stack\FIFO 

Exceção: 


public function flush() 

Método que remove todos os elementos da fila. 

Retorno: 


Exceção: 


public function hasNext () 

Método que verifica a existência de um próximo elemento. 

Retorno: 

Página 

220 / 236 

Data 

04/02/2012


• TRUE – Caso exista o próximo elemento. 

• FALSE – Caso não exista o próximo elemento. 

Exceção: 


public function isEmpty () 

Método que verifica se a fila está vazia. 

Obs.: Utiliza a função empty() - 

http://br.php.net/manual/en/function.empty.php. 

Stack 

Retorno: 

• TRUE – Caso a fila esteja vazia. 

• FALSE – Caso a fila não esteja vazia. 

Exceção: 


public function init (array $elements = array()) 

Método que inicializa a fila. 

@param mixed[] $elements 

Retorno: 


Exceção: 



Fábrica de filas. 

Retorno: 


Exceção: 


Componente manipulador de pilhas. 

Package: 

br.gov.imcbio.sial.util.stack 


Página 

221 / 236 

Data 

04/02/2012

Namespace: 

br\gov\icmbio\sial\util\stack\Stack 


Model 

Controller 

Business 

View 


public abstract function peek (); 


Método que identifica o próximo elemento da pilha. 

Retorno: 

mixed 

Exceção: 


public function pop () 


Página 

222 / 236 

Data 

04/02/2012 

Método que desloca o elemento atual da pilha e adiciona o próximo. 

@var mixed 

Retorno: 

• Sucesso – array; 

• Falha – NULL para array vazio ou array inválido. 

Exceção: 


public function push ($element) 

Método que insere um elemento na frente da pilha. 

@param mixed[] $element 

Retorno: 

\br\gov\icmbio\sial\util\stack\Stack 

Exceção: 


public function flush() 


Método que remove todos os elementos da pilha. 

Retorno: 


Exceção: 


public function hasNext () 


Página 

223 / 236 

Método que verifica a existência de um próximo elemento na pilha. 

Retorno: 

• TRUE – Caso exista o próximo elemento. 

• FALSE – Caso não exista o próximo elemento. 

Exceção: 



Método que verifica se a pilha está vazia. 

Obs.: Utiliza a função empty() - 

http://br.php.net/manual/en/function.empty.php. 

Retorno: 

• TRUE – Caso a pilha esteja vazia. 

• FALSE – Caso a pilha não esteja vazia. 

Exceção: 


public function init (array $elements = array()) 

Método que inicializa a fila. 

@param mixed[] $elements 

Retorno: 


Exceção: 


Data 

04/02/2012


br\gov\icmbio\sial\valueObject 


Superclasse da camada de abstração de transporte de dados 

Package: 

br.gov.imcbio.sial.valueObject 

Namespace: 



Model 

Controller 

Business 

View 

Persist 




Página 

224 / 236 

Método construtor. Cria o objeto de transporte de dados em cache. 

Exceção: 


public final function annotation () 

Método responsável por definir as anotações do objeto abstrato. 

Retorno: 

\br\gov\icmbio\sial\util\Annotation 

Exceção: 


public final function loadData ($data = array()) 

Data 

04/02/2012 

Método que carrega os dados do VO, de acordo com um array de dados. 


Obs.: Por definição, o nome de cada índice do array deve ser idêntico ao 

seu respectivo método de acesso, sem o prefixo set. 

Exemplo: array(“foo”.... ) corresponde a setFoo().



Retorno: 

\br\gov\icmbio\sial\util\valueObject\ValueObjectAbstract 

Exceção: 


public final function hasMethod ($method, array $prefixes = array()) 

Página 

225 / 236 

Data 

04/02/2012 

Verifica a existência de um método em toda a hierarquia de classes. 


@param string[] $prefixes 

Retorno: 

string 

• Sucesso – Retorna o nome do método acrescido do prefixo. 

• Falha – Retorna uma string vazia. 

Exceção: 


public function toArray () 

Método responsável por converter os dados do ValueObject em um array. 

Obs.: Para definição de chave, será utilizada a annotation('name'). 

Retorno: 

string[] 

Exceção: 



Método que verifica se um ValueObject é vazio. 

Obs.: Serão avaliados apenas os atributos do ValueObject com attr 

detectável pela annotation. 

Retorno: 

boolean 

• TRUE – Caso todos os atributos sejam NULL; 

• FALSE – Caso algum atributo não seja NULL. 

Exceção: 


public function toJson () 


Método que retorna valor em anotação JSON. 

Retorno: 

string 

Exceção: 


public function toXml () 

Método que retorna o dado convertido em XML. 

Retorno: 

string 

Exceção: 


public static function factory ($namespace, $data = NULL) 

Fábrica de ValueObjectAbstract. 

@param [string | Model] $namespace 

@param stdClass $data 

Retorno: 

string[] 

Exceção: 


public function hash () 

Método que calcula o hash para o ValueObject. 


Retorno: 

string 

• Representação JSON de um valor com hash de md5() - 

http://php.net/manual/en/function.md5.php 

Exceção: 


public function __toString() 

Método que retorna ValueObjectAbstract::toJson. 

Retorno: 

Página 

226 / 236 

Data 

04/02/2012

string 


Exceção: 



br\gov\icmbio\sial\valueObject\exception 

ValueObjectException 

Componente para o tratamento de erros de ValueObject. 

Package: 

br.gov.imcbio.sial.valueObject.exception 

Namespace: 

br\gov\icmbio\sial\valueObject\exception\ValueObjectException 


Model 

Controller 

Business 

View 

Persist 


Página 

227 / 236 

Data 

04/02/2012 


NULL) 

Método construtor. Trata da mensagem de erro. 

@param message [optional] 

@param code [optional] 

@param previous [optional] 

Exceções: 


public static function valueObjectNotImplemented ($valueObject) 

Método que verifica a existência de um ValueObject. 

@param string $valueObject 

Retorno: 

br\gov\icmbio\sial\valueObject\exception\ValueObjectException


Exceções: 


br\gov\icmbio\sial 

BootstrapAbstract 

Superclasse de bootstrap. 

Package: 

br.gov.imcbio.sial 

Namespace: 

br\gov\icmbio\sial\BootstrapAbstract 


Controller 


public function __construct (ConfigAbstract $config) 


Método construtor. Carrega as configurações do bootstrap. 

@param \br\gov\icmbio\sial\util\ConfigAbstract $config 

Exceção: 


public abstract function run () 

Método que executa a aplicação. 

Retorno: 

void 

Exceção: 


public abstract function persistLog (PersistLogAbstract $persistLog) 

Método responsável por registrar a classe de log de persistência. 

Página 

228 / 236 

Data 

04/02/2012 

@param br\gov\icmbio\sial\persist\PersistLogAbstract $persistLog 

Retorno: 

\br\gov\icmbio\sial\BootstrapAbstract


Exceção: 


public function config ($key = NULL) 


Método que recupera a configuração definida por Config. 


Página 

229 / 236 

Data 

04/02/2012 

Retorno: 

mixed 

• Caso não seja informado uma chave - $key, será retornado o objeto 

de configuração. 

Exceção: 


public function request () 

Método que recupera a requisição em br\gov\icmbio\sial\util\Request. 

Retorno: 


Exceção: 


public function getModule () 

Método que recupera o módulo da requisição. 

Retorno: 

string 

Exceção: 


public function getFuncionality () 

Método que recupera a funcionalidade da requisição. 

Retorno: 

string 

Exceção: 


$key. 

public function getAction () 



Método que recupera o nome da action a ser executada. 

Retorno: 

string 

Exceção: 


public function getParam ($key, $scope = NULL) 

Página 

230 / 236 

Data 

04/02/2012 

Método responsável por recuperar o conteúdo do índice chave informado - 


@param string ('get', 'post', 'cookie', 'files') $scope 

Retorno: 

• Mixed – se o índice chave existir. 

• NULL – se o índice chave não existir. 

Exceção: 


Exemplo: 

$this->request()->getParam('filter','post'); 

public function getParams ($scope = NULL) 

Retorna todos os parâmetros. 

Obs.: Quando o escopo não é informado são retornados todos os 

parâmetros de todos os escopos. 

@param string[] $scope 

Retorno: 

• mixed[] – Se existir algum parâmetro independente de escopo. 

• NULL – Quando nenhum parâmetro existir. 

Exceção: 


Exemplo: 

$this->request()->getParams('post');

informada. 

completo. 

Factorable 


public function constant ($name, $shortname = TRUE) 


Página 

231 / 236 

Data 

04/02/2012 

Método que retorna o conteúdo da constante do SIAL – ConstantHandler, 

Obs.: Ao informar $shortname a classe se encarregará de montar o nome 

Retorno: 

mixed 

Exceção: 


public function constantHandler () 

Método que retorna instância do gerenciador de constantes. 

Retorno: 


public static function setupEnvironment (\br\gov\icmbio\sial\util\ConfigAbstract 

$config) 

Interface 

Método que configura o ambiente. 

Retorno: 

void 

Package: 


Exceção: 


Namespace: 

br\gov\icmbio\sial\Factorable 


View 


Version 

public static function factory() 



Retorna uma instância da classe que implementa este método. 

Retorno: 

\br\gov\icmbio\sial\SIALAbstract 

Componente que recupera a versão instalada do SIAL 

Package: 


Namespace: 

br\gov\icmbio\sial\Version 


Todas 


SialAbstract 

public static function get () 

Método que recupera a versão instalada do SIAL. 

Retorno: 

string 

Exemplo: 

 

Página 

232 / 236 

Data 

04/02/2012 

Superclasse da Camada de Abstracao do SisICMBio (SIAL - SISICMBio Abstract 

Layer) 

Package: 


Namespace: 

br\gov\icmbio\sial\SialAbstract 


Todas


public final function __get ($name) 



Página 

233 / 236 

Data 

04/02/2012 

Método que sobrescreve o método magico do php que obtém o valor de 

um atributo privado, não permitindo a sua utilização. 


Retorno: 

void 

Exceção: 


public final function __set ($name, $value) 





Retorno: 

void 

Exceção: 


public function __call($name, $arguments) 




@param mixed $arguments 

Retorno: 

void 

Exceção: 



Método que retorna o nome da classe de um objeto. 

Obs.: get_class() - http://www.php.net/manual/en/function.get-class.php 

Retorno:

string 


public function getClassName (self $sial = NULL) 

Método que retorna o nome da classe de um objeto. 

@param \br\gov\icmbio\sial\SIALAbstract $sial 

Retorno: 

string 

public function hasMethod ($method) 

Verifica se um método existe na classe atual. 


Retorno: 

boolean 

• TRUE – Caso o método exista. 

• FALSE – Caso o método não exista. 

public static function realpathFromNamespace ($target) 


Página 

234 / 236 

Data 

04/02/2012 

Método que retorna o caminho completo da classe filha de SialAbstract. 

@param \br\gov\icmbio\sial\SIALAbstract | string $target 

Retorno: 

string 

Exceção: 


public final function toggle ($fParam, $sParam) 

Método que retorna o segundo argumento caso o primeiro seja FALSE. 

@param mixed $fParam 

@param mixed $sParam 

Retorno: 

mixed 

Exceção: 


Exemplo: 

termo. 

?> 


SialAbstract::toggle(false, true); // output: true 

public function erReplace (array $patterns, $subject) 


Página 

235 / 236 

Data 

04/02/2012 

Método que realiza a troca do primeiro termo em uma string pelo segundo 

@param string[] $pattern 

Retorno: 

string 

Exceção: 


Exemplo: 

 

public static function getIfDefined($container, $el) 

Método que verifica se um container é válido e retorna o seu valor. 

@param \br\gov\icmbio\sial\SIALAbstract $object 

@param [object|array] $container 

Retorno: 

mixed 

• mixed – Caso seja um container válido; 

• NULL – Caso a propriedade não exista ou se não for acessível.


Exceção: 



public static function has ($container, $el, $equalsTo = NULL) 

Método que verifica se um elemento existe em um container. 

Página 

236 / 236 

Data 

04/02/2012 

Retorno: 

boolean 

• TRUE – Se elemento existir no container. 

• FALSE – Se o elemento não existir no container ou se não atender ao 

critério de equivalência quando informado o terceiro argumento - 

$equalsTo. 

Exceção:

Instituto Chico Mendes Manual dos componentes do SIAL - ICMBio

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?