observable.php

Aller à la documentation de ce fichier.

<?php
/**
 * @package     Joomla.Legacy
 * @subpackage  Base
 *
 * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

/**
 * Abstract observable class to implement the observer design pattern
 *
 * @package     Joomla.Legacy
 * @subpackage  Base
 * @since       11.1
 * @deprecated  12.3 (Platform) & 4.0 (CMS)
 * @codeCoverageIgnore
 */
class JObservable extends JObject
{
        /**
         * An array of Observer objects to notify
         *
         * @var    array
         * @since  11.1
         * @deprecated  12.3
         */
        protected $_observers = array();

        /**
         * The state of the observable object
         *
         * @var    mixed
         * @since  11.1
         * @deprecated  12.3
         */
        protected $_state = null;

        /**
         * A multi dimensional array of [function][] = key for observers
         *
         * @var    array
         * @since  11.1
         * @deprecated  12.3
         */
        protected $_methods = array();

        /**
         * Constructor
         *
         * Note: Make Sure it's not directly instantiated
         *
         * @deprecated  12.3
         */
        public function __construct()
        {
                $this->_observers = array();
        }

        /**
         * Get the state of the JObservable object
         *
         * @return  mixed    The state of the object.
         *
         * @since   11.1
         * @deprecated  12.3
         */
        public function getState()
        {
                return $this->_state;
        }

        /**
         * Update each attached observer object and return an array of their return values
         *
         * @return  array    Array of return values from the observers
         *
         * @since   11.1
         * @deprecated  12.3
         */
        public function notify()
        {
                // Iterate through the _observers array
                foreach ($this->_observers as $observer)
                {
                        $return[] = $observer->update();
                }

                return $return;
        }

        /**
         * Attach an observer object
         *
         * @param   object  $observer  An observer object to attach
         *
         * @return  void
         *
         * @since   11.1
         * @deprecated  12.3
         */
        public function attach($observer)
        {
                if (is_array($observer))
                {
                        if (!isset($observer['handler']) || !isset($observer['event']) || !is_callable($observer['handler']))
                        {
                                return;
                        }

                        // Make sure we haven't already attached this array as an observer
                        foreach ($this->_observers as $check)
                        {
                                if (is_array($check) && $check['event'] == $observer['event'] && $check['handler'] == $observer['handler'])
                                {
                                        return;
                                }
                        }

                        $this->_observers[] = $observer;
                        end($this->_observers);
                        $methods = array($observer['event']);
                }
                else
                {
                        if (!($observer instanceof JObserver))
                        {
                                return;
                        }

                        // Make sure we haven't already attached this object as an observer
                        $class = get_class($observer);

                        foreach ($this->_observers as $check)
                        {
                                if ($check instanceof $class)
                                {
                                        return;
                                }
                        }

                        $this->_observers[] = $observer;
                        $methods = array_diff(get_class_methods($observer), get_class_methods('JPlugin'));
                }

                $key = key($this->_observers);

                foreach ($methods as $method)
                {
                        $method = strtolower($method);

                        if (!isset($this->_methods[$method]))
                        {
                                $this->_methods[$method] = array();
                        }

                        $this->_methods[$method][] = $key;
                }
        }

        /**
         * Detach an observer object
         *
         * @param   object  $observer  An observer object to detach.
         *
         * @return  boolean  True if the observer object was detached.
         *
         * @since   11.1
         * @deprecated  12.3
         */
        public function detach($observer)
        {
                $retval = false;

                $key = array_search($observer, $this->_observers);

                if ($key !== false)
                {
                        unset($this->_observers[$key]);
                        $retval = true;

                        foreach ($this->_methods as &$method)
                        {
                                $k = array_search($key, $method);

                                if ($k !== false)
                                {
                                        unset($method[$k]);
                                }
                        }
                }

                return $retval;
        }
}