example - php docblock generator
¿Existe un PHP DocBlock que pueda usar para denotar una propiedad de método mágico añadida después de la creación de instancias? (1)
No. Clases de documentos DocBlocks, no instancias.
Dicho esto, PHPDocumentor tiene varias etiquetas de anotación de nivel de clase para exponer parte de la magia:
Pero no funcionaría para propiedades / métodos añadidos dinámicamente en tiempo de ejecución ya que las propiedades difieren entre instancias.
Estoy enviando objetos de PHP a archivos de plantilla y me encantaría documentar en la parte superior de mi plantilla qué propiedades del objeto (usando __get) están disponibles y cuáles son y ponerlas a disposición para la sugerencia de código.
Aquí hay un ejemplo.
En mi controlador:
$obj = new Template("welcomePage");
$obj->title = "Welcome!";
$obj->render();
En mi vista / plantilla:
<?php
/**
* @var $obj Template The template data wrapper
* @property $obj->title string The page header text
/* ?>
<h1><?php echo $obj->title; ?></h1>
¿Hay algo similar a esto que funcione? La forma en que la tengo ahora no se autocompletaría si comencé a escribir $obj-> , lo que significa que yo (o un miembro del equipo) necesito hacer referencia a la parte superior de la plantilla para encontrar cada propiedad disponible.
Estaba considerando ampliar la clase de Plantilla para cada tipo de plantilla, pero eso parece una sobrecarga innecesaria ya que podría agregar solo una cadena y una matriz por página, y crear una clase separada para cada plantilla, plantilla parcial y combinación de ambas parece una poco tonto.
Gracias ~