Manual:Code/pt-br

From MediaWiki.org
Jump to navigation Jump to search

Esta página descreve os arquivos chave e diretórios no código-fonte do MediaWiki. Para informações mais detalhadas, consulte a classe, o arquivo e as referências completas geradas automaticamente a partir do código fonte do MediaWiki usando o doxygen.

Pontos de acesso[edit]

Veja também: Special:Version#URLs dos pontos de entrada

Nota Nota: Essa lista pode ser gerada automaticamente ao executar: git grep -l /includes/WebStart.php.[AP 1][AP 2]

Estes são os arquivos que um navegador pode alcançar ao usar o wiki. Todos eles estão localizados no diretório raiz do wiki, e cada um deles está emparelhado com um envoltório .php5, para servidores web que exigem a extensão .php5 para executar scripts com o motor PHP5.

Arquivo Descrição Documentação
index.php Ponto de acesso principal para o software MediaWiki. Ele lida com a maioria dos pedidos feitos ao MediaWiki. Manual:index.php
api.php Ponto de acesso externo para a API do MediaWiki. Veja API:Main page. Manual:api.php
load.php Script para o front-end utilizar hooks para carregar módulos do ResourceLoader. Manual:load.php
img_auth.php Script que só serve de imagens para usuários logados. Para configurar o wiki para usar esse script, consulte Manual:Image Authorisation. Manual:img_auth.php
opensearch_desc.php Retorna um documento de descrição OpenSearch que descreve a interface web de motores de busca do MediaWiki. Manual:opensearch_desc.php
profileinfo.php Permite que os usuários vejam as informações de perfil que são armazenadas no banco de dados. Consulte Manual:How to debug#Profiling. Manual:profileinfo.php
redirect.php Script que redireciona para o artigo passado no parâmetro wpDropdown da solicitação. Necessário para a skin Nostalgia Manual:redirect.php
thumb.php Script usado para redimensionar imagens Manual:thumb.php
thumb_handler.php Script PHP para ser usado como um manipulador de páginas 404 para criar e transmitir uma miniatura da imagem ainda não existente. Manual:thumb_handler.php
trackback.php Adiciona trackbacks ao banco de dados. Removido no MediaWiki 1.19 (r104051). Manual:trackback.php
  1. Exceto o arquivo thumb_handler.php, que é um envoltório simples em torno do arquivo thumb.php e, portanto, não tem que voltar a incluir WebStart.php
  2. Esse comando também retorna mw-config/index.php, mas, ao contrário dos outros processos, não se destina a uma utilização repetida durante a operação normal wiki; em outras palavras, não é um ponto de acesso para alcançar recursos wiki, mas um roteiro único para iniciar o processo de configuração de um wiki recém-instalado.

/cache/[edit]

Local padrão para o cache de arquivos, se habilitado (definindo $wgUseFileCache = true; — o padrão é false.). Esta localização pode ser personalizada usando a variável $wgFileCacheDirectory.

/docs/[edit]

Contém vários arquivos de texto que deverão ajudá-lo a entender as partes mais importantes do código do MediaWiki.

/extensions/[edit]

As extensões do Mediawiki são distribuídas separadamente do código do núcleo. Instalar uma extensão implica copiar seus arquivos para este diretório, e permiti-lo seguir as próprias instruções de instalação da extensão (geralmente editando o arquivo LocalSettings.php). Por padrão, esse diretório está vazio em uma nova instalação MediaWiki, contendo apenas um arquivo LEIA-ME.

/includes/[edit]

Este diretório armazena arquivos include comuns necessários para o MediaWiki.

