VCI::Abstract::Directory - A directory in the repository.
This represents a directory, which can contain other directories and files.
VCI::Abstract::Directory implements VCI::Abstract::Committable and VCI::Abstract::FileContainer, so it has all of the methods available there, in addition to any methods listed in this documentation.
All these accessors are read-only.
name
In addition to what's specified in VCI::Abstract::Committable:
If this is the root directory of the project, this will just be an empty string.
path
Root directories always have an "empty" Path. That is, the path is an empty string.
contents_history_recursive
The normal "contents_history" in VCI::Abstract::FileContainer only returns the History of items directly contained in the directory.
This accsessor returns an entire VCI::Abstract::History for all items in the Project from this directory down.
So, for example, if dir1 contains dir2, and dir2 contains dir3, this method would return the History of all items contained in dir1, dir2, and dir3.
Usually you won't construct an instance of this class directly, but instead, use various methods of other modules that create Directory objects by interacting with the Project.
new
Takes all "Accessors" of this class, VCI::Abstract::Committable, and VCI::Abstract::FileContainer as named parameters. The following fields are required: "path" and project.
If you don't specify revision, VCI assumes you want an object representing the "latest" or "HEAD" revision of this Directory.
To install VCI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm VCI
CPAN shell
perl -MCPAN -e shell install VCI
For more information on module installation, please visit the detailed CPAN module installation guide.