arConverter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for arConverter:

Public Member Functions
	__construct (string $table_name, string $class_name)
	readStructure ()
	downloadClassFile ()
	setTableName (string $table_name)
	getTableName ()
	setStructure (array $structure)
	getStructure ()
	addStructure (stdClass $structure)
	setClassName (string $class_name)
	getClassName ()

Static Public Member Functions
static	getDB ()

Data Fields
const	REGEX = "/([a-z]*)\\((\\d*)\\)/u"

Protected Member Functions
	returnAttributesForField (stdClass $field)

Static Protected Member Functions
static	lookupFieldType (string $field_name)
static	lookupFieldLength (string $field_name)

Protected Attributes
string	$table_name = ''
string	$class_name = ''
array	$structure = []
array	$ids = []

Static Protected Attributes
static array	$field_map
static array static array	$length_map

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class arConverter

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

2.0.7 $arConverter = new arConverter('my_msql_table_name', 'arMyRecordClass'); $arConverter->readStructure(); $arConverter->downloadClassFile();

Definition at line 27 of file class.arConverter.php.

Constructor & Destructor Documentation

__construct()

arConverter::__construct	(	string	$table_name,
		string	$class_name
	)

Definition at line 53 of file class.arConverter.php.

References readStructure(), setClassName(), and setTableName().

    {
        $this->setClassName($class_name);
        $this->setTableName($table_name);
        $this->readStructure();
    }

Here is the call graph for this function:

Member Function Documentation

addStructure()

arConverter::addStructure

(

stdClass

$structure

)

Definition at line 210 of file class.arConverter.php.

References $structure.

Referenced by readStructure().

                                                     : void
    {
        if (!in_array($structure->Field, $this->ids)) {
            $this->structure[] = $structure;
            $this->ids[] = $structure->Field;
        }
    }

Here is the caller graph for this function:

downloadClassFile()

arConverter::downloadClassFile

(

)

Definition at line 69 of file class.arConverter.php.

References $txt, exit, getClassName(), getStructure(), getTableName(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), and returnAttributesForField().

                                       : void
    {
        $header = "<?php
require_once('./components/ILIAS/ActiveRecord/class.ActiveRecord.php');

class {CLASS_NAME} extends ActiveRecord {

        static function returnDbTableName() {
                return '{TABLE_NAME}';
        }

        public function getConnectorContainerName() {
                return '{TABLE_NAME}';
        }
";
        $txt = str_replace(
            ['{CLASS_NAME}', '{TABLE_NAME}'],
            [$this->getClassName(), $this->getTableName()],
            $header
        );
        $all_members = '';
        foreach ($this->getStructure() as $str) {
            $member = "/**
         * @var {DECLARATION}
         *\n";
            foreach ($this->returnAttributesForField($str) as $name => $value) {
                $member .= '     * @con_' . $name . ' ' . $value . "\n";
            }

            $member .= "*/
        protected \${FIELD_NAME};

        ";

            $member = str_replace(['{FIELD_NAME}', '{DECLARATION}'], [$str->Field, ' '], $member);

            $all_members .= $member;
        }
        $txt = $txt . $all_members . '
}

?>';

        //              echo '<pre>' . print_r(, 1) . '</pre>';

        header('Content-type: application/x-httpd-php');
        header("Content-Disposition: attachment; filename=\"class." . $this->getClassName() . ".php\"");
        echo $txt;
        exit;
    }

Here is the call graph for this function:

getClassName()

arConverter::getClassName

(

)

Definition at line 223 of file class.arConverter.php.

References $class_name.

Referenced by downloadClassFile().

                                  : string
    {
        return $this->class_name;
    }

Here is the caller graph for this function:

getDB()

static arConverter::getDB ( )

static

Definition at line 177 of file class.arConverter.php.

References $DIC.

                                  : ilDBInterface
    {
        global $DIC;

        return $DIC['ilDB'];
    }

getStructure()

arConverter::getStructure

(

)

Returns

mixed[]

Definition at line 205 of file class.arConverter.php.

References $structure.

Referenced by downloadClassFile().

                                  : array
    {
        return $this->structure;
    }

Here is the caller graph for this function:

getTableName()

arConverter::getTableName

(

)

Definition at line 189 of file class.arConverter.php.

References $table_name.

