Documentation

Changes
in package
implements IteratorAggregate, Wrapper, Stringable Uses WrapperTrait

Wrapper for the CHANGES file.

Tags
category

Horde

author

Jan Schneider jan@horde.org

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Interfaces, Classes, Traits and Enums

IteratorAggregate
Wrapper
Interface for the component file wrappers.
Stringable

Table of Contents

$_changes  : string
The file contents.
$_file  : string
Full path to the file.
__construct()  : mixed
Constructor.
__toString()  : string
Returns the file contents.
add()  : void
Adds content to the CHANGES file.
clear()  : void
Clears the content of the CHANGES file.
diff()  : string
Returns a diff between the saved and the current version of the file.
exists()  : bool
Returns whether the file exists.
getFileName()  : string
Returns the file name.
getFullPath()  : string
Returns the full path to the file.
getIterator()  : ArrayIterator
Returns the iterator over the changes.
getLocalPath()  : string
Returns the local path to the file inside the package.
save()  : mixed
Saves this object to the file.

Properties

$_changes

The file contents.

protected string $_changes = []

Methods

__construct()

Constructor.

public __construct(string $docDir) : mixed
Parameters
$docDir : string

Directory with CHANGES.

Return values
mixed

__toString()

Returns the file contents.

public __toString() : string
Return values
string

add()

Adds content to the CHANGES file.

public add(string $content) : void
Parameters
$content : string

Content to add.

Return values
void

clear()

Clears the content of the CHANGES file.

public clear() : void
Return values
void

diff()

Returns a diff between the saved and the current version of the file.

public diff([Wrapper $wrapper = null ]) : string
Parameters
$wrapper : Wrapper = null
Return values
string

File diff.

exists()

Returns whether the file exists.

public exists() : bool
Return values
bool

True if the file exists.

getFileName()

Returns the file name.

public getFileName() : string
Return values
string

The file name.

getFullPath()

Returns the full path to the file.

public getFullPath() : string
Return values
string

Path to the file.

getIterator()

Returns the iterator over the changes.

public getIterator() : ArrayIterator
Return values
ArrayIterator

An iterator.

getLocalPath()

Returns the local path to the file inside the package.

public getLocalPath(string $dir) : string
Parameters
$dir : string

The package directory.

Return values
string

Path to the file.

save()

Saves this object to the file.

public save() : mixed
Return values
mixed

Search results