ZipStream\Option\File Class Reference

Collaboration diagram for ZipStream\Option\File:

Public Member Functions
	defaultTo (Archive $archiveOptions)
	getComment ()
	setComment (string $comment)
	getMethod ()
	setMethod (Method $method)
	getDeflateLevel ()
	setDeflateLevel (int $deflateLevel)
	getTime ()
	setTime (DateTime $time)
	getSize ()
	setSize (int $size)

Private Attributes
	$comment = ''
	$method
	$deflateLevel
	$time
	$size = 0

Detailed Description

Definition at line 8 of file File.php.

Member Function Documentation

defaultTo()

ZipStream\Option\File::defaultTo

(

Archive

$archiveOptions

)

Definition at line 31 of file File.php.

References ZipStream\Option\Archive\getDeflateLevel().

                                                      : void
    {
        $this->deflateLevel = $this->deflateLevel ?: $archiveOptions->getDeflateLevel();
        $this->time = $this->time ?: new DateTime();
    }

Here is the call graph for this function:

getComment()

ZipStream\Option\File::getComment

(

)

Returns

string

Definition at line 40 of file File.php.

References ZipStream\Option\File\$comment.

                                : string
    {
        return $this->comment;
    }

getDeflateLevel()

ZipStream\Option\File::getDeflateLevel

(

)

Returns

int

Definition at line 72 of file File.php.

References ZipStream\Option\Archive\DEFAULT_DEFLATE_LEVEL.

                                     : int
    {
        return $this->deflateLevel ?: Archive::DEFAULT_DEFLATE_LEVEL;
    }

getMethod()

ZipStream\Option\File::getMethod

(

)

Returns

Method

Definition at line 56 of file File.php.

References ZipStream\Option\Method\DEFLATE.

                               : Method
    {
        return $this->method ?: Method::DEFLATE();
    }

getSize()

ZipStream\Option\File::getSize

(

)

Returns

int

Definition at line 104 of file File.php.

References ZipStream\Option\File\$size.

                             : int
    {
        return $this->size;
    }

getTime()

ZipStream\Option\File::getTime

(

)

Returns

DateTime

Definition at line 88 of file File.php.

References ZipStream\Option\File\$time.

                             : DateTime
    {
        return $this->time;
    }

setComment()

ZipStream\Option\File::setComment

(

string

$comment

)

Parameters

string

$comment

Definition at line 48 of file File.php.

References ZipStream\Option\File\$comment, and comment().

                                               : void
    {
        $this->comment = $comment;
    }

Here is the call graph for this function:

setDeflateLevel()

ZipStream\Option\File::setDeflateLevel

(

int

$deflateLevel

)

Parameters

int

$deflateLevel

Definition at line 80 of file File.php.

References ZipStream\Option\File\$deflateLevel.

                                                      : void
    {
        $this->deflateLevel = $deflateLevel;
    }

setMethod()

ZipStream\Option\File::setMethod

(

Method

$method

)

Parameters

Method

$method

Definition at line 64 of file File.php.

References ZipStream\Option\File\$method.

                                             : void
    {
        $this->method = $method;
    }

setSize()

ZipStream\Option\File::setSize

(

int

$size

)

Parameters

int

$size

Definition at line 112 of file File.php.

References ZipStream\Option\File\$size, and size.

                                      : void
    {
        $this->size = $size;
    }

setTime()

ZipStream\Option\File::setTime

(

DateTime

$time

)

Parameters

DateTime

$time

Definition at line 96 of file File.php.

References ZipStream\Option\File\$time.

                                           : void
    {
        $this->time = $time;
    }

Field Documentation

$comment

ZipStream\Option\File::$comment = ''

private

Definition at line 13 of file File.php.

Referenced by ZipStream\Option\File\getComment(), and ZipStream\Option\File\setComment().

$deflateLevel

ZipStream\Option\File::$deflateLevel

private

Definition at line 21 of file File.php.

Referenced by ZipStream\Option\File\setDeflateLevel().

$method

ZipStream\Option\File::$method

private

Definition at line 17 of file File.php.

Referenced by ZipStream\Option\File\setMethod().

$size

ZipStream\Option\File::$size = 0

private

Definition at line 29 of file File.php.

Referenced by ZipStream\Option\File\getSize(), and ZipStream\Option\File\setSize().

$time

ZipStream\Option\File::$time

private

Definition at line 25 of file File.php.

Referenced by ZipStream\Option\File\getTime(), and ZipStream\Option\File\setTime().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/maennchen/zipstream-php/src/Option/File.php