Page MenuHomeWickedGov Phorge
Files F4077200

LibraryBase.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

LibraryBase.php
View Options

<?php
/**
* Basic services that Lua libraries will probably need
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Brad Jorsch
*/
namespace MediaWiki\Extension\Scribunto\Engines\LuaCommon;
use MediaWiki\Parser\Parser;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Title\Title;
/**
* This class provides some basic services that Lua libraries will probably need
*/
abstract class LibraryBase {
/**
* @var LuaEngine
*/
private $engine;
/**
* @param LuaEngine $engine
*/
public function __construct( LuaEngine $engine ) {
$this->engine = $engine;
}
/**
* Called to register the library.
*
* This should do any necessary setup and then call $this->getEngine()->registerInterface().
* The value returned by that call should be returned from this function,
* and must be for 'deferLoad' libraries to work right.
*
* @return array Lua package
*/
abstract public function register();
/**
* @return LuaEngine engine
*/
protected function getEngine() {
return $this->engine;
}
/**
* @return LuaInterpreter interpreter
*/
protected function getInterpreter() {
return $this->engine->getInterpreter();
}
/**
* @return Parser
*/
protected function getParser() {
return $this->engine->getParser();
}
/**
* @return Title
*/
protected function getTitle() {
return $this->getEngine()->getTitle();
}
/**
* @return ParserOptions
*/
protected function getParserOptions() {
return $this->engine->getParser()->getOptions();
}
/**
* Get the Lua type corresponding to the type of the variable.
*
* If the variable does not correspond to any type, the PHP type will be
* returned (prefixed with "PHP"). For example, "PHP resource" or "PHP
* object of class Foo".
*
* @param mixed $var Variable to test
* @return string Type
*/
protected function getLuaType( $var ) {
static $luaTypes = [
'NULL' => 'nil',
'double' => 'number',
'integer' => 'number',
'string' => 'string',
'boolean' => 'boolean',
'array' => 'table',
];
$type = gettype( $var );
if ( isset( $luaTypes[$type] ) ) {
return $luaTypes[$type];
} elseif ( $this->getInterpreter()->isLuaFunction( $var ) ) {
return 'function';
} else {
$type = "PHP $type";
if ( is_object( $var ) ) {
$type .= " of class " . get_class( $var );
}
return $type;
}
}
/**
* Check the type of a variable
*
* If the type of the variable does not match the expected type,
* a LuaError will be thrown.
*
* @param string $name Name of the calling function (as seen from Lua)
* @param int $argIdx Index of the argument being tested (1-based)
* @param mixed $arg Variable to test
* @param string $expectType Lua type expected
* @return void
*/
protected function checkType( $name, $argIdx, $arg, $expectType ) {
$type = $this->getLuaType( $arg );
if ( $type !== $expectType ) {
throw new LuaError(
"bad argument #$argIdx to '$name' ($expectType expected, got $type)"
);
}
}
/**
* Check the type of a variable, with default if null
*
* If the variable is null, $default will be assigned. Otherwise, if the
* type of the variable does not match the expected type, a
* LuaError will be thrown.
*
* @param string $name Name of the calling function (as seen from Lua)
* @param int $argIdx Index of the argument being tested (1-based)
* @param mixed &$arg Variable to test/set
* @param string $expectType Lua type expected
* @param mixed $default Default value
* @return void
*/
protected function checkTypeOptional( $name, $argIdx, &$arg, $expectType, $default ) {
if ( $arg === null ) {
$arg = $default;
} else {
$this->checkType( $name, $argIdx, $arg, $expectType );
}
}
/**
* Increment the expensive function count, and throw if limit exceeded
*
* @return null
*/
public function incrementExpensiveFunctionCount() {
return $this->getEngine()->incrementExpensiveFunctionCount();
}
}
class_alias( LibraryBase::class, 'Scribunto_LuaLibraryBase' );

File Metadata

Mime Type
text/x-php
Expires
Aug 18 2026, 03:02 (9 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
37/6d/230834c1e6d88d996e79cc02333f
Default Alt Text
LibraryBase.php (4 KB)

Event Timeline