Dolibarr ERP CRM Wiki - User contributions [en]

Canvas development

2012-11-06T22:37:34Z

Chaos8028: /* Replace a creation form with your own template */

{{TemplateDocDevEn}}

Canvas is a developer feature to replace screens to create, update or view a card (products, thirdparties, contacts, ...).

For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.

= Conditions =
Canvas feature is available with Dolibarr 3.2 or higher.

It is for the moment available only for :
* '''create''' form of '''products''', '''contacts''' and '''third parties'''
* '''edit''' form of '''products''', '''contacts''' and '''third parties'''
* '''view''' tab of '''products''', '''contacts''' and '''third parties'''. In most cases, it's only the first tab when you open the card of an object. But you can have a look at new module creation documentation [[Module_development#The_tab_management]] to know how to disable other tabs or add yours if you really want to change other tabs too.

= Replace a creation form with your own template =
First thing to do is to find the URL of standard creation form you want to replace and add the parameter '''canvas=mymodule@mycanvas'''. To find url, you can go on page and get URL found at top of your browser.

For example, imagine you want to replace the creation form of third parties with your own form. The url is something like

'''http://mydomain/societe/soc.php?action=create&leftmenu=customers'''

After adding the canvas parameter, URL will look like

'''http://mydomain/societe/soc.php?action=create&leftmenu=customers&canvas=mycanvas@mymodule'''

When you add a parameter canvas=mycanvas@mymodule on a create page, Dolibarr will use the template file into htdocs called

'''/''mymodule''/canvas/''mycanvas''/tpl/''tabname''_create.tpl'''

where
* '''mymodule''' directory is value mymodule found into canvas parameter (you choose this value and create directory with same value. use lower case values).
* '''mycanvas''' is value mycanvas found into canvas parameter (you choose this value and create directory with same value. use lower case value).
* '''tabname''' is name of tab or page where initial form was stored. In most cases it is value "card".

For example, we will use value "'''societe@company'''" for canvas parameter. This is a value of an already coded demo canvas template for third parties, not used in a standard usage of Dolibarr but provided as "demo". So URL to create a third party using this alternative template is now:

'''http://mydomain/societe/soc.php?action=create&leftmenu=customers&canvas=societe@company'''

This means the form to create the third party will be found into template file:

'''/societe/canvas/company/tpl/card_create.tpl'''

So to use you own template, just choose a value for '''mymodule''', '''mycanvas''', copy and paste a demo template found into Dolibarr directories with new directory and new file name and then edit the template like you want. Template contains all the part under the top menu and at right of left menu. You can change look, field order, add your javascript controls, remove or add your own fields. The only requirement is to keep mandatory fields with same name to avoid errors when you will submit the page. Fields removed will be filled with null or 0 into database. New fields for the moment are ignored. We will see later how we can add code to save them.

Once this is done, you must now add the new create URL into Dolibarr menus or replace the existing one with new one. For this take a look at page [[Menus_system]].

Note that when a record is saved using a canvas, the canvas name '''mymodule@mycanvas''' is also stored into database. This is important because this means, Dolibarr will be able to know that this record is a canvas and not the other so it will be able to them suggest a view or edit form dedicated for this record only and keep using standard forms for other records. See next chapters.

= Replace an edit form with your own template =
Using your own edit form for a record saved using your own create form is as simple as adding a file called

'''/mymodule/canvas/mycanvas/tpl/tabname_edit.tpl'''

where
* '''mymodule''' directory is value mymodule you used as canvas parameter to create record (see previous chapter).
* '''mycanvas''' is value mycanvas you used as canvas parameter to create record (see previous chapter).
* '''tabname''' is name of tab or page to edit record. In most cases it is value "card".

With our canvas demo societe@company, edit template will be into file

'''/societe/canvas/company/tpl/card_edit.tpl'''

Note that for edit, changing URL is not necessarly required. Dolibarr can detect your record is a personalized canvas record and automatically scan for this template file to show it if found. If not, standard form will be used. So all you have to do to use your own edit template is copy and paste an existing demo edit template file and rename it with correct value of mymodule and mycanvas and edit it to match your need.
Like for creation, all mandatory fields must be kept to avoid errors when submitting the form to save change.

= Replace a view form with your own template =
Using your own view form for a record saved using your own create form is as simple as adding a file called

