Developing an MVC Component/Developing a Basic Component/pt-br: Difference between revisions

← Older edit

Latest revision as of 06:55, 22 January 2019

Joomla!

3.x

Tutorial

Desenvolvendo um Componente MVC

Artigos nessa Série

Adicionando uma parte view para o site

Adicionando uma parte tipo de menu para o site

Adicionando uma parte model para o site

Adicionando uma requisição de variável no tipo de menu

Usando o Banco de Dados

Backend básico

Adicionando o gerenciamento de linguagem

Adicionando ações de backend

Adicionando decorations para o backend

Adicionando verificações

Adicionando categorias

Adicionando configuração

Adicionando ACL (Lista de Controle de Acesso)

Adicionando um script de instalação/desinstalação/atualização

Adding a Frontend Form

Usando o recurso de filtro de idioma

Adicionando um servidor de atualização

Esta é uma série de vários artigos de tutoriais sobre como desenvolver um Componente Model-View-Controller para o Joomla! Version.

Comece com a Introdução, e navegue pelos artigos desta série usando o botão de navegação abaixo ou a caixa à direita ("Artigos desta série").

Notas

Este tutorial é parte do tutorial Desenvolvendo um Componente MVC para Joomla! 3.x. Recomendamos que você leias as partes anteriores desse tutorial antes de ler essa.

Se você já usou Joomla! Antes de ler este tutorial, você notou que as extensões são instaladas usando um arquivo compactado contendo todas as coisas que são necessárias para instalá-las e desinstalá-las.

Você pode seguir os passos abaixo para criar o Hello World! , Ou você pode baixar diretamente o arquivo archive

Aqui estão alguns slides com base nesses documentos para explicar do básico ao avançado os componentes Joomla!.
Joomla! Basic Component Help
Joomla! Advance Component Help

There are also a number of videos which accompany steps in the tutorial, beginning with
Step 1, Developing a Basic Component and you can access the slides which are used in the series of video presentations at Slides.

Important! Around version 3.8 the Joomla developers started changing the naming of Joomla classes and where they were stored in the directory structure. Many of the tutorial steps and videos refer to the old naming convention. To find the equivalent new class and where it's stored, look in your libraries/classmap.php file.

Como adicionar um componente ao Joomla!

Neste artigo vamos cobrir como criar e instalar um Componente Básico do Joomla!. Para este exemplo vamos trabalhar com o Componenente Hello World!.

Para começar, você deve primeiro usar seu gerenciador de arquivos preferido para criar uma pasta para o componente Hello World!. Este diretório pode ser em qualquer lugar do seu sistema de arquivos, contanto que seja fora do diretório de instalação do seu Joomla!. Para este exemplo vamos nomear o diretório com_helloworld, mas esse diretório pode ter qualquer nome.

Depois, precisamos criar alguns arquivos dentro deste diretório. Usando seu gerenciador de arquivos preferido, crie os seguintes arquivos; Enquanto você cria os arquivos, adicione o código-fonte para cada arquivo que está disponível em File Details.

1	helloworld.xml	Este é um arquivo XML (manifesto) que diz ao Joomla! Como instalar o nosso componente.
2	site/helloworld.php	Este é o ponto de entrada do site para o componente Hello World!
3	site/index.html	Impede que o servidor web liste o conteúdo do diretório
4	admin/index.html	Impede que o servidor web liste o conteúdo do diretório
5	admin/helloworld.php	Este é o ponto de entrada da área de administração do componente Hello World!
6	admin/sql/index.html	Impede que o servidor web liste o conteúdo do diretório
7	admin/sql/updates/index.html	Impede que o servidor web liste o conteúdo do diretório
8	admin/sql/updates/mysql/index.html	Impede que o servidor web liste o conteúdo do diretório
9	admin/sql/updates/mysql/0.0.1.sql	Arquivo que permite inicializar a versão de esquema de banco de dados do componente com_helloworld.

Instalando o Componente Hello World!

