Klear.yaml¶

log¶

Nos sirve para especificar una ubicación para redireccionar los logs de nuestra aplicación.

log:
   writerName: stream
   writerParams:
     stream: /tmp/klear.log
     mode: a

Para syslog

log:
   writerName: syslog
   writerParams:
     application: app-admin-portal
     facility: LOG_USER

sitename¶

Define el nombre de la aplicación.

sitename: Mi aplicación de Klear

logo¶

Ruta hasta la imagen que queremos se use como logo. La ruta es relativa a la carpeta public.

logo: img/logo.png

year¶

Año de la aplicación, por defecto se pone el año en el que fue generado este yaml.

lang¶

Con esta opción se define el idioma por defecto de la aplicación.

lang: Euskera

langs¶

Lista con los idiomas soportados en la aplicación.

Cada idioma debe definir:

• title: Título del idioma
• language: Nombre corto del idioma (ejem.: eu)
• locale: El código locale del idioma (ejem.: eu_ES)

langs:
   Euskera:
     title: Euskera
     language: eu
     locale: eu_ES
   Espanol:
     title: Español
     language: es
     locale: es_ES

jqueryUI¶

Es el tema que adoptará la interfaz del Klear. Los css que optará podría estar en local o en la nube. Por ejemplo:

Formato local: los css deben ubicarse en la zona pública (carpeta public). Esta opción suele ser usada cuando algunas aplicaciones no tienen acceso al exterior. El formato sería el siguiente:

jqueryUI:
   path: /css/south-street/jquery-ui-1.8.22.custom.css

CSS en la nube: Los estilos a elegir son limitados, pero son los más recomendados, serán seleccionados según la imagen que tiene que dar la aplicación. El formato sería el siguiente:

jqueryUI:
   theme: redmond

themeRoller:
   paths: #para temas externos
      verdecito: /ui/themes/aristo-green/jquery-ui.css
   themes: #para temas predefinidos
      - pepper-grinder
      - redmond
      - ui-darkness
      - aristo-red

cssExtended¶

Esta configuración es opcional, normalmente es usada para que podamos elegir un favicon o ampliar nuestro listado de iconos en la interfaz. Ya sea porque los iconos por defecto no se adecuan al tema de la aplicación o porque se requiere nuevas imágenes para representar nuestras secciones.

cssExtended:
   silkExtendedIconPath: /images/favicon.ico

.
└── ui-klear
    ├── cache
    └── icons

cssExtended:
   silkExtendedIconPath: /css/ui-klear/icons

http:// ~ /klear/css-extended/silk-extended/silk-extended-sprite.css?generate

raw¶

Si no estamos satisfechos con los estilos que ya están definidos, podemos también incorporar algunos propios haciendo uso de esta opción.

Para ello, debemos crear una carpeta con el nombre “assets” en nuestra carpeta “application”, dentro de ella ya decidimos donde ubicaremos nuestro estilo; por ejemplo, yo crearía la carpeta “css” y dentro de ella mi archivo de estilo (.css), quedando algo como esto:

application
└── assets
    └── css
        └── style.css

En el yaml, debemos especificar la ruta de la siguiente manera:

raw:
  css:
    - "./default/css/style.css"

optionCollectionPlacement¶

Configurar las posiciones de los botones dentro de los módulos de Klear.

Los valores permitidos son: top | both | bottom

La configuración puede ser definida como string o como colección.

• Configuración de string:

optionCollectionPlacement: both

• Configuración de colección:

optionCollectionPlacement:
  default: 'both'
  list: 'top'
  edit: 'bottom'

rememberScroll¶

Permite recordar la posición de las pestañas.

Esto es útil en listados largos en los que al editar uno de los registros la página se mueve hacia arriba para facilitar la edición. En estos casos al cerrar la pestaña de edición o al volver a la pestaña original del listado el listado está al comienzo, teniendo que volver a buscar por que registro estábamos antes de editar.

