Changeset 11900

Timestamp:

08/30/07 18:49:48 (1 year ago)

Author:

bergie

Message:

Minor API cleanup, removing unnecessary comments. refs #102

Files:

• trunk/midcom/midcom.core/midcom/application.php (modified) (8 diffs)
• trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php (modified) (2 diffs)
• trunk/midcom/midcom.core/midcom/helper/_componentloader.php (modified) (1 diff)
• trunk/midcom/midcom.core/midcom/helper/_styleloader.php (modified) (15 diffs)
• trunk/midcom/midcom.core/midcom/helper/configuration.php (modified) (1 diff)
• trunk/midcom/midcom.core/midcom/services/auth.php (modified) (2 diffs)
• trunk/midcom/midcom.core/midcom/services/cache.php (modified) (2 diffs)
• trunk/midcom/midcom.core/midcom/services/cache/module/content.php (modified) (1 diff)

trunk/midcom/midcom.core/midcom/application.php

@@ -767 +767 @@
-     *
-     * _process               - CANHANDLE->HANDLE || ATTACHMENT_OUTPUT
-heckobject
+an_handle
-     * _loadconfig            - CANHANDLE
-     * _handle                - HANDLE
@@ -783 +783 @@
-     * Details: The logic will traverse the node tree and for each node it will load
-     * the component that is responsible for it. This component gets the chance to
-heckobject
+an_handle
-     * basically a call to can_handle. If the component declares to be able to handle
-     * the call, its handle function is executed. Depending if the handle was successful
@@ -924 +924 @@
-            // If so, execute it, if not, continue.
-
-heckobject
+an_handle
-            {
-                $this->_status = MIDCOM_STATUS_HANDLE;
@@ -1002 +1002 @@
-     * Handle the request.
-     *
-heckobject
+an_handle
-     * a component can handle a request. The URL of the component that is used
-     * to handle the request is obtained automatically. The parameter $path is
@@ -1097 +1097 @@
-     * @access private
-     */
-heckobject
+an_handle
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
@@ -1103 +1103 @@
-        $path = $this->get_context_data(MIDCOM_CONTEXT_COMPONENT);
-
-$adminmode = false;
+// Request type safety check
-        if ($this->_context[$this->_currentcontext][MIDCOM_CONTEXT_REQUESTTYPE] != MIDCOM_REQUEST_CONTENT)
-        {
-            debug_add("Unkown Request Type encountered:" . $this->_context[$this->current_context][MIDCOM_CONTEXT_REQUESTTYPE], MIDCOM_LOG_ERROR);
+            debug_pop();
-            $this->generate_error(MIDCOM_ERRCRIT, "Unkown Request Type encountered:" . $this->_context[$this->current_context][MIDCOM_CONTEXT_REQUESTTYPE]);
-        }
-        
-
-
+
+
+
-        {
-            $path = 'midcom.core.nullcomponent';
-            $this->_set_context_data($path, MIDCOM_CONTEXT_COMPONENT);
-
-
-
+
+
+
+
-        $config_obj =& $this->_loadconfig($object);
-        $config = ($config_obj == false) ? array() : $config_obj->get_all();
-
-
-
-
-
-
-
-
-
-
+
+
+
-            debug_pop();
-
-
-
-
-
+
+
+
+
+
+
+
-            debug_pop();
-            return false;
-        }
+        
+        debug_add("Component {$path} in {$object->name} will handle request.", MIDCOM_LOG_INFO);
+        debug_pop();
+        return true;
-    }
-
@@ -1154 +1156 @@
-    private function & _loadconfig($object) 
-    {
-        debug_push("midcom_application::_loadconfig");
-
-        $path = $this->get_context_data(MIDCOM_CONTEXT_COMPONENT);
-        debug_add("Trying to load configuration for $path", MIDCOM_LOG_DEBUG);
-        $result = new midcom_helper_configuration($object, $path);
-        return $result;
@@ -1198 +1197 @@
-        }
-        
-component
+interface
-        $component->show_content($this->_currentcontext);
-

trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php

