Recurr\Rule::getWeekStartAsNum PHP Method

getWeekStartAsNum() public method

Get the day on which the workweek starts, as an integer from 0-6, 0 being Monday and 6 being Sunday.
public getWeekStartAsNum ( ) : integer
return integer
    public function getWeekStartAsNum()
    {
        $weekStart = $this->getWeekStart();
        return $this->days[$weekStart];
    }

Usage Example

 /**
  * Get an array of DOY (Day of Year) for each day in a particular week.
  *
  * @param \DateTime     $dt
  * @param \DateTime     $start
  * @param null|Rule     $rule
  * @param null|DateInfo $dtInfo
  *
  * @return DaySet
  */
 public static function getDaySetOfWeek(\DateTime $dt, \DateTime $start, Rule $rule = null, DateInfo $dtInfo = null)
 {
     $start = clone $dt;
     $start->setDate($start->format('Y'), 1, 1);
     $diff = $dt->diff($start);
     $start = $diff->days;
     $set = array();
     for ($i = $start, $k = 0; $k < 7; $k++) {
         $set[] = $i;
         ++$i;
         if (null !== $dtInfo && null !== $rule && $dtInfo->wDayMask[$i] == $rule->getWeekStartAsNum()) {
             break;
         }
     }
     $obj = new DaySet($set, $start, $i);
     return $obj;
 }
All Usage Examples Of Recurr\Rule::getWeekStartAsNum