FriendsOfPear / Calendar

src/Factory.php

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */

/**
 * Contains the Calendar_Factory class
 *
 * PHP versions 4 and 5
 *
 * LICENSE: Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Date and Time
 * @package   Calendar
 * @author    Harry Fuecks <hfuecks@phppatterns.com>
 * @author    Lorenzo Alberton <l.alberton@quipo.it>
 * @copyright 2003-2007 Harry Fuecks, Lorenzo Alberton
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
 * @version   CVS: $Id$
 * @link      http://pear.php.net/package/Calendar
 */
namespace PEAR\Calendar;

/**
 * Contains a factory method to return a Singleton instance of a class
 * implementing the Calendar_Engine_Interface.<br>
 * For Month objects, to control type of month returned, use CALENDAR_MONTH_STATE
 * constact e.g.;
 * <code>
 * require_once 'Calendar/Factory.php';
 * define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKDAYS); // Use Calendar_Month_Weekdays
 * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKS); // Use Calendar_Month_Weeks
 * // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH); // Use Calendar_Month
 * </code>
 * It defaults to building Calendar_Month objects.<br>
 * Use the constract CALENDAR_FIRST_DAY_OF_WEEK to control the first day of the week
 * for Month or Week objects (e.g. 0 = Sunday, 6 = Saturday)
 *
 * @category  Date and Time
 * @package   Calendar
 * @author    Harry Fuecks <hfuecks@phppatterns.com>
 * @author    Lorenzo Alberton <l.alberton@quipo.it>
 * @copyright 2003-2007 Harry Fuecks, Lorenzo Alberton
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
 * @link      http://pear.php.net/package/Calendar
 * @access protected
 */
class Factory
{
    /**
     * Creates a calendar object given the type and units
     *
     * @param string $type class of calendar object to create
     * @param int    $y    year
     * @param int    $m    month
     * @param int    $d    day
     * @param int    $h    hour
     * @param int    $i    minute
     * @param int    $s    second
     *
     * @return object subclass of Calendar
     * @access public
     * @static
     */
    function create($type, $y = 2000, $m = 1, $d = 1, $h = 0, $i = 0, $s = 0)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $firstDay = defined('CALENDAR_FIRST_DAY_OF_WEEK') ? CALENDAR_FIRST_DAY_OF_WEEK : 1;
        switch ($type) {
        case 'Day':
            return new Day($y, $m, $d);
        case 'Month':
            // Set default state for which month type to build
            if (!defined('CALENDAR_MONTH_STATE')) {
                define('CALENDAR_MONTH_STATE', CALENDAR_USE_MONTH);
            }
            switch (CALENDAR_MONTH_STATE) {
            case CALENDAR_USE_MONTH_WEEKDAYS:
                $class = 'PEAR\Calendar\Month\Weekdays';
                break;
            case CALENDAR_USE_MONTH_WEEKS:
                $class = 'PEAR\Calendar\Month\Weeks';
                break;
            case CALENDAR_USE_MONTH:
            default:
                $class = 'PEAR\Calendar\Month';
                break;
            }
            return new $class($y, $m, $firstDay);
        case 'Week':
            return new Week($y, $m, $d, $firstDay);
        case 'Hour':
            return new Hour($y, $m, $d, $h);
        case 'Minute':
            return new Minute($y, $m, $d, $h, $i);
        case 'Second':
            return new Second($y, $m, $d, $h, $i, $s);
        case 'Year':
            return new Year($y);
        default:
            include_once 'PEAR.php';
            PEAR::raiseError('Calendar_Factory::create() unrecognised type: '.$type,

The type PEAR\Calendar\PEAR was not found. Maybe you did not declare it correctly or list all dependencies?

                null, PEAR_ERROR_TRIGGER, E_USER_NOTICE, 'Calendar_Factory::create()');

The constant PEAR\Calendar\PEAR_ERROR_TRIGGER was not found. Maybe you did not declare it correctly or list all dependencies?

            return false;

The expression return false returns the type false which is incompatible with the documented return type object.

        }
    }

    /**
     * Creates an instance of a calendar object, given a type and timestamp
     *
     * @param string $type  type of object to create
     * @param mixed  $stamp timestamp (depending on Calendar engine being used)
     *
     * @return object subclass of Calendar
     * @access public
     * @static
     */
    function & createByTimestamp($type, $stamp)
    {
        $cE  = & Calendar_Engine_Factory::getEngine();
        $y   = $cE->stampToYear($stamp);
        $m   = $cE->stampToMonth($stamp);
        $d   = $cE->stampToDay($stamp);
        $h   = $cE->stampToHour($stamp);
        $i   = $cE->stampToMinute($stamp);
        $s   = $cE->stampToSecond($stamp);
        $cal = Factory::create($type, $y, $m, $d, $h, $i, $s);

The method PEAR\Calendar\Factory::create() is not static, but was called statically.

        return $cal;
    }
}