@@ -539 +539 @@
-     * @return bool Indication success.
-     */
-, $adminmode = false
+
-    {
-        // Initialize the context data
@@ -565 +565 @@
-
-        $data['handler'] = null;
-        $data['adminmode'] = $adminmode;
-
-        return true;

trunk/midcom/midcom.core/midcom/helper/_componentloader.php

@@ -491 +491 @@
-
-        return $this->_interface_classes[$path];
-    }
-
-
-    /**
-     * Returns a reference to an instance of the specified component's
-     * COMPONENT class. The component is given in $path as a MidCOM
-     * path. Such an instance will be cached by the framework so that
-     * only one instance is always active for each component. Missing
-     * components will be dynamically loaded into memory.
-     *
-     *
-     * @param string $path      The component name.
-     * @return mixed            A reference to the concept class in question or null if the component is missing.
-     * @deprecated This has been deprecated in MidCOM 2.4 in favor of the new component interface classes.
-     */
-    function & get_component_class($path)
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-        debug_add("Warning, this method is deprecated, you should use the new component interface instead.",
-            MIDCOM_LOG_DEBUG);
-        debug_pop();
-
-        global $midcom;
-
-        $prefix = $this->path_to_prefix($path);
-        // return null if the component is missing.
-        if (! $this->is_loaded($path) && ! $this->_load($path))
-        {
-            debug_pop( );
-            $ret = null; 
-            return $ret;
-        }
-
-        if (is_null ($this->_component_classes[$path]))
-        {
-            debug_push("midcom_helper__componentloader::get_component_class");
-
-            if ($this->manifests[$path]->purecode)
-            {
-                $GLOBALS['midcom_errstr'] = "Cannot retrieve the COMPONENT concept of the pure code library $path.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            debug_add("Instantinating " . $prefix . "_component.", MIDCOM_LOG_DEBUG);
-            eval("\$this->_component_classes[\$path] = new " . $prefix . "_component();");
-
-            if ($this->_component_classes[$path] === false)
-            {
-                $GLOBALS['midcom_errstr'] = "Could not instantinate " . $prefix . "_component.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            debug_pop();
-        }
-
-        return $this->_component_classes[$path];
-    }
-
-    /**
-     * Returns a reference to an instance of the specified component's
-     * Content Admin COMPONENT class. The component is given in $path
-     * as a MidCOM path. Such an instance will be cached by the
-     * framework so that only one instance is always active for each
-     * component. Missing components will be dynamically loaded into
-     * memory.
-     *
-     * @param string $path      The component name.
-     * @return mixed            A reference to the concept class in question.
-     * @deprecated This has been deprecated in MidCOM 2.4 in favor of the new component interface classes.
-     */
-    function & get_contentadmin_class($path)
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-        debug_add("Warning, this method is deprecated, you should use the new component interface instead.",
-            MIDCOM_LOG_DEBUG);
-        debug_pop();
-
-        global $midcom;
-        $prefix = $this->path_to_prefix($path);
-
-        if (! $this->is_loaded($path) && ! $this->_load($path))
-        {
-            $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-            // This will exit.
-        }
-
-        if (is_null ($this->_contentadmin_classes[$path]))
-        {
-            debug_push("midcom_helper__componentloader::get_contentadmin_class");
-
-            if ($this->manifests[$path]->purecode)
-            {
-                $GLOBALS['midcom_errstr'] = "Cannot retrieve the Content Admin COMPONENT concept of the pure code library $path.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            if (! class_exists ($prefix . "_contentadmin"))
-            {
-                $GLOBALS['midcom_errstr'] = "Class " . $prefix . "_contentadmin does not exist.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            debug_add("Instantinating " . $prefix . "_contentadmin.");
-            eval("\$this->_contentadmin_classes[\$path] = new " . $prefix . "_contentadmin();");
-
-            if ($this->_contentadmin_classes[$path] === false)
-            {
-                $GLOBALS['midcom_errstr'] = "Could not instantinate " . $prefix . "_contentadmin.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            debug_pop();
-        }
-
-        return $this->_contentadmin_classes[$path];
-    }
-
-    /**
-     * Returns a reference to an instance of the specified component's
-     * NAP class. The component is given in $path as a MidCOM
-     * path. Such an instance will be cached by the framework so that
-     * only one instance is always active for each component. Missing
-     * components will be dynamically loaded into memory.
-     *
-     * @param string $path      The component name.
-     * @return mixed            A reference to the concept class in question.
-     * @deprecated This has been deprecated in MidCOM 2.4 in favor of the new component interface classes.
-     */
-    function & get_nap_class($path)
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-        debug_add("Warning, this method is deprecated, you should use the new component ".
-                  "interface instead. (hint: get_interface_class()) ",
-            MIDCOM_LOG_DEBUG);
-        debug_pop();
-
-        global $midcom;
-
-        $prefix = $this->path_to_prefix($path);
-
-        if (! $this->is_loaded($path) && ! $this->_load($path))
-        {
-            $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-            // This will exit.
-        }
-
-        if (is_null ($this->_nap_classes[$path]))
-        {
-            debug_push ("midcom_helper__componentloader::get_nap_class");
-
-            if ($this->manifests[$path]->purecode)
-            {
-                $GLOBALS['midcom_errstr'] = "Cannot retrieve the NAP concept of the pure code library $path.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            debug_add("Instantinating " . $prefix . "_nap.", MIDCOM_LOG_DEBUG);
-            eval("\$this->_nap_classes[\$path] = new " . $prefix . "_nap();");
-
-            if ($this->_nap_classes[$path] === false)
-            {
-                $GLOBALS['midcom_errstr'] = "Could not instantinate " . $prefix . "_nap.";
-                debug_add($GLOBALS['midcom_errstr'], MIDCOM_LOG_CRIT);
-                $midcom->generate_error(MIDCOM_ERRCRIT, $GLOBALS['midcom_errstr']);
-                // This will exit.
-            }
-
-            debug_pop();
-        }
-
-        return $this->_nap_classes[$path];
-    }
-

trunk/midcom/midcom.core/midcom/helper/_styleloader.php

@@ -312 +312 @@
-        if (!is_dir($path))
-        {
+            debug_push_class(__CLASS__, __FUNCTION__);
-            debug_add("Directory {$path} not found.");
+            debug_pop();
-            return $elements;
-        }
@@ -320 +322 @@
-        if (!$directory)
-        {
+            debug_push_class(__CLASS__, __FUNCTION__);        
-            debug_add("Failed to read directory {$path}");
+            debug_pop();
-            return $elements;
-        }
@@ -457 +461 @@
-        {
-            debug_push_class(__CLASS__, __FUNCTION__);
-trying to show '$path' but there is no context set!
+Trying to show '$path' but there is no context set
-            debug_pop();
-            return false;
-        }
-
-        if (count($this->_scope) > 0)
-        {
-            debug_add("style scope is " . $this->_scope[0]);
-        }
-
@@ -566 +565 @@
-    function _getComponentStyle($topic)
-    {
-        /* this global is set by the urlparser.
-         */
-        global $midcom_style_inherited;
-        debug_push_class(__CLASS__, __FUNCTION__);
-
-        // get user defined style for component
-
-        // style inheritance
-        // should this be cached somehow?
@@ -578 +572 @@
-        {
-            $_st = $this->get_style_id_from_path($topic->style);
-    debug_add( "topic->style:" . $topic->style . "( $_st )" );
-}
-else if (   isset($midcom_style_inherited
-         && ($midcom_style_inherited))
-{
+}
+else if (   isset($GLOBALS['midcom_style_inherited'])
+         && ($GLOBALS['midcom_style_inherited'])
+{
+    // FIXME: This GLOBALS is set by urlparser. Should be removed
-            // get user defined style inherited from topic tree
-
-
+
-        }
-        else
@@ -594 +587 @@
-            {
-                $_st = $this->get_style_id_from_path($GLOBALS['midcom_config']['styleengine_default_styles'][$component]);
-                debug_add( 'Component_default styles: ' . $GLOBALS['midcom_config']['styleengine_default_styles'][$component]);
-            }
-        }
@@ -600 +592 @@
-        if (isset($_st))
-        {
-            debug_add("Current component has user defined style: $_st", MIDCOM_LOG_INFO);
-            $substyle = $_MIDCOM->get_context_data(MIDCOM_CONTEXT_SUBSTYLE);
-            debug_add( 'Component substyle:' . $substyle );
-
-            if (isset($substyle)) 
@@ -614 +604 @@
-                    {
-                        $_st = $_subst_id;
-                        debug_add("Found substyle '$substyle', overriding component's user defined style.", MIDCOM_LOG_INFO);
-                    }
-                    else
-                    {
-                        debug_add("Substyle '$substyle' not found under {$_st}.", MIDCOM_LOG_INFO);
-                    }
-                }
@@ -624 +609 @@
-        }
-
-debug_pop();
-if (isset($_st)) 
+if (isset($_st))
+
-            return $_st;
-else {
-    return false;
-}
+
+
+return false;
-    }
-
@@ -717 +702 @@
-    function _merge_styledirs ($component_style)
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-        /* first the prepend styles */
-        $this->_styledirs = $this->_styledirs_prepend;
@@ -725 +709 @@
-        $this->_styledirs =  array_merge($this->_styledirs, $this->_styledirs_append);
-        $this->_styledirs_count = count($this->_styledirs);
-        debug_pop();
-    }
-
@@ -738 +721 @@
-    function enter_context($context)
-    {
-
+
-
-        // set new context and topic
-        array_unshift($this->_context, $context); // push into context stack
-        debug_add("entering context $context", MIDCOM_LOG_DEBUG);
-
-        $this->_topic = $_MIDCOM->get_context_data(MIDCOM_CONTEXT_CONTENTTOPIC);
@@ -754 +736 @@
-
-        $this->_merge_styledirs($this->_snippetdir);
-
-        debug_pop();
-        return true;
-    }
@@ -768 +748 @@
-    function leave_context()
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-
-        debug_add("leaving context " . $this->_context[0], MIDCOM_LOG_DEBUG);
-        /* does this cause an extra, not needed call to ->parameter ? */
-        $_st = $this->_getComponentStyle($this->_topic);
@@ -784 +761 @@
-
-        $this->_snippetdir = $this->_getComponentSnippetdir($this->_topic);
-
-        debug_pop();
-        return true;
-    }

trunk/midcom/midcom.core/midcom/helper/configuration.php

@@ -200 +200 @@
-                    debug_push_class(__CLASS__, __FUNCTION__);
-                    debug_add("The key {$key} is not present in the global configuration array.", MIDCOM_LOG_INFO);
-                    debug_print_r("Current global configuration:", $this->_global);
-                    debug_pop();
-                }