Referenced by downloadClassFile(), and readStructure().

                                  : string
    {
        return $this->table_name;
    }

Here is the caller graph for this function:

lookupFieldLength()

static arConverter::lookupFieldLength ( string  $field_name )

staticprotected

Returns

mixed|void

Definition at line 164 of file class.arConverter.php.

    {
        $field_type = self::lookupFieldType($field_name);

        preg_match(self::REGEX, $field_name, $matches);

        if (self::$length_map[$field_type][$matches[2]]) {
            return self::$length_map[$field_type][$matches[2]];
        }

        return $matches[2];
    }

lookupFieldType()

static arConverter::lookupFieldType ( string  $field_name )

staticprotected

Definition at line 154 of file class.arConverter.php.

                                                                 : string
    {
        preg_match(self::REGEX, $field_name, $matches);

        return self::$field_map[$matches[1]];
    }

readStructure()

arConverter::readStructure

(

)

Definition at line 60 of file class.arConverter.php.

References $data, addStructure(), and getTableName().

Referenced by __construct().

                                   : void
    {
        $sql = 'DESCRIBE ' . $this->getTableName();
        $ilDBStatement = self::getDB()->query($sql);
        while ($data = self::getDB()->fetchObject($ilDBStatement)) {
            $this->addStructure($data);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

returnAttributesForField()

arConverter::returnAttributesForField ( stdClass  $field )

protected

Returns

array{has_field: string, fieldtype: string, length: mixed, is_notnull?: string, is_primary?: string}

Definition at line 136 of file class.arConverter.php.

References arFieldList\FIELDTYPE, arFieldList\HAS_FIELD, arFieldList\IS_NOTNULL, arFieldList\IS_PRIMARY, and arFieldList\LENGTH.

Referenced by downloadClassFile().

                                                                : array
    {
        $attributes = [];
        $attributes[arFieldList::HAS_FIELD] = 'true';
        $attributes[arFieldList::FIELDTYPE] = self::lookupFieldType($field->Type);
        $attributes[arFieldList::LENGTH] = self::lookupFieldLength($field->Type);

        if ($field->Null === 'NO') {
            $attributes[arFieldList::IS_NOTNULL] = 'true';
        }

        if ($field->Key === 'PRI') {
            $attributes[arFieldList::IS_PRIMARY] = 'true';
        }

        return $attributes;
    }

Here is the caller graph for this function:

setClassName()

arConverter::setClassName

(

string

$class_name

)

Definition at line 218 of file class.arConverter.php.

References $class_name.

Referenced by __construct().

                                                    : void
    {
        $this->class_name = $class_name;
    }

Here is the caller graph for this function:

setStructure()

arConverter::setStructure

(

array

$structure

)

Parameters

mixed[]

$structure

Definition at line 197 of file class.arConverter.php.

References $structure.

                                                  : void
    {
        $this->structure = $structure;
    }

setTableName()

arConverter::setTableName

(

string

$table_name

)

Definition at line 184 of file class.arConverter.php.

References $table_name.

Referenced by __construct().

                                                    : void
    {
        $this->table_name = $table_name;
    }

Here is the caller graph for this function:

Field Documentation

$class_name

string arConverter::$class_name = ''

protected

Definition at line 49 of file class.arConverter.php.

Referenced by getClassName(), and setClassName().

$field_map

array arConverter::$field_map

staticprotected

Initial value:

= [
        'varchar' => arField::FIELD_TYPE_TEXT

Definition at line 30 of file class.arConverter.php.

$ids

array arConverter::$ids = []

protected

Definition at line 51 of file class.arConverter.php.

$length_map

array static array arConverter::$length_map

staticprotected

Initial value:

= [
        arField::FIELD_TYPE_TEXT => false

Definition at line 39 of file class.arConverter.php.

$structure

array arConverter::$structure = []

protected

Definition at line 50 of file class.arConverter.php.

Referenced by addStructure(), getStructure(), and setStructure().

$table_name

string arConverter::$table_name = ''

protected

Definition at line 48 of file class.arConverter.php.

Referenced by getTableName(), and setTableName().

REGEX

const arConverter::REGEX = "/([a-z]*)\\((\\d*)\\)/u"

Definition at line 29 of file class.arConverter.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/ActiveRecord/Fields/Converter/class.arConverter.php