Usando seu gerenciador de arquivos preferido, crie um arquivo .zip desse diretório. Para este exemplo vamos nomear o arquivo com_helloworld.zip , novamente este arquivo poderia ter sido nomeado de qualquer forma.

Agora precisamos instalar o componente Hello World!. Há duas maneiras de fazer isso, ambos são abordados em Instalando uma extensão. Aqui vamos cobrir o método usando o Gerenciador de Extensão do Joomla!.

Usando o seu navegador preferido, navegue até o painel Administrador do seu Joomla! local. O endereço seria <yoursite>/joomla/administrator/index.php. Para este exemplo, navegaremos para localhost/joomla/administrator/index.php.
Clique em Extensões → Gerenciar → Instalar → Enviar Pacote de Arquivos → Escolha Arquivo
Navegar e Selecionar o Arquivo.zip
Clique em Enviar e instalar

Nota - Você verá uma mensagem informando se a instalação foi bem-sucedida ou falhou.

Você pode testar esta função básica do componente entrando na página do componente Hello World! da área do site e da área do administrador do seu Joomla!.

Usando seu navegador preferido, navegue até a área do componente Hello World! do site. O endereço pode ser algo como <yoursite>/joomla/index.php?option=com_helloworld. Para esse exemplo nos visitamos o endereço localhost/joomla/index.php?option=com_helloworld.
Usando seu navegador preferido, navegue até a área administrativa do componente Hello World!. O endereço pode ser algo como <yoursite>/joomla/administrator/index.php?option=com_helloworld. Para esse exemplo nos visitamos o endereço localhost/joomla/administrator/index.php?option=com_helloworld.

Você também irá notar que o componente Hello World! Está visível no área administrativa do Joomla no menu Componentes .

Detalhes de Arquivos

admin/sql/updates/mysql/0.0.1.sql É um arquivo vazio que permite inicializar a versão de esquema de banco de dados do componente com_helloworld.

helloworld.xml

<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.0" method="upgrade">

	<name>Hello World!</name>
	<!-- The following elements are optional and free of formatting constraints -->
	<creationDate>January 2018</creationDate>
	<author>John Doe</author>
	<authorEmail>john.doe@example.org</authorEmail>
	<authorUrl>http://www.example.org</authorUrl>
	<copyright>Copyright Info</copyright>
	<license>License Info</license>
	<!--  The version string is recorded in the components table -->
	<version>0.0.1</version>
	<!-- The description is optional and defaults to the name -->
	<description>Description of the Hello World component ...</description>

	<update> <!-- Runs on update; New since J2.5 -->
		<schemas>
			<schemapath type="mysql">sql/updates/mysql</schemapath>
		</schemas>
	</update>

	<!-- Site Main File Copy Section -->
	<!-- Note the folder attribute: This attribute describes the folder
		to copy FROM in the package to install therefore files copied
		in this section are copied from /site/ in the package -->
	<files folder="site">
		<filename>index.html</filename>
		<filename>helloworld.php</filename>
	</files>

	<administration>
		<!-- Administration Menu Section -->
		<menu link='index.php?option=com_helloworld'>Hello World!</menu>
		<!-- Administration Main File Copy Section -->
		<!-- Note the folder attribute: This attribute describes the folder
			to copy FROM in the package to install therefore files copied
			in this section are copied from /admin/ in the package -->
		<files folder="admin">
			<!-- Admin Main File Copy Section -->
			<filename>index.html</filename>
			<filename>helloworld.php</filename>
			<!-- SQL files section -->
			<folder>sql</folder>
		</files>
	</administration>

</extension>

site/helloworld.php

Hello World

admin/helloworld.php

Hello World administration

index.html

Comum a todas as pastas

<html><body bgcolor="#FFFFFF"></body></html>

Conteúdo do Componente

Neste ponto do tutorial, o componente deve conter os seguintes arquivos:

