Daizu::File 0.3

Daizu::File is a Perl class representing files in working copies.

Each object of this class represents a particular file in a Daizu CMS working copy (a record in the wc_file table).

METHODS

Note that all the functions which return the value of a Subversion property will strip leading and trailing whitespace, and treat a value which is empty or entirely whitespace as if it wasnt set at all.

Daizu::File->new($cms, $file_id)

Return a new Daizu::File object for the file with the specified ID number.

$file->data

Return a reference to a string containing the file data (content).

$file->wc

Return a Daizu::Wc object representing the working copy in which this file lives.

$file->guid_uri

Return the GUID URI for this file.

$file->directory_path

Returns the path of a directory, either the same as the file if its a directory itself, or the path of its parent directory, or if its at the top level.

$file->permalink

Returns the first URL generated by the file, which will be the URL you want to link to most of the time. For articles this will always be the normal HTML version of the article, even if there are also other URLs available for it, and it will always be the first page of multipage articles. For non-article files there is no guarantee about what this will return, but most will only generate a single URL anyway, and for those that dont generators are likely to return the most linkable URL first.

The URL returned is an absolute URL provided as a URI object.

Returns nothing if the file doesnt generate any URLs.

There are some cases where this might not be what you want. For example, the root directory of a website using Daizu::Gen will either not generate a URL at all, or will generate one for a Google sitemap XML file, neither of which is likely to be useful for linking. To get the URL of the website you would probably need to find a file called something like _index.html. On the other hand, the Daizu::Gen::Blog generator will give you a sensible URL for the blog homepage if you call this on its root directory.

$file->urls_in_db($method, $argument)

Return a list of the URLs (plain strings, each an absolute URI) of the file which have the specified method and argument values, drawing from the url table in the database.

$file->article_urls

Return information about the URLs which the file should have, if it is an article. Fails if it isnt.