-
Notifications
You must be signed in to change notification settings - Fork 2
phpdoc foxtrot
Clase principal del sistema (prototipo).
Alias de obtenerUrl()
.
Devuelve: string
Devuelve true si la solicitud proviene de la línea de comandos.
Devuelve: bool
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$obj |
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$obj |
Devuelve la instancia de la clase de aplicación.
Devuelve: \aplicacion
Alias de obtenerAplicacion()
.
Devuelve: \aplicacion
Devuelve la instancia de la clase pública de aplicación.
Devuelve: \aplicacion
Alias de obtenerAplicacionPublica()
.
Devuelve: \aplicacion
Devuelve el objeto de parámetros de la aplicación ("JSON").
Devuelve: object
Devuelve el nombre de la aplicación.
Devuelve: string
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$aplicacion |
Si | null |
Incluye todos los archivos .php
de un directorio recursivamente. Advertencia: Este método no realiza verificaciones de seguridad,
fue concebido para uso interno y debe utilizarse con precaución.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$ruta |
string |
Ruta. | ||
$excluirPub |
bool |
Excluir archivos .pub.php . |
Si | true |
Devuelve: array
Crea la instancia del enrutador. Devuelve la URI final, en caso de que haya sido removida la base (prefijo).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$enrutador |
mixed |
Nombre del enrutador, array [base=>nombre] o función. | ||
$uri |
string |
URI actual. | ||
$params |
mixed |
Parámetros de la solicitud actual. |
Devuelve: string
Devuelve un objeto [uri,parametros]
con la URI actual y los parámetros de la solicitud, respectivamente.
Devuelve: object
Prepara de enrutador para la ejecución.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$aplicacion |
Si | null |
Inicializa el framework desde la línea de comandos.
Procesa los valores de configuración establecidos.
Aborta la ejecución de la solicitud.
Limpia una URI.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$uri |
string |
Ruta a procesar. |
Devuelve: string
Valida y corrije un nombre de clase, devolviendo un objeto con las propiedades 'nombre' y 'espacio' con el nombre de la clase y el espacio
de nombres relativo respectivamente. Removerá caracteres inválidos y convertirá las barras y los nombres con guión (ejemplo:
espacio/sub-espacio/consulta-producto
-> [nombre=>consultaProducto,espacio=>\espacio\subEspacio\]
.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre a procesar. | ||
$comoCadena |
boolean |
Por defecto, el método devuelve un objeto [nombre,espacio] . Si $comoCadena es true , devolverá el espacio de nombre como cadena, sanitizado. |
Si | false |
$namespace |
boolean |
Su es true , devolverá una cadena compatible con la sentencia namespace (sin \ inicial ni final). |
Si | false |
Devuelve: object
|string
Valida y corrije un nombre de método. Removerá caracteres inválidos y convertirá los nombres con guión (ejemplo: consulta-producto
-> consultaProducto
).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre a procesar. |
Devuelve: string
Valida y corrije una cadena a utilizar en un espacio de nombres. Removerá caracteres inválidos y convertirá los nombres con guión (ejemplo: consulta-producto
-> consultaProducto
).
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$parte |
string |
Nombre a procesar. |
Devuelve: string
Obtiene y devuelve el nombre, la ruta relativa y la clase a partir de una instancia de un objeto, o null
si no corresponde.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$this |
mixed |
Objeto a analizar. | ||
$base |
string |
Espacio base relativo a \aplicacion\nombreApl\ . |
Devuelve: object
|null
Devuelve la instancia de la clase \bd, creándola si es necesario.
Devuelve: \datos\bd
Alias de obtenerBd()
.
Devuelve: \datos\bd
Devuelve el listado de las clases de modelo de datos cargadas. Cada elemento del listado es un objeto [nombre,clase]
.
Devuelve: object[]
Crea y deuvelve una instancia de un modelo de datos.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre del modelo a crear. | ||
$bd |
\datos\bd |
Instancia de la base de datos. | Si | null |
Devuelve: \modelo
Crea y deuvelve una instancia de una entidad del modelo de datos.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre de la entidad a crear. |
Devuelve: \entidad
Crea y deuvelve una instancia de un modelo de datos correspondiente a una entidad.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre de la entidad cuyo modelo se desea crear. | ||
$bd |
\datos\bd |
Instancia de la base de datos. | Si | null |
Devuelve: \modelo
Crea y deuvelve una instancia de un módulo dado su nombre.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre del módulo a crear. | ||
$publico |
bool |
Determina si debe devolver la clase pública (true) o la clase privada (false). | Si | false |
Devuelve: \modulo
Crea y deuvelve una instancia de un componente dado su nombre.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre del componente a crear. | ||
$publico |
bool |
Determina si debe devolver la clase pública (true) o la clase privada (false). | Si | false |
Devuelve: \modulo
Crea y devuelve una instancia de un controlador dado su nombre.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre del controlador a crear. | ||
$publico |
bool |
Determina si debe devolver la clase pública (true ) o privada (false ). |
Si | false |
Devuelve: \controlador
Devuelve un objeto los parámetros y el cuerpo de una vista.
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
string |
Nombre de la vista. |
Devuelve: object
Parámetro | Tipo | Descripción | Opcional | Predeterminado |
---|---|---|---|---|
$nombre |
¿Probaste Foxtrot? Contanos qué te pareció 🥰 contacto@foxtrot.ar
Índice
Primeros pasos
Gestor de aplicaciones
Editor de vistas
Componentes
Módulos
Comunicación cliente<->servidor
Modelo de datos - ORM
PHPDOC
JSDOC
☝ Comentarios
🤷♂️ Dudas
🤓 Ayuda
⌨ Contribuciones
Escribinos: contacto@foxtrot.ar