trunk/midcom/midcom.core/midcom/services/auth.php

@@ -519 +519 @@
-        if (! $credencials)
-        {
-            debug_add('No new authentication credencials found.');
-            debug_pop();
-            return false;
-        }
@@ -1131 +1129 @@
-
-        debug_add("Entered SUDO mode for domain {$domain}.", MIDCOM_LOG_INFO);
-        debug_print_function_stack("SUDO mode at depth {$this->_component_sudo} granted for this caller:");
-
-        debug_pop();

trunk/midcom/midcom.core/midcom/services/cache.php

@@ -76 +76 @@
-    function initialize()
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-
-        foreach ($GLOBALS['midcom_config']['cache_autoload_queue'] as $name)
-        {
-            debug_add("Auto-Loading module {$name}", MIDCOM_LOG_DEBUG);
-            $this->load_module($name);
-        }
-
-        debug_pop();
-    }
-
@@ -93 +88 @@
-    function shutdown()
-    {
-        debug_push_class(__CLASS__, __FUNCTION__);
-
-        foreach ($this->_unload_queue as $name)
-        {
-            debug_add("Stopping module {$name}", MIDCOM_LOG_INFO);
-            $this->_modules[$name]->shutdown();
-        }
-
-        debug_pop();
-    }
-

trunk/midcom/midcom.core/midcom/services/cache/module/content.php

@@ -372 +372 @@
-        if ($this->_uncached)
-        {
-            debug_push_class(__CLASS__, __FUNCTION__);
-            debug_add('We are in uncached operation, skipping check_hit detection.');
-            debug_pop();
-            return;
-        }