PHP Class CalendR\Period\Factory

Contains methods that instantiate periods from given arguments

Author: Yohan Giarelli ([email protected])

Inheritance: implements CalendR\Period\FactoryInterface

Show file Open project: yohang/calendr

Protected Properties

Property	Type	Description
$options	array
$resolver	Symfony\Component\OptionsResolver\OptionsResolver

Public Methods

Method	Description
__construct ( array $options = [] )
createDay ( DateTime $begin )
createHour ( DateTime $begin )
createMinute ( DateTime $begin )
createMonth ( DateTime $begin )
createRange ( DateTime $begin, DateTime $end )
createSecond ( DateTime $begin )
createWeek ( DateTime $begin )
createYear ( DateTime $begin )
findFirstDayOfWeek ( $dateTime )
getFirstWeekday ( )
getOption ( string $name ) : mixed
setFirstWeekday ( $firstWeekday )
setOption ( string $name, mixed $value )

Protected Methods

Method	Description
resolveOptions ( array $options ) : array
setDefaultOptions ( Symfony\Component\OptionsResolver\OptionsResolver $resolver )	Override this method if you have to change default/allowed options.

Method Details

__construct() public method

public __construct ( array $options = [] )
$options	array

createDay() public method

public createDay ( DateTime $begin )
$begin	DateTime

createHour() public method

public createHour ( DateTime $begin )
$begin	DateTime

createMinute() public method

public createMinute ( DateTime $begin )
$begin	DateTime

createMonth() public method

public createMonth ( DateTime $begin )
$begin	DateTime

createRange() public method

public createRange ( DateTime $begin, DateTime $end )
$begin	DateTime
$end	DateTime

createSecond() public method

public createSecond ( DateTime $begin )
$begin	DateTime

createWeek() public method

public createWeek ( DateTime $begin )
$begin	DateTime

createYear() public method

public createYear ( DateTime $begin )
$begin	DateTime

findFirstDayOfWeek() public method

public findFirstDayOfWeek ( $dateTime )

getFirstWeekday() public method

public getFirstWeekday ( )

getOption() public method

public getOption ( string $name ) : mixed
$name	string
return	mixed

resolveOptions() protected method

protected resolveOptions ( array $options ) : array
$options	array
return	array

setDefaultOptions() protected method

Override this method if you have to change default/allowed options.

protected setDefaultOptions ( Symfony\Component\OptionsResolver\OptionsResolver $resolver )
$resolver	Symfony\Component\OptionsResolver\OptionsResolver

setFirstWeekday() public method

public setFirstWeekday ( $firstWeekday )

setOption() public method

public setOption ( string $name, mixed $value )
$name	string
$value	mixed

Property Details

$options protected property

protected array $options
return	array

$resolver protected property

protected OptionsResolver,Symfony\Component\OptionsResolver $resolver
return	Symfony\Component\OptionsResolver\OptionsResolver