1	helloworld.xml	Este é um arquivo XML (manifesto) que diz ao Joomla! Como instalar o nosso componente.
2	site/helloworld.php	Este é o ponto de entrada do site para o componente Hello World!
3	site/index.html	Impede que o servidor web liste o conteúdo do diretório
4	admin/index.html	Impede que o servidor web liste o conteúdo do diretório
5	admin/helloworld.php	Este é o ponto de entrada da área de administração do componente Hello World!
6	admin/sql/index.html	Impede que o servidor web liste o conteúdo do diretório
7	admin/sql/updates/index.html	Impede que o servidor web liste o conteúdo do diretório
8	admin/sql/updates/mysql/index.html	Impede que o servidor web liste o conteúdo do diretório
9	admin/sql/updates/mysql/0.0.1.sql	Arquivo que permite inicializar a versão de esquema de banco de dados do componente com_helloworld.

General Information

Ant: Introdução

Prox: Adicionando uma view para o site.

@@ Line 1: / Line 1: @@
 <noinclude><languages /></noinclude>
 {{:J3.1:Developing an MVC Component/pt-br}}
-== Notes ==
+== Notas ==
-This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.
+Este tutorial é parte do tutorial [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Desenvolvendo um Componente MVC para Joomla! 3.x]]. Recomendamos que você leias as partes anteriores desse tutorial antes de ler essa.
-If you have used Joomla! before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.
+Se você já usou Joomla! Antes de ler este tutorial, você notou que as extensões são instaladas usando um arquivo compactado contendo todas as coisas que são necessárias para instalá-las e desinstalá-las.
-You can follow the steps below to create the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-1-basic-component.zip archive]
+<div class="mw-translate-fuzzy">
+Você pode seguir os passos abaixo para criar o Hello World! , Ou você pode baixar diretamente o arquivo [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-1-basic-component.zip archive]
+</div>
-Here are some slides based on this documents to explain how to create basic to advance Joomla! components.<br />
+<div class="mw-translate-fuzzy">
+Aqui estão alguns slides com base nesses documentos para explicar do básico ao avançado os componentes Joomla!.<br />
 [http://bit.ly/joomlaWorkshopBasic Joomla! Basic Component Help]<br />
 [http://bit.ly/joomlaWorkshopAdvance Joomla! Advance Component Help]
+</div>
-== How to add a component to Joomla! ==
+There are also a number of videos which accompany steps in the tutorial, beginning with<br />
-In this article we will cover how to create and install a basic Joomla! component. For this example we will be working with the Hello World! component.
+[https://www.youtube.com/watch?v=4JDsdfnlOhE Step 1, Developing a Basic Component] and you can access the slides which are used in the series of video presentations at [https://docs.google.com/presentation/d/11g6qd64zmQObe8xMuEVubdUeIp0DcZ1wr8dq7LcrXIA Slides].
-To begin, you must first use your preferred file manager to create a directory for the Hello World! component. This directory can be anywhere on your file system, as long as it outside of your Joomla! installation directory. For this example we will name the directory <tt>com_helloworld</tt>, but this directory can be named anything.
+'''Important! Around version 3.8 the Joomla developers started changing the naming of Joomla classes and where they were stored in the directory structure. Many of the tutorial steps and videos refer to the old naming convention. To find the equivalent new class and where it's stored, look in your libraries/classmap.php file.'''
-Next, inside this directory we need to create some files. Using your preferred file manager, create the following files; as you create the files, add the source code for each file which is found in ''[[#File Details| File Details]]''.
+{{#widget:YouTube|id=4JDsdfnlOhE}}
+== Como adicionar um componente ao Joomla! ==
+Neste artigo vamos cobrir como criar e instalar um Componente Básico do Joomla!. Para este exemplo vamos trabalhar com o Componenente Hello World!.
+<div class="mw-translate-fuzzy">
+Para começar, você deve primeiro usar seu gerenciador de arquivos preferido para criar uma pasta para o componente Hello World!. Este diretório pode ser em qualquer lugar do seu sistema de arquivos, contanto que seja fora do diretório de instalação do seu Joomla!. Para este exemplo vamos nomear o diretório <tt>com_helloworld</tt>, mas esse diretório pode ter qualquer nome.
+</div>
+Depois, precisamos criar alguns arquivos dentro deste diretório. Usando seu gerenciador de arquivos preferido, crie os seguintes arquivos; Enquanto você cria os arquivos, adicione o código-fonte para cada arquivo que está disponível em ''[[#File Details| File Details]]''.
 <!--T:28-->
@@ Line 23: / Line 36: @@
   | 1
   | ''[[#helloworld.xml|helloworld.xml]]''
-  | this is an XML (manifest) file that tells Joomla! how to install our component.
+  | Este é um arquivo XML (manifesto) que diz ao Joomla! Como instalar o nosso componente.
   |-
   | 2
   | ''[[#site/helloworld.php|site/helloworld.php]]''
-  | this is the site entry point to the Hello World! component
+  | Este é o ponto de entrada do site para o componente Hello World!
   |-
   | 3
   | ''[[#index.html|site/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 4
   | ''[[#index.html|admin/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 5
   | ''[[#admin/helloworld.php|admin/helloworld.php]]''
-  | this is the administrator entry point to the Hello World! component
+  | Este é o ponto de entrada da área de administração do componente Hello World!
   |-
   | 6
   | ''[[#index.html|admin/sql/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 7
   | ''[[#index.html|admin/sql/updates/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 8
   | ''[[#index.html|admin/sql/updates/mysql/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 9
   | ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
-  | file allowing to initialise schema version of the com_helloworld component.
+  | Arquivo que permite inicializar a versão de esquema de banco de dados do componente com_helloworld.
   |}
-=== Installing the Hello World! Component ===
+=== Instalando o Componente Hello World! ===
-Using your preferred file manager, create a .zip file of this directory. For this example we will name the file <tt>com_helloworld.zip</tt>, again this file could have been named anything.
+Usando seu gerenciador de arquivos preferido, crie um arquivo .zip desse diretório. Para este exemplo vamos nomear o arquivo <tt>com_helloworld.zip </tt>, novamente este arquivo poderia ter sido nomeado de qualquer forma.
-Now we need to install the Hello World! component. There are two ways to do this, both are covered in [[S:MyLanguage/Installing an extension|Installing an Extension]]. Here we will cover the method using the Extension Manager of Joomla!.
+Agora precisamos instalar o componente Hello World!. Há duas maneiras de fazer isso, ambos são abordados em [[S:MyLanguage/Installing an extension|Instalando uma extensão]]. Aqui vamos cobrir o método usando o Gerenciador de Extensão do Joomla!.
-*Using your preferred web browser, navigate to the Administrator panel of your Joomla! site. The address would be <tt><yoursite>/joomla/administrator/index.php</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php</tt>.
+* Usando o seu navegador preferido, navegue até o painel Administrador do seu Joomla! local. O endereço seria <tt><yoursite>/joomla/administrator/index.php</tt>. Para este exemplo, navegaremos para <tt>localhost/joomla/administrator/index.php</tt>.
-*Click Extensions {{rarr}} Manage {{rarr}} Install {{rarr}} Upload Package File {{rarr}} Choose File
+* Clique em Extensões {{rarr}} Gerenciar {{rarr}} Instalar {{rarr}} Enviar Pacote de Arquivos {{rarr}} Escolha Arquivo
-*Navigate and Select File
+* Navegar e Selecionar o Arquivo.zip
-*Click Upload & Install
+* Clique em Enviar e instalar
-Note - You should see a message letting you know if the installation succeeded or failed.
+Nota - Você verá uma mensagem informando se a instalação foi bem-sucedida ou falhou.
-You can test this basic function of the component by entering the Hello World! page for the site and administrator portions of your Joomla! website.
+Você pode testar esta função básica do componente entrando na página do componente Hello World! da área do site e da área do administrador do seu Joomla!.
-* Using your preferred web browser, navigate to the Hello World! component page located on the site portion of your website. The address would be <tt><yoursite>/joomla/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/index.php?option=com_helloworld</tt>.
+* Usando seu navegador preferido, navegue até a área do componente Hello World! do site. O endereço pode ser algo como <tt><yoursite>/joomla/index.php?option=com_helloworld</tt>. Para esse exemplo nos visitamos o endereço <tt>localhost/joomla/index.php?option=com_helloworld</tt>.
-* Using your preferred web browser, navigate to the Hello World! component page located on the administrator portion of your website. The address would be <tt><yoursite>/joomla/administrator/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php?option=com_helloworld</tt>.
+* Usando seu navegador preferido, navegue até a área administrativa do componente Hello World!. O endereço pode ser algo como <tt><yoursite>/joomla/administrator/index.php?option=com_helloworld</tt>. Para esse exemplo nos visitamos o endereço <tt>localhost/joomla/administrator/index.php?option=com_helloworld</tt>.
-You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.
+Você também irá notar que o componente ''Hello World! '' Está visível no área administrativa do Joomla no menu '' Componentes ''.
-==File Details==
+== Detalhes de Arquivos ==
 {{vanchor|admin/sql/updates/mysql/0.0.1.sql}}
-is an empty file allowing to initialise schema version of the com_helloworld component.
+É um arquivo vazio que permite inicializar a versão de esquema de banco de dados do componente com_helloworld.
 <source lang="sql">
@@ Line 87: / Line 100: @@
 <source lang="xml">
 <?xml version="1.0" encoding="utf-8"?>
-<extension type="component" version="3.2.0" method="upgrade">
+<extension type="component" version="3.0" method="upgrade">
 	<name>Hello World!</name>
 	<!-- The following elements are optional and free of formatting constraints -->
-	<creationDate>December 2013</creationDate>
+	<creationDate>January 2018</creationDate>
 	<author>John Doe</author>
 	<authorEmail>john.doe@example.org</authorEmail>
@@ Line 150: / Line 163: @@
 {{vanchor|index.html}}
-common to all folders
+Comum a todas as pastas
 <source lang="html4strict">
@@ Line 156: / Line 169: @@
 </source>
-==Component Contents==
-At this point in the tutorial, your component should contain the following files:
+== Conteúdo do Componente ==
+Neste ponto do tutorial, o componente deve conter os seguintes arquivos:
 {| border=1
   | 1
   | ''[[#helloworld.xml|helloworld.xml]]''
-  | this is an XML (manifest) file that tells Joomla! how to install our component.
+  | Este é um arquivo XML (manifesto) que diz ao Joomla! Como instalar o nosso componente.
   |-
   | 2
   | ''[[#site/helloworld.php|site/helloworld.php]]''
-  | this is the site entry point to the Hello World! component
+  | Este é o ponto de entrada do site para o componente Hello World!
   |-
   | 3
   | ''[[#index.html|site/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 4
   | ''[[#index.html|admin/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 5
   | ''[[#admin/helloworld.php|admin/helloworld.php]]''
-  | this is the administrator entry point to the Hello World! component
+  | Este é o ponto de entrada da área de administração do componente Hello World!
   |-
   | 6
   | ''[[#index.html|admin/sql/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 7
   | ''[[#index.html|admin/sql/updates/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 8
   | ''[[#index.html|admin/sql/updates/mysql/index.html]]''
-  | prevents web server from listing directory content
+  | Impede que o servidor web liste o conteúdo do diretório
   |-
   | 9
   | ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
-  | file allowing to initialise schema version of the com_helloworld component.
+  | Arquivo que permite inicializar a versão de esquema de banco de dados do componente com_helloworld.
   |}
-{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}
+{{notice|<div class="mw-translate-fuzzy">
+Crie um pull request (requisição) ou informe um problema (issue) em  https://github.com/joomla/Joomla-3.2-Hello-World-Component para quaisquer discrepâncias de código ou se estiver editando qualquer código-fonte desta página.
+</div>}}
 <div class="row">
-<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Prev: Introduction|class=expand success}}</div>
+<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Ant: Introdução|class=expand success}}</div>
-<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part|class=expand}}</div>
+<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Prox: Adicionando uma view para o site.|class=expand}}</div>
 </div>
 __NOTOC__

J3.x