Arquivo Descrição Documentação
Article.php Contém a classe Article, que fornece métodos para visualizar, modificar e gerenciar artigos. Ele mantém funções do WikiPage para compatibilidade com versões anteriores. Manual:Article.php
AutoLoader.php Define o manipulador de carregamento automático para um framework do MediaWiki. Manual:AutoLoader.php
Defines.php Define várias constantes, tais como as de namespaces, que são usadas ​​por outros arquivos e classes. Manual:Defines.php
EditPage.php Fornece grande parte do código relacionado com a interface de edição de usuário. Manual:EditPage.php
GlobalFunctions.php Contém funções usadas globalmente como wfMsgExt. Manual:GlobalFunctions.php
Linker.php Contém métodos para criar links internos, externos ou de imagem, e implementa a detecção de existência de página Manual:Linker.php
Message.php Fornece métodos para: mensagens de interface de busca; processando mensagens em uma variedade de formatos. Consulte Manual:Messages API. Manual:Message.php
OutputPage.php Mantém o HTML e a análise de wikitexto. Também gerará o elemento <head> ou parte dele. Manual:OutputPage.php
Pager.php Contém a classe IndexPager utilizada para resultados de paginação de consultas MySQL. Manual:Pager.php
Parser.php Contém a maior parte do código que converte wikitexto em HTML (embora alguns pedaços estejam em Manual:Skin.php). Manual:Parser.php
Setup.php Inclui ​​arquivos comumente usados e inicializa as variáveis ​​de objeto globais de modo que o MediaWiki possa funcionar. Manual:Setup.php
Skin.php Encapsula um "look and feel" para o wiki. Manual:Skin.php
SpecialPage.php Contém a classe SpecialPage, que é a classe pai para todas as classes especiais de páginas. Ele também disponibiliza várias funções estáticas para lidar com a lista de páginas especiais e várias outras classes de página especial, como RedirectSpecialPage e IncludableSpecialPage. Consulte Manual:Special pages. Manual:SpecialPage.php
SiteStats.php Contém a classe SiteStats para as estatísticas do site e assuntos relacionados. Manual:SiteStats.php
Title.php Representa o título de um artigo, e faz todo o trabalho de tradução entre várias formas, como texto puro, URL, chave de banco de dados, etc. Por conveniência, e por razões históricas, também representa algumas características dos artigos que não envolvem seu texto, tais como os direitos de acesso. Manual:Title.php
User.php Encapsula o estado do usuário que está visualizando ou usando o site. Pode ser consultado para coisas como as configurações do usuário, nome, etc. Lida com os detalhes de obtenção e salvamento da tabela de usuários do banco de dados, e lida com as sessões e cookies. Manual:User.php
UserMailer.php Coleção de funções estáticas para envio de e-mail. Manual:UserMailer.php
WebRequest.php Contém a definição da classe WebRequest Manual:WebRequest.php
WebStart.php Efetua a configuração inicial para um pedido de web: faz verificações de segurança, carrega os arquivos LocalSettings.php e Setup.php. Manual:WebStart.php
MediaWiki.php Contém a definição da classe MediaWiki. Manual:MediaWiki.php
PathRouter.php A classe usada para transformar URLs "bonitas" em argumentos de consulta que o MediaWiki pode usar. Manual:PathRouter.php
WikiPage.php Contém a classe WikiPage, que representa uma página no wiki. Manual:WikiPage.php

/includes/actions/[edit]

Este diretório contém as classes Action, que lidam com as diferentes ações que podem ser realizadas em páginas (p.ex. visualização, exclusão, edição, etc.). Todas essas classes estendem as classes Action, FormlessAction ou FormAction. Algumas delas são apenas esboços que exigem métodos nas classes Article ou EditPage para realizar a tarefa atual.

