Download as
Browse Code »

Commit 0c222af2391a2f9b9f2e567fb8f7aae6879ab72a

Authored by Eriksen Costa Paixão
1 parent bbde7f14
Exists in master

Atualizada documentação de código

Showing 1 changed file with 18 additions and 8 deletions   Show diff stats
ieducar/lib/App/Model/IedFinder.php
  Diff comments   View file @0c222af
... ... @@ -282,10 +282,9 @@ class App_Model_IedFinder extends CoreExt_Entity
282 282 }
283 283  
284 284 /**
285   - * Retorna a quantidade de etapas (módulos) a serem ou cursados por um
286   - * aluno em uma dada matrícula.
  285 + * Retorna a quantidade de módulos do ano letivo por uma dada matrícula.
287 286 *
288   - * @param int $codMatricula
  287 + * @param int $codMatricula
289 288 * @return int
290 289 * @throws App_Model_Exception
291 290 */
... ... @@ -318,12 +317,23 @@ class App_Model_IedFinder extends CoreExt_Entity
318 317 }
319 318  
320 319 /**
  320 + * Retorna o total de módulos do ano letivo da escola ou turma (caso o ano
  321 + * escolar do curso não seja "padrão"). Retorna um array com o total de
  322 + * módulos atribuídos ao ano letivo e o nome do módulo. Ex:
  323 + *
  324 + * <code>
  325 + * <?php
  326 + * array(
  327 + * 'total' => 4,
  328 + * 'nome' => 'Bimestre'
  329 + * );
  330 + * </code>
321 331 *
322   - * @param unknown_type $codEscola
323   - * @param unknown_type $codCurso
324   - * @param unknown_type $codTurma
325   - * @param unknown_type $ano
326   - * @return unknown_type
  332 + * @param int $codEscola
  333 + * @param int $codCurso
  334 + * @param int $codTurma
  335 + * @param int|NULL $ano Ano letivo da escola ou turma. Opcional.
  336 + * @return array
327 337 */
328 338 public static function getModulo($codEscola, $codCurso, $codTurma,
329 339 $ano = NULL)
... ...