diff --git a/starting-manual.html b/starting-manual.html index 68a63c2..19eace3 100644 --- a/starting-manual.html +++ b/starting-manual.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Duckbrain - Manual de inicio @@ -219,76 +219,76 @@ $(function() { $('.note').before("

Note

")

Table of Contents

-
-

1. Introducción

+
+

1. Introducción

-Duckbrain es un conjunto de librerías creadas especialmente pensando en hacer algo simple, que cualquiera pueda deshacer y rearmar fácilmente. Gracias a esa versatilidad, puedes usarlo cualquier proyecto, peo por ello debes tener en cuenta que mientras más grande sea el proyecto, mayor será el nivel de ingeniería que se requerirá de tu parte para acondicionar esta herramienta a los requerimientos. +Duckbrain es un conjunto de librerías creadas especialmente pensando en hacer algo simple, que cualquiera pueda deshacer y rearmar fácilmente. +

+ +

+Gracias a esa versatilidad, puedes usarlo cualquier proyecto, pero por ello debes tener en cuenta que mientras más grande sea el proyecto, mayor será el nivel de ingeniería que se requerirá de tu parte para acondicionar esta herramienta a los requerimientos.

Otro punto fuerte que puedo dar de esta herramienta, es que te puede ser tremendamente útil si estás comenzando, ya que al ser tan pequeño y modificable, es más sencillo que lo comprendas y esto más adelante te ayudará a comprender cosas más grandes.

- -

-Ducho eso, vamos a comenzar… -

-
-

1.1. Estructura de archivos de Duckbrain

+
+

1.1. Estructura de archivos de Duckbrain

-Al entrar a la carpeta de Duckbrain encontraras esta estructura de archivos (ignoramos el readme.org porque no es necesario). +Al entrar a la carpeta de Duckbrain encontrarás esta estructura de archivos (ignoramos el readme.org porque no es necesario).

@@ -318,8 +318,8 @@ Primero veamos las carpetas y luego los archivos:

-
-

1.1.1. Carpeta src

+
+

1.1.1. Carpeta src

En esta carpeta se encuentra todo el código PHP. @@ -331,8 +331,8 @@ Como todo en Duckbrain, esta ruta

-
-

1.1.2. Carpetas: Controllers, Libs, Models, Middlewares, Views y Routers

+
+

1.1.2. Carpetas: Controllers, Libs, Models, Middlewares, Views y Routers

Si sabes de estructuras de diseño, el nombre de estas carpetas ya te debe quedar claro qué va en cada una de ellas, puesto que en el nombre de la carpeta dice lo que va a ir dentro. @@ -343,28 +343,24 @@ Si no sabes que es un Model, un Middleware, Controller, etc. entonces requieres

-Al igual que con la carpeta src, todo lo puedes cambiar y colocar otra estructura de carpetas y las únicas que requerirían algún tipo de edición de archivos serían las carpetas Views y Router que se editarían en el archivo src/Libs/View.php y el archivo index.php respectivamente. Las demás carpetas las puedes borrar cuando quieras y usar otra estructura, pero por lo pronto no lo hagas al menos hasta que hayas pasado la sección 3 que es cuando ya habrías leído y, con algo de suerte y pericia, asimilado los conocimientos necesarios para hacer lo que te de la gana con este ser de librería al punto de que ya le podrás colocar las tuyas propias, le borrarás alguna de las que viene por defecto porque no la necesites o incluso crees una versión extendida de las que viene por defecto para poder añadirle alguna mejora que necesites. +Al igual que con la carpeta src, todo lo puedes cambiar y colocar otra estructura de carpetas y las únicas que requerirían algún tipo de edición de archivos serían las carpetas Views y Router que se editarían en el archivo src/Libs/View.php y el archivo index.php respectivamente. Las demás carpetas las puedes borrar cuando quieras y usar otra estructura, pero por lo pronto no lo hagas al menos hasta que hayas pasado la sección Mi primera aplicación que es cuando ya habrías leído y, con algo de suerte y pericia, asimilado los conocimientos necesarios para hacer lo que te de la gana con este ser de librería al punto de que ya le podrás colocar las tuyas propias, le borrarás alguna de las que viene por defecto porque no la necesites o incluso crees una versión extendida de las que viene por defecto para poder añadirle alguna mejora que necesites.

-Desde luego, si eres un ansias y sabes lo que son las arquitecturas de diseño, ya has programado en alguna arquitectura de diseño como DDD, MVC, TDD, EDD, etc. antes y sabes PHP, con que te leas el código del archivo index.php (son solo 20 líneas de código) y tengas el nivel de PHP para entenderlo y programar en la arquitectura de diseño que desees, entonces con ver esas 20 líneas te deberá bastar y puedes saltarte el resto del este manual y guiarte de ahora en adelante con la documentación API de las librerías o directamente con el LSP de tu editor de código para poco que queda. -

- -

-Para el resto de mortales y gente con menos arrogancia, pueden seguir un ratito más por aquí :P. +Desde luego, si eres un ansias y ya has programado antes en alguna arquitectura de diseño como DDD, MVC, TDD, EDD, etc. y manejas decentemente PHP, con que te leas el código del archivo index.php (son solo 20 líneas de código) te deberá bastar y puedes saltarte el resto del este manual y guiarte de ahora en adelante con la documentación API de las librerías.

-
-

1.1.3. Los archivos en la raíz

+
+

1.1.3. Los archivos en la raíz

-El .htaccess es un archivo que te será útil si usas apache o algún otro servidor web que use estos archivos y lo que lleva es una configuración especial para que funcionen las rutas virtuales, o sea, para que podamos crear una ruta tipo mitsitio.com/mi-ruta-virtual/ y podamos decir que allí muestre un mensaje de Hola mundo, a pesar de que la carpeta mi-ruta-virtual no exista, ni haya dentro ningún archivo index que tenga el texto Hola mundo. Si esta aún no lo entendiste, no exasperes que ya lo vas a entender en un momento y ahí podrás volver a repasar esta parte. +El .htaccess es un archivo que te será útil si usas apache o algún otro servidor web que use estos archivos. Contiene una configuración especial para que funcionen las rutas virtuales, o sea, para que podamos crear una ruta tipo mitsitio.com/mi-ruta-virtual/ a pesar de que la carpeta mi-ruta-virtual no exista.

-En caso de que uses nginx, debes configurar el webserver con la regla equivalente al contenido del archivo .htacess que sería más o menos esto: +En caso de que uses nginx, debes configurar el webserver con la regla equivalente al contenido del archivo .htaccess que sería más o menos esto:

@@ -375,7 +371,7 @@ En caso de que uses nginx, debes configurar el webserver con la regla equivalent

-El archivo index.php es el punto de entrada de nuestra aplicación, aquí sucederá toda la magia inicial y sólo requiere de 20 míseras lineas para hacer ese gran trabajo y soportar sistemas tan grandes sin despeinarse ante frameworks más complejos como laravel o que son usados por cientos de miles de usuarios en cientos de instalaciones. Esto lo menciono no por creer que ttps://git.kj2.me/kj/duckbrain][Duckbrain podría soportarlo, sino porque es algo que ya sucede, o sea, dichos sistemas ya existen: Los he hecho yo o he estado involucrado en parte del proyecto al punto de poder elegir [https://git.kj2.me/kj/duckbrain][Duckbrain]] como base para el mismo. +El archivo index.php es el punto de entrada de nuestra aplicación, aquí sucederá toda la magia inicial y sólo requiere de 20 míseras lineas para hacer ese gran trabajo y soportar sistemas tan grandes sin despeinarse ante frameworks más complejos como laravel o que son usados por cientos de miles de usuarios en cientos de instalaciones. Esto lo menciono no por creer que ttps://git.kj2.me/kj/duckbrain][Duckbrain podría soportarlo, sino porque es algo que ya sucede, o sea, dichos sistemas ya existen: Los he hecho yo o he estado involucrado en parte del proyecto al punto de poder elegir Duckbrain como base para el mismo.

@@ -384,8 +380,8 @@ El archivo config.php, como su nombre indica, es el archivo para co

-
-

1.1.4. Los archivos en la carpeta Libs

+
+

1.1.4. Los archivos en la carpeta Libs

Son básicamente librerías, cada una tiene como nombre lo que hace, no tiene mucho misterio y al igual que antes con las carpetas, si sabes algo de diseño, con leer el nombre de las mismas te debería bastar para saber lo que hacen. Si no lo entiendes, sigue leyendo el manual que hablaremos de casi todas poco a poco. @@ -394,23 +390,27 @@ Son básicamente librerías, cada una tiene como nombre lo que hace, no tiene mu

-
-

1.2. Comprendiendo el arranque del sistema

+
+

1.2. Comprendiendo el arranque del sistema

Como la intención de este manual es que comprendas Duckbrain y no solo seas un robot que copia y pega de la documentación, vamos a calentar comprendiendo el código que lo arranca.

-Como ya mencionamos antes, el archivo .htaccess se encarga de hacer funcionar las rutas virtuales, pero eso como programador que eres te debería hacer saltar una pregunta "¿Cómo es que hace eso?" y la respuesta es simple y puede que ya lo entiendas gracias al código de configuración de nginx que coloqué antes: +Como ya mencionamos antes, el archivo .htaccess se encarga de hacer funcionar las rutas virtuales, pero eso como programador que eres te debería hacer saltar una pregunta "¿Cómo es que hace eso?" y la respuesta es bastante simple:

-Supongamos que entramos en la ruta /hola (o sea, misitio.com/hola), lo que hará el .htacess o la configuración nginx será lo siguiente: +Supongamos que entramos en la ruta /hola (o sea, misitio.com/hola), lo que hará el .htaccess será lo siguiente:

-Primero intenta comprobar si el fichero "hola" existe en la ruta a la que se desea acceder, si no es el caso prueba si existe una carpeta "hola" y si tampoco sucede eso, reenvía todo a index.php y le pide que él se encargue de ahí en adelante. Si llega hasta la tercera opción decimos que es una ruta virtual (lo que mencionamos en Los archivos en la raiz), porque devolveremos algo desde el PHP simulando un archivo o una carpeta, a pesar de que esa ruta realmente no existe ni como fichero ni como carpeta. +Primero intenta comprobar si el fichero "hola" existe en la ruta a la que se desea acceder, si no es el caso prueba si existe una carpeta "hola" y si tampoco sucede eso, reenvía todo a index.php y le pide que él se encargue de ahí en adelante. +

+ +

+Si llega hasta la tercera opción decimos que es una ruta virtual (lo que mencionamos en Los archivos en la raiz), porque devolveremos algo desde el PHP simulando un archivo o una carpeta, a pesar de que esa ruta realmente no existe ni como fichero ni como carpeta.

@@ -487,8 +487,8 @@ Nótese que lo que ha hecho el autoloader es convertir los backslashes o barras

-
-

1.3. Extra: Namespaces

+
+

1.3. Extra: Namespaces

Si eres nuevo en esto puede que no sepas lo que es un namespace, pero si también te dio curiosidad el que la una clase tenga \ (backslash) en su nombre, entonces tienes futuro en este campo y como no quiero que te vayas de este manual, voy a explicarte rápidamente de donde viene ese backslash. @@ -518,16 +518,16 @@ Puede que ahora mismo no notes la utilidad de esto, pero es algo muy útil realm

-
-

2. Primeros pasos

+
+

2. Primeros pasos

Antes de ponernos a programar vamos a asegurarnos de estar en la misma pagina preparando nuestro entorno de trabajo y haciendo el usual Hola mundo.

-
-

2.1. Usando un Webserver para el desarrollo

+
+

2.1. Usando un Webserver para el desarrollo

Desde luego esta la carpeta con Duckbrain supongo que ya la tienes con un webserver nginx o apache en localhost. Si no es el caso, al menos deberás instalarte PHP primero y una ves instalado, abres una terminal en la carpeta donde tienes Duckbrain y ejecutas: @@ -552,8 +552,8 @@ He conocido gente que usa directamente un hosting y edita los archivos allí. Es

-
-

2.2. Hola mundo

+
+

2.2. Hola mundo

Agarren su teclado y su editor de código que vamos a comenzar a hacer la magia. Como es usual, el primer paso para hacer nuetra aplicación, será imprimir un hello world. @@ -580,8 +580,8 @@ Ahora, siguiendo con el código, abrimos la URL donde estamos corriendo el sitio

-
-

2.2.1. Explicación del código del hola mundo

+
+

2.2.1. Explicación del código del hola mundo

Si entendiste el código con solo leerlo, perfecto, pero si no lo hiciste, vamos a explicarlo. Primero vamos a explicar esta parte: @@ -611,7 +611,7 @@ Lo que estámos haciendo aquí, es llamar al método get de la clas

-Al igual que en Extra: Namespaces la explicación de las primeras 2 líneas de este código, realmente no es algo de Duckbrain, sino del lenguaje mismo, pero de todos modos lo explicaré. +Al igual que en Extra: Namespaces la explicación de las primeras 2 líneas de este código, realmente no es algo de Duckbrain, sino del lenguaje mismo, pero de todos modos lo explicaré.

@@ -651,16 +651,16 @@ Prueba ponerle apodos ambas clases y usar sus distintos nombres en el código. E

-
-

3. Mi primera aplicación

+
+

3. Mi primera aplicación

Ya hicimos un hola mundo, ahora vamos a hacer algo completo de verdad. Una buena práctica a la hora de crear proyectos es comenzar a definir lo que vamos a hacer, por lo tanto:

-
-

3.1. Definición del proyecto

+
+

3.1. Definición del proyecto

Vamos a hacer un sistema que nos permita compartir textos de manera secreta. Una persona cualquiera podrá entrar a nuestra web, escribir un texto o nota secreta y se le entregará un enlace con el que puede compartir esa nota secreta. @@ -680,8 +680,8 @@ El nombre de la aplicación será Ignota. No soy bueno con los nombres y

-
-

3.2. Base de datos

+
+

3.2. Base de datos

Este sistema no es algo complicado en lo que al diseño de la base de datos se refiere, por lo que sólo vendría a tener una tabla: @@ -732,8 +732,8 @@ Voy a obviar la parte de cómo crear las bases de datos ya que ambas cosas se pu

-
-

3.2.1. Configuración de Duckbrain para la base de datos

+
+

3.2.1. Configuración de Duckbrain para la base de datos

Desde luego, Duckbrain va necesitar tener la información de la base de datos, por lo que abriremos el archivo y veremos algo como esto: @@ -784,8 +784,8 @@ Como nuestra base de dato es solo un archivo sqlite, no requerimos de DB_H

-
-

3.3. Modelos

+
+

3.3. Modelos

Debo hacer incapié en que nada está escrito en piedra y podemos hacer las cosas de muchas manera con Duckbrain, pero en este caso, siguiendo la estructura MVC, vamos a crear modelos, vistas y controladores. @@ -853,8 +853,8 @@ Nada de lo mencionado en el anterior párrafo lo necesitaremos, pero de todos mo

-
-

3.4. Creando vistas

+
+

3.4. Creando vistas

En este caso solo necesitaremos una sola vista, por ello no crearemos archivos aparte para el código CSS, sino que irá todo en un solo archivo. @@ -931,8 +931,8 @@ No creo que sea necesario que expliquemos un código html, si no lo entiendes, n

-
-

3.5. Mostrando el formulario

+
+

3.5. Mostrando el formulario

Ahora no vamos a hacer un archivos completos, los haremos a pedacitos de código a medida que avancemos. @@ -1004,8 +1004,8 @@ Ambas funcionarán y al entrar en http://localhost ya

-
-

3.5.1. Extra: Explicación del tipo callable

+
+

3.5.1. Extra: Explicación del tipo callable

Enlos anteriores 2 bloques de código lo que hemos visto han sido 2 maneras de escribir un callable: @@ -1047,8 +1047,8 @@ Sé que esto es algo raro y que realmente tiene que ver con el conocimiendo de P

-
-

3.6. Creando la nota encriptada

+
+

3.6. Creando la nota encriptada

Ahora que ya tenemos el formulario, ya solo nos queda encriptar y guardar nuestra nota. Para ello comenzaremos agregando la siguiente función a nuestro modelo: @@ -1139,8 +1139,8 @@ Ahora ya podemos comenzar a crear nuestras notas, auque aún no las podremos ver

-
-

3.7. Recta final: Desencriptando y mostrando las notas

+
+

3.7. Recta final: Desencriptando y mostrando las notas

Vamos directo al grano, editaremos el modelo (src/Models/Note.php) y le añadiremos esta otra función para desencriptar: @@ -1279,8 +1279,8 @@ Crea una aplicación de gestión tareas (un TODO list), en donde puedas agregar

-
-

3.8. Repositorio

+
+

3.8. Repositorio

Por si alguien se perdió o sencillamente quiere ver código, he subido la aplicación ignota en este repositorio: @@ -1297,8 +1297,8 @@ Te animo a hacerle un fork, mejorarlo y enviármelo. Los forks que me parezcan i

-
-

4. Contacto

+
+

4. Contacto

Como siempre, pueden contactarme mediante el correo webmaster@outcontol.net @@ -1316,7 +1316,7 @@ No es una comunidad de programación solamente, pero ahora mismo no existe una d

Author: KJ

-

Created: 2024-05-31 vie 16:24

+

Created: 2024-06-03 lun 15:35

Validate