Arquivo Descrição Documentação
CreditsAction.php Manipula a formatação dos créditos para artigos. Veja também Manual:$wgMaxCredits. Manual:CreditsAction.php
DeleteAction.php Manipula a exclusão de páginas.. Manual:DeleteAction.php
EditAction.php Contêm as classes EditAction e SubmitAction que lidam com as ações de edição e apresentação. Manual:EditAction.php
HistoryAction.php Manipulam a impressão de histórico de página para um artigo. Manual:HistoryAction.php
InfoAction.php Exibe informações sobre a página, como o número total de edições e número de editores únicos. Manual:InfoAction.php
MarkpatrolledAction.php Lidam com a marcação de uma revisão como patrulhada. Manual:MarkpatrolledAction.php
ProtectAction.php Lida com a proteção de uma página. Manual:ProtectAction.php
PurgeAction.php Lida com a purgação de uma página. Manual:PurgeAction.php
RawAction.php Lida com a ação "action=raw". Manual:RawAction.php
RenderAction.php Manipula a ação renderizar, o que mostra uma renderização do HTML da página; semelhante à ação visualizar, mas apenas o texto do artigo sem estilização é mostrado, e não as caixas de ferramentas adicionais, caixas de pesquisa, folhas de estilo, etc. Manual:RenderAction.php
RevertAction.php Contêm a classe RevertFileAction, que lida com a reversão de um arquivo. Manual:RevertAction.php
RevisiondeleteAction.php Manipula a ação de revisão de exclusão apenas passando o pedido para a página especial Special:RevisionDelete. Manual:RevisiondeleteAction.php
RollbackAction.php Lida com a reversão de edição de uma página. Manual:RollbackAction.php
ViewAction.php Lida com a visualização de uma página, chamando Article::view(). Manual:ViewAction.php
WatchAction.php Contém as classes WatchAction e UnwatchAction, que lidam com as ações vigiar e não vigiar em uma página. Manual:WatchAction.php

/includes/api/[edit]

Este diretório contém o código para a API do MediaWiki. Veja API:Main page. Os arquivos mais importantes são:

Arquivo Descrição Documentação
ApiBase.php A classe base para todas as classes da API. Tem vários códigos comuns para todas as ações da API. Herda a classe ContextSource Manual:ApiBase.php
ApiFormatBase.php A classe base para todas as classes de formatação. Herda a classe ApiBase. Manual:ApiFormatBase.php
ApiQueryBase.php A classe base para todas as classes de consulta da API. Herda a classe ApiBase. Manual:ApiQueryBase.php

/includes/cache/[edit]

Este diretório contém arquivos com código comunitário relativo aos mecanismos de caching do MediaWiki.

Arquivo Descrição Documentação
FileCacheBase.php A classe FileCacheBase é a classe base para classes que fornecem um esquema de cache baseado em arquivos. Veja Manual:File cache. Manual:FileCacheBase.php
GenderCache.php Armazena em cache os sexos de usuários, quando necessário, para usar aliases de namespace corretos. Manual:GenderCache.php
HTMLCacheUpdate.php Invalida o cache de HTML de todas as páginas com links para um determinado título. Manual:HTMLCacheUpdate.php
HTMLFileCache.php Cache baseada em arquivo de páginas HTML. Manual:HTMLFileCache.php
LinkBatch.php A classe LinkBatch, que representa uma lista de títulos. Manual:LinkBatch.php
LinkCache.php Armazenamento em cache para títulos de artigos (chaves de banco de dados prefixadas) e IDs com links a partir uma única fonte. Veja também LINKCACHE.TXT. Manual:LinkCache.php
MemcachedSessions.php Este arquivo é incluído se a variável $wgSessionsInMemcache é definido na configuração. Ele redireciona funções de manipulação de sessão para armazenar seus dados no memcached em vez do sistema de arquivos local. Manual:MemcachedSessions.php
MessageCache.php Executa várias funções relacionadas ao namespace MediaWiki. Manual:MessageCache.php
ObjectFileCache.php Armazenamento em cache de objetos baseado em arquivo. Manual:ObjectFileCache.php
ResourceFileCache.php Armazenamento em cache baseado em arquivo de recursos JavaScript e CSS. Manual:ResourceFileCache.php
SquidUpdate.php Lida com a purga apropriada de URLs Squid dado um título (ou títulos). Manual:SquidUpdate.php

/includes/context/[edit]

Este diretório contém algumas classes relacionadas a contextos (pedidos). A partir da versão 1.18 do MediaWiki o contexto de um pedido é encapsulado no interior de uma instância RequestContext que implementa IContextSource. Um contexto é uma forma de agrupamento das partes de um pedido. Isto reduz a necessidade de variáveis globais. Veja Manual:RequestContext.php para mais informações.