Si se activa esta opción al cerrar la pestaña de edición o al volver a la pestaña del listado, el listado se moverá automáticamente a la posición en la que estábamos antes de editar.

rememberScroll: true

auth¶

Configuración del adaptador de autenticación.

Párametros configurables para el adaptador:

• adapter: Nombre del adaptador.

• title: Título de la ventana emergente de login.

• description: Descripción que se muestra en la ventana de login.

• userMapper: Clase Mapper que implementa Klear_Auth_Adapter_Interfaces_BasicUserMapper. El valor predeterminado es Klear_Model_Mapper_Users.

• session: Configuración de almacenamiento de sesión.

  • name: Nombre de sesión para la autenticación (por defecto klear_auth) , si queremos tener mas de una instancia en el mismo host, esto debe modificarse.
  • disableChangeName: Si queremos que Klear comparta el namespace con la zona pública pondremos a true.

auth:
  adapter: Klear_Auth_Adapter_Basic
  title: _("Access denied")
  description: _("Insert your username")
  userMapper: \MyApp\Mapper\Sql\KlearUsers
  session:
    name: my_auth_session_name
    disableChangeName: false

El siguiente código genera la tabla necesaria, con el usuario admin y contraseña admin:

CREATE TABLE `KlearUsers` (
  `userId` mediumint(8) unsigned NOT NULL AUTO_INCREMENT,
  `login` varchar(40) NOT NULL,
  `email` varchar(255) NOT NULL,
  `pass` varchar(80) NOT NULL COMMENT '[password]',
  `active` tinyint(1) DEFAULT '0',
  `createdOn` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
  PRIMARY KEY (`userId`),
  UNIQUE KEY `login` (`login`),
  UNIQUE KEY `email` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
INSERT INTO `KlearUsers`(login, email, pass, active) VALUES('admin','admin@example.com','$2a$08$OBG.QrnbL0iJh3O0LlKxBOFWhZKc77NeHqn8vutpg5velSt0dwkeK',1);

disableMinifier¶

Para activar o desactivar los minificadores dinámicos. Útil en entornos de desarrollo.

disableMinifier: true

disableAssetsCache¶

Para activar o desactivar la cache de css y js. Útil para entornos de desarrollo.

disableAssetsCache: true

defaultCustomConfiguration¶

Posibilita la configuración de propiedades fácilmente accesibles desde cualquier parte de la aplicación.

defaultCustomConfiguration:
     optionCollectionPlacement: both
     autoClose: true
     disableSave: false
     disableAddAnother: false
     autoShowSizeOnExpandableFields: true

Después en el código:

$bootstrap = Zend_Controller_Front::getInstance()->getParam('bootstrap');
$siteConfig = $bootstrap->getResource('modules')->offsetGet('klear')->getOption('siteConfig');

$property = $siteConfig->getDefaultCustomConfiguration('optionCollectionPlacement');

timezone¶

La base de datos, por defecto cuenta con la zona horaria UTC 0, pero para mostrar la fecha y hora, según a nuestra zona horaria, hay que modificar este apartado.

timezone: Europe/Madrid

General¶

El klear por defecto lista todas las tablas con el tag [entity], pero si llega a generarse por segunda vez los yaml, las nuevas tablas no se verán listadas en el klear/klear.yaml sino en klearRaw/klear.yaml.

menu:
  General:
    title: _("Main management")
    description: _("Main management")
    showOnlyIf: true|false
    meta: "literal que viajará hasta el atributo data-meta del elemento de menú."
    submenus:
      DevelopersList:
        title: ngettext('Developer', 'Developers', 0)
        class: ui-silk-text-list-bullets
        description: _("List of %s", ngettext('Developer', 'Developers', 0))
        showOnlyIf: true|false
        meta: "literal que viajará hasta el atributo data-meta del elemento de menú."

Sus opciones correspondientes son las siguientes: