Documentación
Términos de LetPHP
Durante el desarrollo de tus Apps
, se repetirán algunos términos en tu código y en la estructura de carpetas de tus futuras Apps.
En esta sección explicaremos las palabras claves que utiliza el ecosistema de LetPHP
.
Configuración global del sitio
Estas configuraciones son esenciales para el funcionamiento de nuestro sitio , se encuentran en el archivo .
LetCore/configs/site.config.php
Configuraciones
Configuración | Valor |
---|---|
main.site_name | Nombre del Sitio. |
main.site_title | Titulo del sitio y se mostrará en la pestaña del navegador. |
main.site_copyright | Creado por. |
main.site_title_delimiter | Delimitador que aparece en la pestaña del navegador. |
main.site_keywords | Palabras clave para nuestra etiqueta <meta/> . |
main.site_description | Descripción del sitio para la etiqueta <meta/> . |
main.site_theme | Tema UI de nuestro sitio. |
main.site_secure | Indicamos si nuestro sitio es seguro y detecte las rutas internas de nuestro sitio por el protocolo HTTPS , algo importante es que debes de tener instalado un seguro SSL . |
main.route_rewrite | Reescribe nuestras rutas. |
main.app_core | Aplicación principal de nuestro sitio. |
Carpetas y archivos
Explicaremos los archivos y carpetas cuando descargas LetPHP
.
Nombre | Explicación |
---|---|
LetApps | Carpeta donde se alojaran todas tus Apps . |
LetCore | Dentro hay carpetas y archivos que contienen configuraciones y clases principales de LetPHP . |
LetSite | Contiene carpetas y archivos públicos para tu sitio . |
index.php | Archivo encargado de ejecutar LetPHP . |
letphp.ico | Icono de LetPHP . |
htaccess.txt | Reglas para la configuración del servidor. |
Estructura de una App
Cuando creas una App
, se debe de seguir una estructura de carpetas, las cuales te explicaremos ahora:
Nombre | Explicación |
---|---|
Ajax | Folder para guardar archivos de tipo ajax . |
Controllers | Folder para guardar archivos de tipo controller . |
Fragments | Folder para guardar archivos de tipo fragment . |
Models | Folder para guardar archivos de tipo model . |
Public | Folder para guardar archivos de tipo javascript , css . |
Public/css | Folder para guardar archivos de tipo css . |
Public/jscript | Folder para guardar archivos de tipo javascript . |
Views | Folder para guardar archivos de tipo view . |
Sintaxis de los archivos
Ahora vamos a explicar de manera más detallada la sintaxis con la que se deben de guardar los archivos y también la sintaxis de las Clases
y funciones
Controllers
Los controllers
son el punto de inicio de cada App
, es donde se ejecuta el código y mandamos a llamar a Models
, css
, js
y algunas funciones que utilicemos.
Guardar archivos de tipos Controller
Los controladores se guardaran en la carpeta Controllers
y deben de seguir la sintaxis siguiente:
nombre_archivo.controller.php
index.controller.php
usuarios.controller.php
agregar_usuario.controller.php
Es muy importante que se respete la sintaxis presentada.
Representación en código
Aquí representamos el código de los archivos que anteriormente hemos explicado.
// index.controller.php
<?php
namespace LetApps\TuApp\Controllers;
class Index_Controller
{
public function start()
{
// Codigo Aqui
}
}
?>
// usuarios.controller.php
<?php
namespace LetApps\TuApp\Controllers;
class Usuarios_Controller
{
public function start()
{
// Codigo Aqui
}
}
?>
// usuarios.controller.php
<?php
namespace LetApps\TuApp\Controllers;
class Agregar_Usuario_Controller
{
public function start()
{
// Codigo Aqui
}
}
?>
Mas información de los Controllers
Si quieres tener más información sobre los controladores
, te recomendamos ver el siguiente vídeo.
Views
Los archivos de tipo view
deben de nombrarse de la misma manera que los archivos de tipo controller/fragment
ya que la vista
es la encargada de recibir y mostrar los datos que provienen de ellos.
Algo a destacar sobre las views
, es que juegan un papel importante cuando creas diferentes Temas UI
de tu proyecto. Si quieres saber más sobre como crear Temas
, te recomendamos visitar la siguiente [sección][https://letphp.run] .
Guardar archivos de tipo View
Los archivos de tipo view
sé guardarán en la carpeta Views
, aquí algunos ejemplos de como se deben guardar :
Controlador | Vista |
---|---|
index.controller.php | index.view.php |
users.fragment.php | users.view.php |
Representación en código
No es necesario poner código, por que no hay una sintaxis a seguir, ya que el código de la view
es HTML
, aunque cabe destacar que habrá que utilizar algunas funciones de nuestro motor de plantilla llamada bessie
, para saber más sobre bessie
te recomendamos que revisas las siguiente información.
Más información de las Views
Si quieres tener más información de las vistas , te recomendamos ver el siguiente video.
Ajax
Es muy común que en las aplicaciones web, necesitemos llamar archivos o datos de forma asíncrona sin refrescar la página. LetPHP
tiene soporte para Ajax
y puedes trabajar de manera muy fácil.
Guardar archivos Ajax
Los archivos se deben de guardar en la carpeta Ajax
y la sintaxis para guardarlos es la siguiente:
nombre_archivo.ajax.php
user.ajax.php
Es importante seguir la sintaxis de como se guardan los archivos*.
Representación en código
// user.ajax.php
<?php
namespace LetApps\TuApp\Ajax;
class User_Ajax
{
// Nombrar las funciones como tu decidas
}
Mas información sobre Ajax
Las funciones puedes llamarlas como tu decidas , pero eso dependerá de como mandes a llamarlas desde la view
, si quieres saber más de cómo trabajar con Ajax
, te recomendamos que veas el siguiente video.
Fragments
Los fragments
son bloques de código pensados en que puedan ser componentes reutilizares a lo largo de tus proyectos, estos pueden ser llamados desde los controllers, views y ajax
.
Guardar Archivos de tipo Fragment
Los fragments
, deben de ser guardados en la carpeta Fragments
y la sintaxis para guardarlos es la siguiente:
nombre_fragmento.fragment.php
users.fragment.php
form_add_user.fragment.php
Debes de respetar la sintaxis que te hemos mostrado.
Representación en código
// users.fragment.php
<?php
namespace LetApps\TuApp\Fragments;
class User_Fragment
{
public function start()
{
// Codigo aquí
}
}
?>
// form_add_user.fragment.php
<?php
namespace LetApps\TuApp\Fragments;
class Form_Add_User_Fragment
{
public function start()
{
// Codigo aquí
}
}
?>
Más informacion sobre los Fragmentos
Como lo hemos mencionado antes, los fragments
representan bloques de código que pueden ser reutilizables en cualquier controller
o view
, si quieres saber como trabajar mas a fondo con los fragments
, te recomendamos ver este [video][https://letphp.run].
Models
Los models
son pensados para mantener la lógica de nuestros proyectos, las funciones más comunes que se utilizan en los models
son las consultas a base de datos, pero puedes utilizarlos con cualquier función que decidas y así evitar tener mucho código en los controllers
y fragments
.
Guardar archivos de tipo Models
Los models
son llamados desde los controllers
y fragments
, los modelos debes de guardarlos en la carpeta Models
, y con la siguiente sintaxis:
// Ejemplos
nombre_modelo.model.php
users.model.php
admin.model.php
Los models
deben de ser guardados forzosamente como la sintaxis mostrada anteriormente.
Representación en código
// users.model.php
<?php
namespace LetApps\TuApp\Models;
class Users_Model
{
// Código de tus funciones.
}
?>
// admin.model.php
<?php
namespace LetApps\TuApp\Models;
class Admin_Model
{
// Código de tus funciones
}
?>
Más información sobre los Models
Si quieres saber más sobre los models
, te recomendamos ver el siguiente video.
Public
En la carpeta Public
, se guardan los archivos javascript
y css
, pero recuerda que debes de crear una carpeta para cada uno de ellos, de la siguiente manera.
Nombre de las carpetas
Nombre de la carpeta | Descripción |
---|---|
css | Archivos de tipo css . |
jscript | Archivos de tipo javascript . |
Mas información sobre Public
Los archivos css
y js
que se encuentran en la carpeta Public
serán llamados desde los controllers
y fragments
, si quieres aprender a trabajar con ellos , te recomendamos seguir el siguiente [video][https://letphp.run].
Temas UI
Los temas UI están pensados para que puedas crear apariencias diferentes de tus views
sin afectar a los controladores. Te recomendamos ver el siguiente video para que aprendas a crear temas para tus Apps
.
Video
API Functions
En LetPHP
proporcionamos un conjunto de funciones para accedes de manera fácil y sencilla a las herramientas más comunes que necesitas para poder crear tus Apps
. Algunas de estas funciones permiten la encadenación de métodos y están conectadas a nuestras clases principales.
Lib\App()
Esta función es la encargada de administrar las Apps
que vamos desarrollando así como los archivos Ajax
, Controllers
, Fragments
y Models
.
setController()
Asignamos el nombre del controller
a utilizar, esta función carga el controller
con el cual trabajaremos.
Ejemplo
setController(string $sController)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sController (opcional) | string | Nombre del controlador que utilizaremos. |
Código
App()->setController('main.users');
main:
Nombre de laApp
.users:
Nombre delController
.
Return
Regresa un objeto de la función App()
.
getController()
Obtenemos el controller
que se ha asignado en la funcion setController()
.
Ejemplo
getController()
Parametros
No necesita parámetros.
Código
App()->getController();
Return
Regresa un objeto de la función App()
.
getControllerName()
Obtenemos el nombre del controller
actual.
Ejemplo
getControllerName()
Parametros
No necesita parámetros.
Código
App()->getControllerName();
Return
Regresa un valor de tipo string
, el nombre del controller
utilizado.
getAppName()
Obtenemos el nombre de la App
actual.
Ejemplo
getAppName()
Parametros
No necesita parámetros.
Código
App()->getAppName();
Return
Regresa un valor de tipo string
, el nombre del App
actual.
Lib\Auth()
Esta función nos ayuda administrar las sesiones, encriptaciones de nuestro proyecto.
encryptPassword()
Encriptamos nuestras contraseñas con el algoritmo password_hash()
, más información sobre la función, te recomendamos el visitar el siguiente [enlace][ https://www.php.net/manual/function.password-hash.php].
Ejemplo
encryptPassword(string $sPassword, integer [$iHashType])
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sPassword (obligatorio) | string | Contraseña a encriptar. |
$iHashType (opcional) | integer | Tipo de Hash para encriptar, puede ser un numero del 1-6 |
Código
Auth()->encryptPassword('letphp', 2);
Return
Regresa un valor de tipo string
.
verifyPassword()
Verificamos la contraseña ingresada por el usuario a través del formulario y la almacenada en la base de datos. , esta función es muy util para hacer login
.
Ejemplo
verifyPassword(string $sPasswordForm, string $sPasswordDatabase)
Parametros
Parametros | Tipo | Descripción |
---|---|---|
$sPasswordForm (obligatorio) | string | Contraseña enviada desde un formulario. |
$sPasswordDatabase (obligatorio) | string | Contraseña almacenada en la base de datos. |
Código
Auth()->verifyPassword('letphp', '$2y$12$jN7Jt3uBiB4Nquv09teBD.doshe5HS$2y$12$jN7Jt3uBiB');
Recuerda que el segundo parámetro lo obtenemos de la base de datos y lo generamos con la función encryptPassword()
.
Return
Regresa un valor de tipo boolean
, si regresa true
las contraseñas coinciden, de lo contrario enviara un false
.
generatePassword()
Generamos un password de manera aleatoria con nuestro algoritmo.
Ejemplo
generatePassword(integer [$iLength], integer [$iStrength])
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$iLenght (opcional) | integer | Tamaño de tu contraseña. |
$iStrength (opcional) | integer | Fuerza de tu contraseña |
Código
Auth()->generatePassword(8, 10);
El resultado será un password de 8 caracteres y una cadena alfanumérica.
Return
Regresa un valor de tipo string
.
setSession()
Iniciamos una nueva sesión.
Ejemplo
setSession(string $sName, string $sValue);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sName (obligatorio) | string | Nombre de la variable para iniciar la sesión. |
$sValue (obligatorio) | string | Valor de la variable iniciada. |
Código
Auth()->setSession('nombre', 'Roni Ortiz');
Return
Regresa un valor de tipo void
.
getSession()
Obtenemos la session que hemos iniciado con la function setSession()
.
Ejemplo
getSession(string $sName);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sName (obligatorio) | string | Nombre de la sesión que hemos guardado. |
Código
Auth()->getSessión('nombre'); // Roni Ortiz
Return
Regresa un valor de tipo string
, regresa en valor de la sesión guardada.
removeSession()
Terminamos la sesión que hemos iniciado.
Ejemplo
removeSession(string $sName);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sName (obligatorio) | string | Nombre de la sesión que se eliminará. |
Código
Auth()->removeSession('nombre');
Return
Regresa un valor de tipo void
.
Lib\Cache()
Con esta función administramos el cache que se va guardando en todo tú sitio como:
SQL
Javascript
CSS
PHP
Views
setCache()
Asignamos un nombre para el cache , para que se quede registrado y poder utilizarlo en las funciones saveCache()
, getCache()
y removeCache()
.
Ejemplo
setCache(string $sName)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sName (obligatorio) | string | Nombre con él que identificaras el cache a guardar. |
Código
Cache()->setCache('nuevo_cache');
Return
Regresa un valor de tipo string
, el nombre de como se identificará el cache
.
saveCache()
Guardamos el cache.
Ejemplo
saveCache(string $sIdCache, $mContent)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sIdCache (obligatorio) | string | Id del cache , generado con la función setCache() . |
$mContent(obligatorio) | mixed | Contenido que guardaremos en el cache. |
Código
$sIdCache = Cache()->setCache('mi_cache');
Cache()->saveCache($sIdCache, 'Hola Mundo');
Return
Regresa un dato de tipo void
.
getCache()
Obtenemos el cache guardado, a través de su nombre que se ha generado con la función setCache()
.
Ejemplo
getCache(string $sId)
Parámetros
Parametro | Tipo | Descripción |
---|---|---|
$sId (Obligatorio) | string | Obtenemos la información que hemos guardado en cache, es muy importante primero ejecutar la función setCache( . |
Código
$sIdCache = Cache()->setCache('mi_cache');
Cache()->getCache($sIdCache);
Return
Regresa un valor de tipo mixed
, regresa el contenido del cache guardado con la función saveCache()
.
removeCache()
Eliminamos el cache guardado.
Ejemplo
removeCache(string [$sId])
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sId (opcional) | string | Eliminamos el archivo guardado anteriormente en el cache, si no pasamos ningún parámetro se eliminaran todos los archivos guardados en el cache. |
Código
Cache()->removeCache('mi_cache');
Return
Regresa un valor de tipo void
.
Lib\Config()
Clase que controla las configuraciones globales del sitio. Las configuraciones puedes modificarlas directamente desde el archivo site.config.php
.
Ejemplo
Config(mixed $mConfig)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$mConfig (Obligatorio) | mixed | Valor de la configuración que vamos a obtener. Para saber más sobre las cofiguraciones del sitio, te recomendamos ver la sección de configuraciones . |
Código
Config('main.site_title'); // Obtenemos el nombre del sitio
Return
Regresa un valor de tipo string
.
Lib\SetConfig()
Asignamos configuraciones para poder utilizar o también podemos modificar las ya existentes.
Ejemplo
SetConfig(mixed $mConfig, string $sValue)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$mConfig (obligatorio) | mixed | Nombre de la variable de configuración a agregar o modificar. |
$sValue (obligatorio) | string | Valor de la configuración. |
Código
SetConfig('main.site_title', 'Nuevo Proyecto');
Recuperamos el valor con la función Code()
.
Return
Regresa un valor de tipo string
.
Lib\Db()
Función para administrar las funciones para manipular los datos, sobre todo la función SQL SELECT
. Esta es una función de tipo encadenada, eso quiere decir que es un interfaz fluida y permite encadenamiento de otras funciones que se encuentran en Db()
.
Crear una consulta.
Db()
->select(string $sSelect)
->table(string $sTable, string [$sAlias])
->cond(string $sCondition)
->run();
Hay muchas variantes de esta función, así que para que la documentación no sea muy larga, te recomendamos ver este [vídeo][https://letphp.run].
Funciones
count()
collections()
singular()
order()
limit()
groupBy()
having()
Lib\DbTable()
Obtenemos el nombre de la tabla que vamos a utilizar con su prefijo asignado en el archivo site.config.php
.
Ejemplo
DbTable(string $sTable)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sTable (obligatorio) | string | Nombre de la tabla a utilizar. |
Código
DbTable('users'); // letphp_users
Return
Regresa un valor de tipo string
.
Lib\DbInsert()
Función para la ejecutar la consulta SQL INSERT
.
Ejemplo
DbInsert(string $sTable, array $aParams)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sTable (obligatorio) | string | Nombre de la tabla a utilizar. |
$aParams (obligatorio) | array | Valores a insertar a la Base de Datos. |
Código
DbInsert('users', ['name' => 'Roni Ortiz', 'email' => 'roni@letphp.run']);
Return
Regresa un valor de tipo integer
, regresa el id
del ultimo registro insertado.
Lib\DbUpdate()
Función para ejecutar la consulta SQL UPDATE
.
Ejemplo
DbUpdate(string $sTable, array $aParams, string $sCondition);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sTable (obligatorio) | string | Nombre de la tabla a utilizar. |
$aParams (obligatorio) | array | Valores a actualizar . |
$sCondition (obligatorio) | string | Condición a cumplir para la actualización. |
Código
DbUpdate('users', ['name' => 'Rodrigo'], 'user_id = 90');
Return
Regresa una valor de tipo boolean
, si la actualización es exitosa regresará un true
de lo contrario regresará un false
.
Lib\DbDelete()
Función para ejecutar la consulta SQL DELETE
.
Ejemplo
DbDelete(string $sTable, string $sCondition)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sTable (obligatorio) | string | Nombre de la tabla a utilizar. |
$sCondition (obligatorio) | string | Condición a cumplir para eliminar el registro. |
Código
DbDelete('users', 'user_id = 90');
Return
Regresa una valor de tipo boolean
, si la eliminación es exitosa regresará un true
de lo contrario regresará un false
.
Lib\Input()
Esta función filtra y analiza todos los datos enviado desde los formularios HTML
llenados por los usuarios.
cleanStr()
Limpia y recorta una cadena.
Ejemplo
cleanStr(string $sText, integer $iShorten)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sText (obligatorio) | string | Cadena de texto a limpiar. |
$iShorten (opcional) | integer | Numero de carácteres a mostrar. |
Código
Input()->cleanStr('Hola Mundo', 2); // Ho
Return
Regresa un valor de tipo string
.
htmlSpecialChars()
Limpiar caracteres especiales de HTML
.
Ejemplo
htmlspecialchars(string $sText)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sText (obligatorio) | string | Cadena de texto a limpiar. |
Código
Input()->htmlspecialchars('<b>Hola Mundo</b>'); // <b>Hola Mundo</b>
Return
Regresa un valor de tipo string
.
parseTitle()
Convierte el titulo y lo limpia de caracteres.
Ejemplo
parseTitle(string $sTitle)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sTitle (obligatorio) | string | Cadena de texto a convertir y limpiar. |
Código
Input()->parseTitle('nuevos productos'); // nuevos-productos
Return
Regresa un valor de tipo string
.
Lib\Output()
Limpia las cadenas de texto que se han agregado a la Base de datos, estos datos guardardos, ya han pasado por el proceso de limpia con la función Input()
.
Lib\Http()
Creamos una función especial, para administrar y poder trabajar con las variable globales POST/REQUEST/FILES/GET
, todas las peticiones son analizadas y convertidas.
getParam()
Obtenemos un parámetro de la ruta.
Ejemplo
getParam(string $sParam);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sParam (obligatorio) | string | Nombre de parametro a obtener. |
Código
Http()->getParam('page');
Return
Regresa un valor de tipo string
.
getParamInt()
Obtenemos un parámetro de la ruta y lo convierte implícitamente a un valor de tipo integer
.
Ejemplo
getParamInt(string $sParam);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sParam (obligatorio) | string | Nombre de parametro a obtener. |
Código
Http()->getParamInt('page');
Return
Regresa un valor de tipo int
.
getParamArray()
Obtenemos un parámetro de la ruta.
Ejemplo
getParam(string $sParam);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sParam (obligatorio) | string | Nombre de parametro a obtener. |
Código
Http()->getParam('page');
Return
Regresa un valor de tipo string
.
getIp()
Obtenemos la IP de los visitantes del sitio.
Ejemplo
getIp()
Parametros
No necesita parámetros.
Código
Http()->getIp();
Return
Regresa un valor de tipo string
.
getHashUnique()
Obtenemos él ID único
de la sesión del navegador.
Ejemplo
getHashUnique()
Parametros
No necesita parámetros.
Código
Http()->getHashUnique();
Return
Regresa un valor de tipo string
.
sendRequestCURL()
Esta función nos ayuda a enviar una petición a otro servidor, normalmente lo hacemos a través de CURL
.
Ejemplo
sendRequestCURL(string $sRoute, array [$aParams], string [$sMethod], array [$aHeaders], string [$sUserAgent])
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sRoute (obligatorio) | string | Ruta del Servidor . |
$aParams (opcional) | array | Parametros a enviar. |
$sMethod (opcional) | string | Métodos por el cual se obtendrán los datos. |
$aHeaders (opcional) | array | Cabeceras. |
$sUserAgent (opcional) | string | Agente de Usuario personalizado. |
Código
Http()->sendRequestCURL("https://randomuser.me/api/", ['format' => 'pretty'], 'GET');
Return
Regresa un valor de tipo mixed
.
Lib\JS()
Con esta función podemos trabajar con Ajax
y con algunas funciones de Javascript
. Hemos decidido explicar esta función a través de un video, ya que es una función que requiere hacer código para comprender como trabajar con Ajax
, te recomendamos ver el siguiente [video][https://letphp.run].
Funciones
getParam()
getParamInt()
getParamArray()
getContentFile()
let_alert()
let_console_log()
let_hide()
let_show()
let_html()
LetPHPJavascript()
Lib\Paginator()
Esta función es la encargada de ayudarnos crear un paginado para nuestras Apps
, es muy común utilizar el paginado con nuestro registros que obtenemos de la Base de Datos , en esta API
no pondremos la documentación , ya que es una función que requiere de otras acciones para funcionar, para saber más te recomendamos ver el siguiente [video][https//letphp.run].
Lib\Router()
La función Router()
, se encarga principalmente de construir y administrar las rutas internas de nuestro sitio.
getDomain()
Obtenemos el dominio donde esta alojado nuestro proyecto.
Ejemplo
getDomain()
Parametros
No necesita parámetros.
Código
Router()->getDomain();
Return
Regresa un valor de tipo string
y es el dominio donde esta alojado nuestro proyecto.
createRoute()
Creamos una ruta interna para nuestro proyecto
Ejemplo
createRoute(string $sRoute, array $aParams);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sRoute (obligatorio) | string | La ruta interna hacia donde nos queremos dirigir, dentro de nuestro proyecto. |
$aParams (opcional) | array | Esta opción nos permite pasar parámetros a la página hacia donde nos dirigimos. |
Código
// Ejemplo sin parametros.
Router()->createRoute('main.usuarios');
// Ejemplo pasando parametros.
Router()->createRoute('main.usuarios', ['id' => 90]);
main:
Nombre de laApp
.usuarios:
Nombre delcontroller
.
Return
Regresa un valor de tipo string
y es el ruta completa hacia donde vamos a dirigirnos.
goToPage()
Esta función tiene un funcionamiento similar a location de PHP
, con esta función podemos dirigirnos a cualquier controlador de nuestro sitio.
Ejemplo
goToPage(string $sRoute, array $aParams);
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sRoute (obligatorio) | string | La ruta interna hacia del redireccionamiento dentro de nuestro proyecto. |
$aParams (opcional) | array | Esta opción nos permite pasar parámetros a la página hacia donde eran redireccionados los visitantes del sitio. |
Código
// Ejemplo sin parametros.
Router()->goToPage('main.usuarios');
// Ejemplo pasando parametros.
Router()->goToPage('main.usuarios', ['id' => 90]);
main:
Nombre de laApp
.usuarios:
Nombre del controlador.
Return
Regresa un valor de tipo void
.
getFullRoute()
Obtenemos la ruta completa del controlador
.
Ejemplo
getFullRoute();
Parametros
No necesita parámetros.
Código
// Ejemplo sin parametros.
Router()->getFullRoute();
Return
Regresa un valor de tipo string
, el valor que regresa es la ruta completa del controller
que estamos utilizando.
Lib\View()
La función View()
es la encargada para administrar la información para pasar a la vista, convierte todo el código HTML en PHP y lo guarda en caché.
Algunas características que contiene esta clase son :
- Pasa las variables hacia la vista
- Sobre escribe el titulo de la pagina
- Crea etiquetas HTML meta
- Carga Archivos de Javascript
- Carga CSS
setTitle()
Asignamos un titulo a la pestaña del navegador
.
Ejemplo
setTitle(string $sTitle)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$sTitle (Obligatorio) | string | Valor del titulo de la pestaña del navegador |
Código
View()->setTitle('LetPHP');
Return
Regresa el objeto de la función View()
.
getTitle()
Obtenemos el titulo para la pestaña del navegador
.
Ejemplo
getTitle()
Parametros
No necesita ningún parametro.
Código
View()->getTitle();
Return
Regresa el titulo que hemos asignado con setTitle()
, devuelve un valor de tipo string
.
setMeta()
Asignamos valores a la etiqueta <meta/>
.
Ejemplo
setMeta(array $aParams)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$aParams (obligatorio) | array | Valores para la etiqueta meta , con un tipo array . |
Código
View()->setMeta([
'description' => 'LetPHP, es un framework creado con PHP',
'keywords' => 'letphp,php,framework',
'twitter:site' => '@letphp',
'twitter:creator' => '@RoniRHO',
'og:title' => 'LetPHP Framework'
]);
Return
Regresa el objeto de clase función View()
.
getMeta()
Obtenemos los valores asignados en la función setMeta()
.
Ejemplo
getMeta()
Parametros
No necesita ningún parametro.
Código
View()->getMeta();
Return
Regresa los valores renderizados en la etiqueta <meta/>
.
setJScript()
Asignamos valores de librerías javascript
externas o nuestras.
Ejemplo
setJScript(array $aParams)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$aParams (Obligatorio) | array | Los parámetros que se pueden pasar son de tipo array , los valores serán librerías javascript externas o alojadas en nuestro proyecto. |
Código
View()->setJScript([
'<script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>', // JS externo
'test.js' => 'app@main' // Nombre del archivo js => App donde esta guardado
]);
Return
Regresa el objeto de clase función View()
.
setCSS()
Asignamos rutas de archivos css
externas o alojadas en nuestro proyecto.
Ejemplo
setCss(array $aParams)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$aParams (Obligatorio) | array | Los parámetros que se pueden pasar son de tipo array , los valores serán rutas de archivos css externas o alojadas en nuestro proyecto. |
Código
View()->setCss([
'<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/5.0.0-alpha1/css/bootstrap.min.css" />', // Link externo
'main.css' => 'app@main' // Archivo CSS => App donde se encuentra
]);
Return
Regresa el objeto de clase función View()
.
setValues()
Asignamos los valores desde controller
o fragment
para pasarlos a la view
.
Ejemplo
setValues(array $aValues)
Parametros
Parametro | Tipo | Descripción |
---|---|---|
$aValues (obligatorio) | array | Valores que se pasaran a la del controller o fragment a la view . |
Código
View()->setValues([
'nombre' => 'Rodrigo Hernández Ortiz',
'edad' => 45,
'email' => 'roni@letphp.run'
]);
Return
Regresa el objeto de clase función View()
.