'''/mymodule/canvas/mycanvas/tpl/tabname_view.tpl'''

where
* '''mymodule''' directory is value mymodule you used as canvas parameter to create record (see previous chapter).
* '''mycanvas''' is value mycanvas you used as canvas parameter to create record (see previous chapter).
* '''tabname''' is name of tab or page to edit record. In most cases it is value "card".

With our canvas demo societe@company, view template will be into file

'''/societe/canvas/company/tpl/card_view.tpl'''

Note that for view, changing URL is not necessarly required. Dolibarr can detect your record is a personalized canvas record and automatically scan for this template file to show it if found. If not, standard form will be used. So all you have to do to use your own view template is copy and paste an existing demo view template file and rename it with correct value of mymodule and mycanvas and edit it to match your need.

= Add code to manage new fields =
{{ToComplete}}
Example into external module cabinetmed.

Hooks system

2012-07-14T17:29:03Z

Chaos8028:

{{TemplateDocDevEn}}

Hooks is a developer feature, available with Dolibarr 3.2 and more, to allow developer to add personalized code intod Dolibarr core code with no need to patch Dolibarr.
On the contrary to the [[triggers]] (another feature to interact with Dolibarr code) which are by definition linked to a business action, hooks can happen anywhere at anytime, they are entry points into the program.
* Hooks work by context (ie the module, eg: "productcard" for products, "invoicecard" for invoices, etc..). It's easy to find them, just search for "'''initHooks('''" into php files.
* Hooks are functions that can be overloaded by your own. You decide if your code is added to standard Dolibarr code or if it replace Dolibarr code. You can find overloadable functions by searching for "'''executeHooks('''"

= Implementation =

To use a hook (add or replace a part of code), you first need to already have defined a module (see the wiki for that), and then you need to do 2 things:

1- add your module to the list of contexts you want to hook on.
This means that when a context you hook will happen, your module hook code will be called.
To do that, just edit your '''/htdocs/''yourmodulename''/modules/mod''YourModuleName''.class.php''' and edit the '''$this->module_parts''' variable with something like this:
<source lang="php">
$this->module_parts = array(
'hooks' => array('hookcontext1','hookcontext2') // Set here all hooks context managed by module
);
</source>

Of course change YourModuleName with your own module's name.

'''IMPORTANT''': Be careful: do not forget to DISABLE then RENABLE the module in the admin panel to accept the new context, because these constants are only added to the database when enabling the module.

2- You will overload a hook (a function) with your own.

Create a file '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' and then put something like this:

<source lang="php">
<?php

class ActionsYourModuleName // extends CommonObject
{

/** Overloading the doActions function : replacing the parent's function with the one below
* @param parameters meta datas of the hook (context, etc...)
* @param object the object you want to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
* @param action current action (if set). Generally create or edit or null
* @return void
*/
function doActions($parameters, $object, $action)
{
print_r($parameters);
echo "action: ".$action;
print_r($object);

if ($parameters->context == 'somecontext')
{
// do something only for the context 'somecontext'
}
}
}
</source>

where
* '''$parameters''' is an array of meta-data about the datas contained by the hook (eg: the context, always accessible by $parameters->context).
* '''$object''' is the object that you may work on. Eg: the product if you are in the productcard context.
* '''$action''' is the action if one is conveyed (generally "create", "edit" or "view").

Your function should now be called when you access the module/context and you will see the parameters and object and action.

= List of available Hooks =
How to find a complete list of all available hooks ?
Just search for "'''executeHooks('''" through the code and you should easily find all the hooked methods calls.

This is however a small list of them (not complete):
{{ListOfHooks}}
...

= See also =
* [[Triggers]]
* [[Interfaces Dolibarr toward foreign systems]]
* [[Interfaces from foreign systems toward Dolibarr]]

Documentación Desarrolladores

2011-10-24T00:19:51Z

Chaos8028:

= Información general =
Este capítulo incluye información general que es necesaria leer antes de comenzar cualquier desarrollo en Dolibarr.
# [[Proyecto Dolibarr]]
# [[Antes de Empezar|A saber antes de empezar]]
# [[Herramientas de Desarrollo|Entorno y Herramientas de desarrollo]]
# [[Librerías externas y dependencias]]
# [[Recuperar, actualizar GIT fuentes del proyecto|Recuperar una versión desde los fluentes]]

= Normas de Desarrollo =
# [[Lenguaje y Normas de Desarrollo|Lenguaje y normas de desarrollo]]

= La Base de datos =
# [[Carta de nomenclaturas]]
# [[:Category:Table SQL|Listado de tablas]]

= Listado de módulos existentes =
La documentación específica de un módulo funcional estándar de Dolibarr se encuentra en la página del módulo.

* El listado de módulos estándar está disponible en la página [[:Category:Listado de Módulos|Listado de Módulos]]
* El Listado de módulos complementarios se encuentra en la página [[:Category:Módulos_complementarios|Módulos complementarios]]

= Desarrollar un nuevo módulo/extensión para el GUI (nuevas pantallas) =
Esta sección describe cómo desarrolllar un nuevo módulo sobre la interfaz de usuario de Dolibarr (GUI). Un módulo para IHM contiene tanto pantallas como datos propios y una hoja de estilo. El desarrollo del script no entra en esta parte y está descrito en el capítulo siguiente. El desarrollo de módulos de numeración, de documentos, de temas o de disparadores también se describe en los capítulos siguientes.

Para desarrollar tu propio módulo de extensión de GUI, ve al tutorial: [[Desarrollo de un módulo]]

= Desarrollar un script en línea de comandos o lote =
Esta sección describe cómo desarrollar su propio script de comandos por lotes para realizar procesos en Dolibarr (lectura, escritura, etc.).
La realización de modificaciones del interfaz de usuario (GUI) no entra dentro de este perímetro. Véase el capítulo anterior para ello.

Para desarrollar un script de comandos de cualquier tipo, tales como un script de proceso o un script para importar los datos desde otro sistema, consulte la página: [[Desarrollo de scripts]]

= Técnica sistemas de Dolibarr =
== Árbol de archivos ==
La jerarquía de los archivos de la versión actual es visible en la [http://www.dolibarr.org/html_doxygen/index.html documentación doxygen de los fuentes].

Sin embargo, las rutas a usar para añadir sus archivos en la creación de un nuevo módulo son descritas en la documentación para el desarrollo de un nuevo módulo (ver más abajo).

== El Sistema de Parametrización ==
Existen 3 niveles de parametrización en Dolibarr.
* La configuración técnica de Dolibarr (modo de autentificación en la aplicación, identificador de la base de datos y la localización del espacio de almacenamiento de ficheros) está definida en el fichero único de configuración conf/conf.php. Ver [[Fichero de configuración]] para más información.
* El global se guarda en la [[Table llx_const]]. Ver la página [[ConstantesES|Constantes]].
* La parametrización propia a un usuario se guarda en la [[Table llx_user_param]]. Ver la página [[ConstantesES|Constantes]].

== Los objetos de negocio ==
Ver la página [[Objetos de negociado]]

== El Sistema de menús ==
Ver la página [[Sistema de menús]]

== El Sistema de pestañas ==
Ver la página [[Sistema de pestañas]]

== El Sistema de temas ==
Ver la página [[Temas]]

== El Sistema de paneles ==
Ver la página [[Sistema de paneles]]

== El Sistema de autenticación ==
Ver la página [[Autentificación]]

== El Sistema de permisos ==
Ver la página [[Permisos]]

== El Sistema de traducción ==
Ver la página [[Sistema de traducción]]

== La Gestión de errores ==
Ver la página [[Gestión de errores]]

== El sistema Canvas (sobrecarga de pantallas) ==
Canvas es una funcionalidad destinada a desarrolladores para reemplazar a las pantallas de creación, actualización o visualización de fichas (productos, terceros, contactos, ...). Por ejemplo, puede reemplazar el formulario de creación de terceros, el de actualización o el de visualización.

Vea la página [[Desarrollo Canvas]]

== El sisteme Triggers ==
Ver [[Interfaces Dolibarr hacia el exterior|Interfaces y enlaces con otras aplicaciones]].

== El sistema Hooks ==
Vea la página [[El sistema Hooks]]

== Services Web ==
Ver [[Módulo Services Web]]

== El almacenamiento de ficheros/documentos ==
Ver la página [[Documentos generados]]

== Los módulos de numeración ==
Para cada entidad creada en la aplicación, Dolibarr le asigna una referencia. Con el fin de adaptar la referencia a cualquier uso, Dolibarr utiliza módulos para definir la regla de generación de esta referencia. Los módulos se suministran como estándar, por lo tanto, algunos son genéricos y se utilizan para definir la máscara de numeración (x número de caracteres, con o sin prefijo, incluyendo la fecha o no, etc), pudiendo satisfacer la mayoría de las necesidades. Sin embargo, aún hay casos en los que el módulo estándar incluido no responde a la necesidad. En este caso es necesario para desarrollar su propio módulo de numeración.

Más información en la página [[Crear un módulo de numeración]]

== Los modelos y la generación de documentos ==
Información referente a la generación de documentos desde modelos disponible en la página [[Crear un modelo de documento PDF]] o [[Crear un modelo de documento ODT]]

= Las exportaciones/importaciones en masa =
#[[Importaciones|Importaciones en masa]]
#[[Exportaciones|Exportaciones en masa]]

= Interfaces y enlaces con otras aplicaciones =
# [[Interfaces Dolibarr hacia el exterior]] (Triggers Dolibarr)
# [[Interfaces del Exterior hacia Dolibarr]]
# [[Módulo Services Web|Services Web]]

= FAQ =
Todos los FAQ se encuentran disponibles desde la página índice [[:Category:FAQ ES|FAQ ES]]

Objetos de negociado

2011-10-24T00:09:21Z

Chaos8028:

{{TemplateDocDesarrollo}}
= Objetos de negocio =
Todos los objetos de negocio se definen mediante clases PHP que hereda de la clase CommonObject (definida en el archivo commonobject.class.php).
Todos los objetos de negocio tienen los 4 métodos CRUD:
* Creación: create()
* Lectura: fetch()
* Actualización: update()
* Borrado: delete()

= Objetos de negocio vinculados =
Algunos objetos de negocio se encuentran vinculados con otros. En Dolibarr esto se hace usando la [[Table llx_element_element]]. Pero no tiene que leer esta tabla para obtener objetos vinculados a otro.
Este es un trozo de código que le muestra como hacerlo:
<source lang="php">
// Cargamos el array linked_object con objetos que se vinculan con uno
$object->load_object_linked($object->id, $object->element);

// Elegimos id con los objetos del tipo que necesitamos
$org_order_array = $object->linked_object["commande"];

// Lo usamos
$thelinkedobjectid = $org_order_array[0];
// creamos una instancia de pedido
$thelinkedobject = new Commande($object->db);
// Cargamos el objeto
$thelinkedobject->fetch($thelinkedobjectid);
</source>

= Ejemplos =
== Ejemplo para la creación de un tercero ==
He aquí un ejemplo para la creación de un tercero (empresa cliente, por ejemplo):

Si se encuentra en el caso de un script externo a Dolibarr, antes de nada es necesario realizar un inicio.

<source lang="php">
include('/pathofdolibarrhtdocs/master.inc.php');
</source>
para que el entorno Dolibarr (objetos $conf, $db, $lang y $user sean creados). Si queremos que las acciones (creación, actualización), se asocien a un usuario en particular, es necesario hacerlo despues del include de master.inc.php
<source lang="php">
$user->fetch(0,'loginuser');
</source>

Seguidamente, podremos realizar nuestras acciones.
<source lang="php">
// Declaramos la clase que vamos a manipular
include_once('/pathofdolibarrhtdocs/societe/class/societe.class.php');

// Creamos una instancia del objeto a manipular
$mycompany = new Societe($db);

// Indicamos sus características
$mycompany->nom='Big Brother';
$mycompany->client=1;

// Si queremos que la acción de creación se asocie a un usuario 'loginuser' en particular,
// hay que descomentar esta linea para cambiar las caracteriísticas de este usuario.
// Si lo dejamos comentado, Dolibarr meterá un null en los campos de usuario de creacion o actualización.
// $user->fetch('loginuser');

// Llamamos a la creación
$id=$mycompany->create($user);

// Para cambiar el objeto
$mycompany->fetch($id);

// Para actualizar
$mycompany->nom='Big Brother 2';
$mycompany->update($user);
</source>

== Otros ejemplos ==
Encontrará otros ejemplos de manipulación de objetos Dolibarr (Creación, Lectura, Modificación, Eliminación) en el directorio '''dev/samples''' del snapshot de Dolibarr.