Arquivo Descrição Documentação
ContextSource.php A classe ContextSource implementa a inerface IContextSource. É uma classe auxiliar: fazendo uma classe estender ContextSource, a classe será fornecida com os vários auxiliares getOutput, getSkin, getLanguage, etc. diretamente e implementará IContextSource. Manual:ContextSource.php
DerivativeContext.php DerivativeContext é uma implementação de IContextSource que irá herdar contexto de outra fonte, mas permite que peças individuais de contexto sejam alteradas localmente. Manual:DerivativeContext.php
IContextSource.php Este arquivo contém a interface IContextSource. Esta interface deve ser implementada por objetos que fornecem um contexto sobre o pedido. Manual:IContextSource.php
RequestContext.php Um objeto RequestContext agrupa todas as partes relevantes para o contexto de um pedido dentro de uma instância. Manual:RequestContext.php

/includes/db/[edit]

Este diretório contém o código para suporte de banco de dados. O arquivo Database.php fornece a camada de abstração do banco de dados do MediaWiki.

/includes/diff/[edit]

Este diretório contém o motor diff padrão do MediaWiki. Um motor de diff calcula a diferença entre dois textos. Se este motor diff é usado ou alguma ferramenta de comparação externo, depende da configuração de $wgExternalDiffEngine.

Arquivo Descrição Documentação
DairikiDiff.php O motor diff DairikiDiff. Atualmente, o motor diff padrão. O arquivo define várias classes relacionadas. Manual:DairikiDiff.php
DifferenceEngine.php A classe DifferenceEngine é a interface entre o MediaWiki e qualquer motor diff que é utilizado. O motor diff que é usado depende da opção de configuração $wgExternalDiffEngine. Manual:DifferenceEngine.php
WikiDiff3.php Outro motor diff. Atualmente não está em uso. Manual:WikiDiff3.php

/includes/job/[edit]

Arquivos relacionados à fila de tarefas. Cada classe de trabalho para um tipo específico de trabalho deriva da classe Job e tem que implementar um método run() que faz a tarefa atual.

Arquivo Descrição Documentação
DoubleRedirectJob.php Tarefa para corrigir redirecionamentos duplos após mover uma página. Manual:DoubleRedirectJob.php
EnotifNotifyJob.php Tarefa de notificação de e-mail. Manual:EnotifNotifyJob.php
JobQueue.php Contém a classe Job. Esta é a classe abstrata para descrever um tarefa em segundo plano. A classe também contém funções estáticas para processar as tarefas (insere tarefas na fila e aciona essas tarefas a partir da fila). Manual:JobQueue.php
RefreshLinksJob.php Contém as classes RefreshLinksJob e RefreshLinksJob2 para tarefas de atualização de links para um determinado título. Eles usam a classe LinksUpdate (definida em /includes/LinksUpdate.php) para atualizar várias tabelas de banco de dados. Manual:RefreshLinksJob.php
UploadFromUrlJob.php Tarefa para upload assíncrono por URL. É uma interface para a classe UploadFromUrl em /includes/upload/UploadFromUrl.php. Manual:UploadFromUrlJob.php

/includes/logging/[edit]

Alguns arquivos relacionados a registros dos eventos que acontecem em um Wiki. Este diretório foi introduzido na versão 1.19. Alguns dos arquivos já estavam presentes em versões mais antigas, no diretório includes/.

Arquivo Descrição Documentação
LogEntry.php Contém a interface LogEntry e algumas classes que implementam essa interface para encapsular entradas de log. Introduzido na versão 1.19. Manual:LogEntry.php
LogEventsList.php Uma classe para listar entradas de log. Manual:LogEventsList.php
LogFormatter.php Contém várias classes para a formatação de entradas de log. Introduzido na versão 1.19. Manual:LogFormatter.php
LogPage.php Classe para gerenciar um log: adiciona entradas para o log e extrai informações do log. Manual:LogPage.php
LogPager.php Uma classe para listar entradas de log. Implementa a classe ReverseChronologicalPager. Manual:LogPager.php
PatrolLog.php Classe que contém funções estáticas para trabalhar com registros de eventos de patrulha. Manual:PatrolLog.php

/includes/media/[edit]

Este diretório contém arquivos para lidar com vários formatos de mídia, principalmente imagens.

/includes/normal/[edit]

Este diretório contém algumas rotinas de normalização Unicode. Veja includes/normal/README para mais informações.

