Olá pessoal,
Na empresa onde eu trabalho estamos usando o i-Educar em nossos projetos, mas nos sentimos um pouco perdidos sem uma API pra nos basear nos estudos iniciais. Então resolvemos procurar uma maneira de gerar uma API e encontramos o ApiGen.
Inicialmente houve uma dificuldade, pois a ferramenta só permite - logicamente - uma classe distinta por projeto, e o i-Educar cria em vários arquivos as classes clsIndex, clsIndexBase, indice... Entre outras...
Resolvemos o problema indiscriminadamente usando um padrão para renomear as classes. Exemplo:
Para o arquivo intranet/educar_acervo_autor_cad.php
a classe: clsIndexBase
foi renomeada para: clsIndexBaseAcervoAutorCad
Assim como a classe: indice
foi renomeada para: indiceAcervoAutorCad
E seus respectivos objetos foram instanciados com o novo nome da classe.
Só assim foi possível gerar o Api Doc. Não sei se há necessidade dessas classes dentro de cada arquivo, pelo menos a clsIndexBase que só seta duas propriedades que poderiam ser setadas só instanciando um objeto de clsBase já que php permite a facilidade de criação de objetos dinâmicos para objetos que diferem pouco de suas classes. Mas isso fica pra outra discussão.
Abraços,
Esperamos ter contribuído.
Autor: Vinícius Santos Souza