summaryrefslogtreecommitdiff
path: root/hugo/libraries/navigation/NodeFactory.class.php
diff options
context:
space:
mode:
Diffstat (limited to 'hugo/libraries/navigation/NodeFactory.class.php')
-rw-r--r--hugo/libraries/navigation/NodeFactory.class.php97
1 files changed, 97 insertions, 0 deletions
diff --git a/hugo/libraries/navigation/NodeFactory.class.php b/hugo/libraries/navigation/NodeFactory.class.php
new file mode 100644
index 0000000..7d8106a
--- /dev/null
+++ b/hugo/libraries/navigation/NodeFactory.class.php
@@ -0,0 +1,97 @@
+<?php
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * This class is responsible for creating Node objects
+ *
+ * @package PhpMyAdmin-navigation
+ */
+if (! defined('PHPMYADMIN')) {
+ exit;
+}
+
+require_once 'libraries/navigation/Nodes/Node.class.php';
+
+/**
+ * Node factory - instanciates Node objects or objects derived from the Node class
+ *
+ * @package PhpMyAdmin-Navigation
+ */
+class PMA_NodeFactory
+{
+ /**
+ * @var string $_path A template for generating paths to files
+ * that contain various Node classes
+ * @access private
+ */
+ private static $_path = 'libraries/navigation/Nodes/%s.class.php';
+ /**
+ * Sanitizes the name of a Node class
+ *
+ * @param string $class The class name to be sanitized
+ *
+ * @return string
+ */
+ private static function _sanitizeClass($class)
+ {
+ if ($class !== 'Node' && ! preg_match('@^Node_\w+(_\w+)?$@', $class)) {
+ $class = 'Node';
+ trigger_error(
+ sprintf(
+ /* l10n: The word "Node" must not be translated here */
+ __('Invalid class name "%1$s", using default of "Node"'),
+ $class
+ ),
+ E_USER_ERROR
+ );
+ }
+ return self::_checkFile($class);
+ }
+ /**
+ * Checks if a file exists for a given class name
+ * Will return the default class name back if the
+ * file for some subclass is not available
+ *
+ * @param string $class The class name to check
+ *
+ * @return string
+ */
+ private static function _checkFile($class)
+ {
+ $path = sprintf(self::$_path, $class);
+ if (! is_readable($path)) {
+ $class = 'Node';
+ trigger_error(
+ sprintf(
+ __('Could not include class "%1$s", file "%2$s" not found'),
+ $class,
+ 'Nodes/' . $class . '.class.php'
+ ),
+ E_USER_ERROR
+ );
+ }
+ return $class;
+ }
+ /**
+ * Instanciates a Node object
+ *
+ * @param string $class The name of the class to instanciate
+ * @param string $name An identifier for the new node
+ * @param int $type Type of node, may be one of CONTAINER or OBJECT
+ * @param bool $is_group Whether this object has been created
+ * while grouping nodes
+ *
+ * @return string
+ */
+ public static function getInstance(
+ $class = 'Node',
+ $name = 'default',
+ $type = Node::OBJECT,
+ $is_group = false
+ ) {
+ $class = self::_sanitizeClass($class);
+ include_once sprintf(self::$_path, $class);
+ return new $class($name, $type, $is_group);
+ }
+}
+
+?>