cchost
[ class tree: cchost ] [ index: cchost ] [ all elements ]

Class: CCMacro

Source Location: /cclib/cc-macro.php

Class Overview


Macro API for handling macro translations


Methods



Class Details

[line 34]
Macro API for handling macro translations



[ Top ]


Class Methods


method OnGetMacros [line 44]

void OnGetMacros( mixed &$dummy, mixed &$dummy1, array &$patterns, mixed &$dummy2, array &$record, array &$file, array &$mask)

Event handler for CC_EVENT_GET_MACROS



Parameters:

array   &$record   Upload record we're getting macros for (if null returns documentation)
array   &$file   File record we're getting macros for
array   &$patterns   Substituion pattern to be used when renaming/tagging
array   &$mask   Actual mask to use (based on admin specifications)

[ Top ]

method TranslateMask [line 63]

string TranslateMask( array $patterns, string $mask, [bool $replace_sp = false])

Compiles (expands) macros in mask into string



Tags:

return:  Expanded/compiled string


Parameters:

array   $patterns   Macro patters and their values
string   $mask   String containing macros to expand
bool   $replace_sp   Set to true to place spaces with '_'

[ Top ]


Documentation generated on Sat, 17 Nov 2007 01:04:02 +0000 by phpDocumentor 1.3.0RC4