rstoetter/ckeycolumnusagetree-php

The class cKeyColumnUsageTree represents a sorted collection of the key column usage of a mysql database. The main purpose of the class is to determine the dependencies of the tables among each other: The class is able to find dependency paths of more than two tables, when another tables are involved. Dependencies which include self referencing tables are considered, too.

the repository rstoetter\ckeycolumnusagetree-php

description

The class cKeyColumnUsageTree is the main class of the repository \rstoetter\ckeycolumnusagetree-php., _(*1)

The class cKeyColumnUsageTree represents a sorted collection of the key column usage of a mysql database. The main purpose of the class cKeyColumnUsageTree is to determine the dependencies of the tables among each other: The class cKeyColumnUsageTree is able to find dependency paths of more than two tables, when another tables are involved. Dependencies which include self referencing tables are considered, too., _(*2)

Only mysql databases are supported at the moment, _(*3)

helper classes

There are some helper classes, which are significantly involved in adding functionality to the class cKeyColumnUsageTree:, _(*4)

• The class cKeyColumnUsageTreeNode represents a single node in trees of the type \rstoetter\ckeycolumnusagetree\cKeyColumnUsageTree. The class manages the data part, which can be retrieved by using the method GetData( ), _(*5)

• The class cKeyColumnUsageTreeNodeData implements the data part of the nodes in trees of the type \rstoetter\ckeycolumnusagetree\cKeyColumnUsageTree, _(*6)

You will need PHP 7 or later to use this repository, _(*7)

usage

An usage example would be:, _(*8)

   $schema_name = 'give me the name of my database';
   $table_name = 'give me the name of an existing table in the schema';

   // open the database
   $mysqli = new mysqli(
                    'the database host',
                    'the database account name',
                    'the password of the database account',
                    $schema_name
                );


   // retrieve the key column usage information from the database
   $obj_ac_key_column_usage = new \rstoetter\libsqlphp\cKEY_COLUMN_USAGE( $schema_name, $mysqli );

   // build the sorted tree
   $obj_key_column_usage_tree = new \rstoetter\ckeycolumnusagetree\cKeyColumnUsageTree( $obj_ac_key_column_usage );

   // search for an item in the tree
   $obj_found = $obj_key_column_usage_tree->SearchByKey( $table_name ); 

   if ( $obj_found !== false ) {
        echo "\n the found node is associated with the table " . $obj_found->GetData( )->m_table_name;
   }

Installation

This project assumes you have composer installed. Simply add:, _(*9)

"require" : {, _(*10)

"rstoetter/ckeycolumnusagetree-php" : ">=1.0.0"

}, _(*11)

to your composer.json, and then you can simply install with:, _(*12)

composer install, _(*13)

Namespace

Use the namespace \rstoetter\ckeycolumnusagetree in order to access the classes provided by the repository ckeycolumnusagetree-php, _(*14)

More information

See the project wiki of ckeycolumnusagetree-php for more technical informations., _(*15)