LibraryBase.php

Go to the documentation of this file.

<?php
abstract class Scribunto_LuaLibraryBase {
    private $engine;
 
    public function __construct( Scribunto_LuaEngine $engine ) {
        $this->engine = $engine;
    }
 
    abstract public function register();
 
    protected function getEngine() {
        return $this->engine;
    }
 
    protected function getInterpreter() {
        return $this->engine->getInterpreter();
    }
 
    protected function getParser() {
        return $this->engine->getParser();
    }
 
    protected function getTitle() {
        return $this->getEngine()->getTitle();
    }
 
    protected function getParserOptions() {
        return $this->engine->getParser()->getOptions();
    }
 
    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;
        }
    }
 
    protected function checkType( $name, $argIdx, $arg, $expectType ) {
        $type = $this->getLuaType( $arg );
        if ( $type !== $expectType ) {
            throw new Scribunto_LuaError(
                "bad argument #$argIdx to '$name' ($expectType expected, got $type)"
            );
        }
    }
 
    protected function checkTypeOptional( $name, $argIdx, &$arg, $expectType, $default ) {
        if ( $arg === null ) {
            $arg = $default;
        } else {
            $this->checkType( $name, $argIdx, $arg, $expectType );
        }
    }
 
    public function incrementExpensiveFunctionCount() {
        return $this->getEngine()->incrementExpensiveFunctionCount();
    }
}