Module:Page

Module documentation[view] [edit] [history] [purge]

API

Programmatic name: Page

exists(link: internal link) → boolean

Checks if the page an internal link points to exists.

makeInternalLink(options: table, display: string, customLink: internal link) → string

Produces an internal link with the specified customLink and display. If the option "onlyIfExists" is set to true it only displays the link if the page exists.

makeExternalLink(display: string, link: external link) → string

Produces an external link with the specified display.

See all our documentation here.

---

---
-- @Liquipedia
-- wiki=commons
-- page=Module:Page
--
-- Please see https://github.com/Liquipedia/Lua-Modules to contribute
--

local Class = require('Module:Class')
local String = require('Module:StringUtils')

local Page = {}

---Checks if a page exists for a given (internal) link
---@param link string
---@return boolean
function Page.exists(link)
	local existingPage = mw.title.new(link)

	-- In some cases we might have gotten an external link,
	-- which will mean `existingPage` will equal nil
	if existingPage == nil then
		return false
	end

	return existingPage.exists
end

---@param options {onlyIfExists: boolean?}
---@param display string?
---@param customLink string?
---@return string?
---@overload fun(display: string?, customLink: string?): string?
function Page.makeInternalLink(options, display, customLink)
	-- if no options are passed along (e.g. if the module is invoked from wiki code)
	-- we need to shift the vars around to account for that
	if type(options) == 'string' then
		customLink = display
		display = options
	end
	if String.isEmpty(display) then
		return nil
	elseif String.isEmpty(customLink) then
		customLink = display
	end
	---@cast customLink -nil

	if (options or {}).onlyIfExists == true and (not Page.exists(customLink)) then
		return nil
	end

	return '[[' .. customLink .. '|' .. display .. ']]'
end

---@param display string?
---@param link string?
---@return string?
function Page.makeExternalLink(display, link)
	if String.isEmpty(display) or String.isEmpty(link) then
		return nil
	end

	return '[' .. link .. ' ' .. display .. ']'
end

--- Converts a link to a proper pagename format
---@overload fun(link: string): string
---@overload fun(link?: nil): nil
function Page.pageifyLink(link)
	if String.isEmpty(link) then
		return nil
	end
	---@cast link -nil

	return (mw.ext.TeamLiquidIntegration.resolve_redirect(link):gsub(' ', '_'))
end

return Class.export(Page)