Modul:Sandbox/Nihiltres/Category manager/doc

Тҳис модуле имплеменц а симпле тоол фор манагинг cатегорй оутпут ин модулес.

Усаге

Тҳе модуле cаннот бе усед фром wикитехт. Ит cан бе импортед то анотҳер модуле усинг cоде симилар то тҳе фоллоwинг:

лоcал cатМан = реқуире("Модуле:Cатегорй манагер")

Cатегорй-лист табле формат

Эач фунcтион ин тҳе модуле такес а табле ас иц фирст параметер, анд тҳат табле ис усед ас тҳе лист оф cатегориэс. Тҳесе таблес аре ассумед то онлй бе манипулатед бй тҳис модуле'с фунcтионс, бут тҳере ис но протеcтион агаинст эхтернал манипулатион; тҳере'с жуст басиc тйпе/валуэ валидатион. Эач итем ин а cатегорй-лист табле ҳас иц cатегорй наме (wитҳоут префих) ас иц кей; дуплиcате cатегориэс аре тҳерефоре импоссибле. Валуэс фор эач кей cан эитҳер бе труэ (но сорт кей) ор а стринг cонтаининг тҳат сорт кей. А фалсе валуэ ор анй отҳер тйпе оф валуэ wилл cаусе эррорс. Тҳере аре тҳреэ фунcтионс фор манипулатинг а cатегорй лист табле, анд тҳеир индивидуал доcументатион фоллоwс.

Фунcтионс

аддCатегорй

Усаге:

• cатМан.аддCатегорй(cатЛист, наме)
• cатМан.аддCатегорй(cатЛист, наме, сортКей)

Тҳе аддCатегорй фунcтион аддс а cатегорй бй сеттинг тҳе кей фром наме ин тҳе cатЛист табле то эитҳер труэ ор тҳе провидед сортКей валуэ иф пресент.

Иф ан эхистинг cатегорй ис аддед а сеcонд тиме, иц валуэ wилл бе оверwриттен wитҳ тҳе неw валуэ; фор тҳис реасон тҳе модуле доэс нот инcлуде а сепарате фунcтион фор сеттинг сорт кейс.

Тҳе cатЛист параметер муст бе а табле, тҳе наме параметер муст бе а нон-эмптй, нон-wҳитеспаcе стринг, анд сортКей муст бе эитҳер а стринг ор нил.

ремовеCатегорй

Усаге:

• cатМан.ремовеCатегорй(cатЛист, наме)

Тҳе ремовеCатегорй фунcтион ремовес а cатегорй бй сеттинг тҳе кей фром наме то нил ин тҳе cатЛист табле.

Тҳе cатЛист параметер муст бе а табле, анд тҳе наме параметер муст бе а нон-эмптй, нон-wҳитеспаcе стринг.

wритеCатегорйЛист

Усаге:

• cатМан.wритеCатегорйЛист(cатЛист)
• cатМан.wритеCатегорйЛист(cатЛист, нуллифй)

Тҳе wритеCатегорйЛист фунcтион продуcес а стринг cонтаининг алл тҳе cатегориэс ин тҳе табле форматтед ас wикитехт. Оптионаллй, а боолеан нуллифй параметер май бе провидед, анд иф труэ, ит wилл cаусе тҳе фунcтион то оутпут ан эмптй стринг. Тҳис ис усефул ас ит макес ит эасй то дисабле cатегорй оутпут тҳроугҳ а параметер, пробаблй ин cонжунcтион wитҳ Модуле:Есно.

Тҳе cатЛист параметер муст бе а табле форматтед аccординг то тҳе cатегорй-лист табле формат, анд тҳе нуллифй параметер муст бе эитҳер а боолеан ор нил.