AppserverIo\Psr\EnterpriseBeans\ScheduleExpression

Complexity

Total Complexity

26

Size/Duplication

Total Lines	355
Duplicated Lines	0 %

Coupling/Cohesion

Components	10
Dependencies	0

Test Coverage

Coverage

6.1%

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	serialize()	0	4	1
A	unserialize()	0	6	2
A	dayOfMonth()	0	5	1
A	dayOfWeek()	0	5	1
A	end()	0	5	1
A	getDayOfMonth()	0	4	1
A	getDayOfWeek()	0	4	1
A	getEnd()	0	4	1
A	getHour()	0	4	1
A	getMinute()	0	4	1
A	getMonth()	0	4	1
A	getSecond()	0	4	1
A	getStart()	0	4	1
A	getTimezone()	0	10	3
A	getYear()	0	4	1
A	hour()	0	5	1
A	minute()	0	5	1
A	month()	0	5	1
A	second()	0	5	1
A	start()	0	5	1
A	timezone()	0	5	1
A	year()	0	5	1
A	__toString()	0	27	1

<?php

/**
 * AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/epb
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Psr\EnterpriseBeans;

/**
 * A calendar-based timeout expression for an enterprise bean timer.
 *
 * Each expression attribute has two overloaded setter methods, one that takes a String and one that takes an int.
 * The int version is merely a convenience method for setting the attribute in the common case that the value is a
 * simple integer.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/epb
 * @link      http://www.appserver.io
 */
class ScheduleExpression implements \Serializable
{

    /**
     * The date format we use to serialize/unserialize \DateTime properties.
     *
     * @var string
     */
    const DATE_FORMAT = 'Y-m-d H:i:s';

    /**
     * @var string
     */
    private $dayOfMonth = "*";

    /**
     * @var string
     */
    private $dayOfWeek = "*";

    /**
     * @var string
     */
    private $end;

    /**
     * @var string
     */
    private $hour = "0";

    /**
     * @var string
     */
    private $minute = "0";

    /**
     * @var string
     */
    private $month = "*";

    /**
     * @var string
     */
    private $second = "0";

    /**
     * @var string
     */
    private $start;

    /**
     * @var string
     */
    private $timezone = "";

    /**
     * @var string
     */
    private $year = "*";

    /**
     * String representation of object.
      *
     * @return string the string representation of the object or null
     * @link http://php.net/manual/en/serializable.serialize.php
     */
    public function serialize()
    {
        return serialize(get_object_vars($this));
    }

    /**
     * Constructs the object
     *
     * @param string $data The string representation of the object
     *
     * @return void
     * @link http://php.net/manual/en/serializable.unserialize.php
     */
    public function unserialize($data)
    {
        foreach (unserialize($data) as $propertyName => $propertyValue) {
            $this->$propertyName = $propertyValue;
        }
    }

    /**
     * Sets the day of month
     *
     * @param String $dayOfMonth The string
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function dayOfMonth($dayOfMonth)
    {
        $this->dayOfMonth = (string) $dayOfMonth;
        return $this;
    }

    /**
     * Sets the day of week
     *
     * @param int|string $dayOfWeek The day of week
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function dayOfWeek($dayOfWeek)
    {
        $this->dayOfWeek = (string) $dayOfWeek;
        return $this;
    }

    /**
     * Sets the day of week.
     *
     * @param string $end The end date time
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function end($end)
    {
        $this->end = (string) $end;
        return $this;
    }

    /**
     * Returns day of month.
     *
     * @return string
     */
    public function getDayOfMonth()
    {
        return $this->dayOfMonth;
    }

    /**
     * Returns day of week.
     *
     * @return string
     */
    public function getDayOfWeek()
    {
        return $this->dayOfWeek;
    }

    /**
     * Returns end datetime.
     *
     * @return string
     */
    public function getEnd()
    {
        return $this->end;
    }

    /**
     * Returns hour.
     *
     * @return string
     */
    public function getHour()
    {
        return $this->hour;
    }

    /**
     * Returns minute.
     *
     * @return string
     */
    public function getMinute()
    {
        return $this->minute;
    }

    /**
     * Returns month.
     *
     * @return string
     */
    public function getMonth()
    {
        return $this->month;
    }

    /**
     * Returns second.
     *
     * @return string
     */
    public function getSecond()
    {
        return $this->second;
    }

    /**
     * Returns start date time.
     *
     * @return string
     */
    public function getStart()
    {
        return $this->start;
    }

    /**
     * Returns the timezone.
     *
     * @return null|string
     */
    public function getTimezone()
    {
        // Note that attributes use the empty string "" as a default,
        // so the expression @Schedule(timezone="", ...) will result in a null value from the
        // corresponding ScheduleExpression->getTimezone() method.
        if ($this->timezone != null && empty($this->timezone)) {
            return null;
        }
        return $this->timezone;
    }

    /**
     * Returns the year.
     *
     * @return string
     */
    public function getYear()
    {
        return $this->year;
    }

    /**
     * Sets the hour.
     *
     * @param int|string $hour the hour to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function hour($hour)
    {
        $this->hour = (string) $hour;
        return $this;
    }

    /**
     * Sets the minute.
     *
     * @param int|string $minute The minute to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function minute($minute)
    {
        $this->minute = (string) $minute;
        return $this;
    }

    /**
     * Sets the month.
     *
     * @param int|string $month The month to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function month($month)
    {
        $this->month = (string) $month;
        return $this;
    }

    /**
     * Sets the second.
     *
     * @param int|string $second The second to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function second($second)
    {
        $this->second = (string) $second;
        return $this;
    }

    /**
     * Sets the start date time.
     *
     * @param string $start The start date time to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function start($start)
    {
        $this->start = (string) $start;
        return $this;
    }

    /**
     * Sets the timezone.
     *
     * @param int|string $timezone The timezone to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function timezone($timezone)
    {
        $this->timezone = (string) $timezone;
        return $this;
    }

    /**
     * Sets the year.
     *
     * @param int|string $year The year to set
     *
     * @return \AppserverIo\Psr\EnterpriseBeans\ScheduleExpression
     */
    public function year($year)
    {
        $this->year = (string) $year;
        return $this;
    }

    /**
     * Renders the object to string.
     *
     * @return string
     */
    public function __toString()
    {
        $s = "ScheduleExpression[";
        $s .= "second=";
        $s .= $this->second;
        $s .= " minute=";
        $s .= $this->minute;
        $s .= " hour=";
        $s .= $this->hour;
        $s .= " dayOfWeek=";
        $s .= $this->dayOfWeek;
        $s .= " dayOfMonth=";
        $s .= $this->dayOfMonth;
        $s .= " month=";
        $s .= $this->month;
        $s .= " year=";
        $s .= $this->year;
        $s .= " start=";
        $s .= (string)$this->start;
        $s .= " end=";
        $s .= (string)$this->end;
        $s .= " timezone=";
        $s .= $this->timezone;
        $s .= "]";

        return $s;
    }
}