/includes/objectcache/[edit]

Arquivos relacionados aos mecanismos de caching do MediaWiki. Os arquivos nesse diretório proporcionam a possibilidade de armazenar objetos em aceleradores PHP, no memcached, em um banco de dados ou em arquivos DBA.

Arquivo Descrição Documentação
APCBagOStuff.php Implementação do BagOStuff para funções de memória compartilhada do APC. Manual:APCBagOStuff.php
BagOStuff.php Classe abstrata para ser derivada por classes que armazenam em cache objetos em aceleradores PHP, banco de dados SQL ou arquivos DBA. Ele especifica os métodos que uma classe de cache deve fornecer, como get(), set(), delete(), etc. Manual:BagOStuff.php
DBABagOStuff.php Implementação do BagOStuff que usa extensões DBA do PHP como um backend. Manual:DBABagOStuff.php
EhcacheBagOStuff.php Implementação do BagOStuff usando o web service Ehcache RESTful. Manual:EhcacheBagOStuff.php
EmptyBagOStuff.php Emula um BagOStuff vazio. Manual:EmptyBagOStuff.php
MemcachedClient.php Contém a classe MWMemcached, um cliente memcache do PHP. Manual:MemcachedClient.php
MemcachedPhpBagOStuff.php Implementação do BagOStuff usando o memcached. Usa a classe MWMemcached como um cliente memcached do PHP puro. Manual:MemcachedPhpBagOStuff.php
MultiWriteBagOStuff.php Implementação do BagOStuff que replica todas as gravações em múltiplos caches filhos.. Manual:MultiWriteBagOStuff.php
ObjectCache.php A classe ObjectCache contém algumas funções auxiliares estáticas para armazenar objetos em cache. Manual:ObjectCache.php
SqlBagOStuff.php Implementação do BagOStuff usando um banco de dados. Manual:SqlBagOStuff.php
inCacheBagOStuff.php Implementação do BagOStuff usando WinCache. Manual:inCacheBagOStuff.php
CacheBagOStuff.php Implementação do BagOStuff usando XCache. Manual:CacheBagOStuff.php

/includes/parser/[edit]

O analisador (parser) do MediaWiki, que transforma o wikitexto para HTML, pode ser encontrada aqui, juntamente com arquivos relacionados. Os arquivos mais interessantes neste diretório:

Arquivo Descrição Documentação
CoreParserFunctions.php Uma coleção de funções que implementam as funções do analisador sintático do núcleo. Manual:CoreParserFunctions.php
CoreTagHooks.php Tag hooks fornecido pelo núcleo do MediaWiki, p.ex. <nowiki>, <gallery>, <pre>, .. Manual:CoreTagHooks.php
LinkHolderArray.php Um array LinkHolderArray, que detém um conjunto de pares de reposição para ligações wiki. Manual:LinkHolderArray.php
Parser.php Este arquivo contém o analisador. Algumas expressões regulares estão incluídas. Manual:Parser.php
ParserCache.php Esta classe lida com armazenando em cache a saída do analisador. Manual:ParserCache.php
ParserOptions.php A classe ParserOptions contém uma coleção de opções para o analisador. Manual:ParserOptions.php
ParserOutput.php Contém a classe ParserOutput, que encapsula a saída do analisador. Manual:ParserOutput.php
Preprocessor.php Contém a interface Preprocessor para preprocessadores. Também contém as interfaces PPFrame e PPNode. Manual:Preprocessor.php
Preprocessor_DOM.php Um preprocessador que usa a extensão DOM do PHP. Este preprocessador é usado apenas se a extensão DOM estiver disponível. Manual:Preprocessor_DOM.php
Preprocessor_Hash.php Um preprocessador que usa arrays do PHP. Este preprocessador é usado apenas se a extensão DOM não estiver disponível ou quando a antiga extensão XMLDOM estiver presente. Manual:Preprocessor_Hash.php
Preprocessor_HipHop.php Um preprocessador otimizado para HipHop, usando sintaxe específica do mesmo. Manual:Preprocessor_HipHop.php

/includes/resourceloader/[edit]

