Skip to content

Latest commit

 

History

History
59 lines (33 loc) · 1.99 KB

Dev-API:-GustavDest.md

File metadata and controls

59 lines (33 loc) · 1.99 KB

##Instance functions

###private void initPath()

Builds the real destination path for a source file and initializes the object's $path property.

###private void initContent()

Builds the final content of the destination file and initializes the object's $content property.

###public mixed __call( string $function_name, array $arguments )

A magic overloading function is called when an object's non-reachable function is called.
This function is used to emulate global getter functions for some of the object's properties. The following getters are available:

getPath()
The path of the destination file ($path property).
<dt><code>getSrc()</code></dt>
<dd>The <a href="API#gustavsrc"><code>GustavSrc</code></a> object for the used source file (<a href="#private-gustavsrc-src"><code>$src</code> property</a>).</dd>

<dt><code>getContent()</code></dt>
<dd>The final content of the destination file (<a href="#private-string-content"><code>$content</code> property</a>).</dd>

If any other non-reachable function is called, a BadMethodCallException is thrown.

$function_name
The name of the called function.
<dt><code>$arguments</code></dt>
<dd>The arguments passed to the called function.</dd>

##Instance properties

###private GustavSrc $src

A GustavSrc object representing the source of the destination file.

###private string $path

The path of the destination file.

###private string $content

The destination file's final content.

##Constants

###string HOOKS_CLASS

The name, including the namespace, of GustavDest's corresponding Hooks class.