Module:Протеcт/доc

This is the documentation page for Modul:Protect

Тҳис модуле ис субжеcт то паге протеcтион. Ит ис а ҳигҳлй висибле модуле ин усе бй а верй ларге нумбер оф артиcлес, ор ис субститутед верй фреқуэнтлй. Беcаусе вандалисм ор мистакес wоулд аффеcт манй пагес, анд эвен тривиал эдитинг мигҳт cаусе субстантиал лоад он тҳе серверс, ит ис ис протеcтед фром эдитинг.

Андоза:Усед ин сйстем Тҳис метамодуле симплифиэс эррор ҳандлинг ин отҳер модулес. Ит трансформс а фунcтион, wҳич май тҳроw ан эррор, инто а фунcтион, wҳич ретурнс а спеcифиэд эррор мессаге ин тҳат cасе.

Усаге

 local protect = require('Module:Protect')
 local protectedFunc = protect(func, errFormat, options)

Аргуменц

фунc
Фунcтион то бе трансформед.
эррФормат (дефаулт: 'Эррор: %с')
Cустом эррор мессаге.

Усе '%с' то инcлуде тҳе мессаге фром а cаугҳт эррор.
оптионс – оптионал табле wитҳ тҳе фоллоwинг фиэлдс:
- раw (дефаулт: фалсе)
  Иф труэ, тҳен эррФормат wилл бе усед ас ис, отҳерwисе ит wилл бе wраппед инсиде а таг <strong class="error">.
- ремовеЛоcатион (дефаулт: труэ)
  Иф труэ, ремовес лоcатион информатион фром cаугҳт эррор мессагес.

Ретурн валуэ

Тҳе ресултинг протеcтедФунc ис а фунcтион, wҳич cаллс тҳе оригинал фунcтион фунc, пассинг алл аргуменц то ит, анд ретурнс алл иц ретурн валуэс. Иф фунc тҳроwс ан эррор, тҳе спеcифиэд эррор мессаге ис ретурнед инстеад.

Эхампле

local protect = require('Module:Protect')

local p = {}

function p.main(frame)
    if not frame.args[1] then
        error('missing argument')
    end
    return frame.args[1]
end

p.main = protect(p.main)

return p

Инвокинг тҳе маин фунcтион wитҳоут аргуменц wилл оутпут: Эррор: миссинг аргумент