Arquivos relacionados ao ResourceLoader, um sistema de otimização de entrega JavaScript/CSS para o MediaWiki.

/includes/search/[edit]

Este diretório contém o código para implementar a possibilidade de procurar um wiki usando um dos possíveis backends.

Arquivo Descrição Documentação
SearchEngine.php Contém várias classes relacionadas com a procura de um wiki. A classe SearchEngine é a classe pai para implementações de pesquisa específicas. Manual:SearchEngine.php
SearchIBM_DB2.php Implementa o SearchEngine usando IBM DB2. Manual:SearchIBM_DB2.php
SearchMssql.php Implementa o SearchEngine usando Msssql. Manual:SearchMssql.php
SearchMySQL.php Implementa o SearchEngine usando um motor de busca do MySQL. Manual:SearchMySQL.php
SearchOracle.php Implementa o SearchEngine usando Oracle (ConText). Manual:SearchOracle.php
SearchSqlite.php Implementa o SearchEngine usando SQLite. Manual:SearchSqlite.php

/includes/specials/[edit]

Este diretório contém o código e as classes para as páginas especiais padrão. Todas as classes de páginas especiais derivam da classe SpecialPage (definida em includes/SpecialPage.php). Páginas especiais que vêm com extensão estão localizadas nos respectivos diretórios das extensões. Veja também Manual:Special pages.

/includes/upload/[edit]

Arquivos que fornecem a infra-estrutura do recurso de upload de arquivos do MediaWiki.

Arquivo Descrição Documentação
UploadBase.php O arquivo UploadBase e subclasses são a infra-estrutura de carregamento de arquivos do MediaWiki. Manual:UploadBase.php
UploadFromChunks.php Subclasse do UploadBase que implementa o upload de blocos. Manual:UploadFromChunks.php
UploadFromFile.php Subclasse do UploadBase que implementa uploads de arquivos regulares. Manual:UploadFromFile.php
UploadFromStash.php Subclasse do UploadBase que implementa upload do arquivo previamente armazenado. Manual:UploadFromStash.php
UploadFromUrl.php Subclasse do UploadBase que implementa upload a partir de um recurso HTTP. Manual:UploadFromUrl.php
UploadStash.php Oferece a possibilidade de permitir que os aplicativos guardem temporariamente arquivos sem publicá-los no wiki. Manual:UploadStash.php

/images/[edit]

Se os uploads estiverem habilitados neste wiki, os arquivos de imagem serão colocados em subdiretórios dentro deste diretório. Veja Manual:Image administration#Folders para mais detalhes.

/languages/[edit]

Este diretório contém arquivos usados para localização e internacionalização. Para uma visão geral, veja Language in MediaWiki.

Arquivo Descrição Documentação
Language.php Contém a classe Language, que representa o idioma usado para texto incidental, e também tem algumas funções de codificação de caracteres e outras coisas sobre localidade. Duas variáveis globais contêm uma instância dessa classe: $wgContLang para o idioma do site e $wgLang para o idioma do usuário. Manual:Language.php

/maintenance/[edit]

Este diretório contém scripts de manutenção que devem ser executados a partir de uma interface de linha de comando.

Veja Manual:Maintenance scripts para uma visão geral destes scripts.

/mw-config/[edit]

Ponto de entrada para o script de configuração (o script auxiliar que ajuda a configurar um wiki recém-instalado). O código atual do instalador está localizado na pasta /includes/installer/.

/resources/[edit]

Este diretório contém recursos JavaScript e CSS usados pelo MediaWiki, incluindo jQuery.

/serialized/[edit]

Localização para objetos serializados (entradas de banco de dados convertidos em arquivos -- veja Serialização para mais informações). As tabelas do banco de dados que contêm dados serializados estão listados em Manual:Serialization.

/skins/[edit]

Este diretório contém todas as classes de skins, JavaScripts, CSS e algumas imagens utilizadas por essas skins. Veja Manual:Skins.

/tests/[edit]

Contém vários arquivos relacionados a testes de unidade, incluindo:

Outros idiomas: English  • Deutsch • français • Bahasa Indonesia • 日本語 • português do Brasil • русский • 中文