Location: PHPKode > projects > Moc10 PHP Library > docs/api-glossary.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- Header //-->
<html>

<head>

    <title>
        Moc10 Library v1.9.7 | A Lightweight PHP Library
    </title>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="author" content="Nick Sagona"/>
    <meta name="keywords" content="php, php library, php framework, php code library, moc10 library, moc10media, moc 10 media, moc 10, object oriented programming, oop" />
    <meta name="description" content="Moc10 Library is a lightweight, easily deployable PHP library that integrates a handful of some of the 'basics' that go into many websites, projects and applications." />
    <meta name="robots" content="all" />

    <link rel="stylesheet" type="text/css" href="styles.css" />
    <link rel="shortcut icon" href="moc10media.ico" type="image/ico" />

</head>

<body>
<!-- Content //-->
<div id="content">
    <a name="top"></a>
    <h1>Moc10 Library v1.9.7 | A Lightweight PHP Library</h1>
    <ul id="mainNav">
        <li><a href="./index.html">Overview</a></li>
        <li><a href="./features.html">Features</a></li>
        <li><a href="./manual.html">Manual</a></li>
        <li>API Glossary</li>
        <li><a href="./api-docs/index.html">API Docs</a></li>
        <li><a href="./faqs.html">FAQs</a></li>
        <li><a href="./development.html">Development</a></li>
        <li><a href="./download.html">Download</a></li>
    </ul>
    <h3>API Glossary</h3>
    <ul>
        <li><a href="./api-glossary.html#autoloader">The Autoloader Component</a></li>
        <li><a href="./api-glossary.html#cookie">The Cookie Component</a></li>
        <li><a href="./api-glossary.html#curl">The Curl Component</a></li>
        <li><a href="./api-glossary.html#db">The DB Connection Component</a></li>
        <li><a href="./api-glossary.html#dom">The DOM Component</a></li>
        <li><a href="./api-glossary.html#feed">The Feed Component</a></li>
        <li><a href="./api-glossary.html#file">The File Component</a></li>
        <li><a href="./api-glossary.html#form">The Form Component</a></li>
        <li><a href="./api-glossary.html#ftp">The FTP Component</a></li>
        <li><a href="./api-glossary.html#image">The Image Component</a></li>
        <li><a href="./api-glossary.html#lang">The Language Component</a></li>
        <li><a href="./api-glossary.html#mail">The Mail Component</a></li>
        <li><a href="./api-glossary.html#pdf">The PDF Component</a></li>
        <li><a href="./api-glossary.html#record">The Record Component</a></li>
        <li><a href="./api-glossary.html#session">The Session Component</a></li>
        <li><a href="./api-glossary.html#string">The String Component</a></li>
    </ul>
    <p>
        Below is the API Glossary of the Moc10 Library, which outlines many of the publicly accessible methods and properties that make up the API of the library.
    </p>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="autoloader"></a>
    <h4>The Autoloader Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/autoloader_bootstrap.html">Moc10_Autoloader::bootstrap()</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="cookie"></a>
    <h4>The Cookie Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/cookie_getinstance.html">$cookie = Moc10_Cookie::getInstance()</a>
<a href="./api-glossary/cookie_set.html">$cookie-&gt;set($name, $value, $exp = 0)</a>
<a href="./api-glossary/cookie_unset.html">unset($cookie-&gt;name)</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>

<a href="./api-glossary/cookie_data.html">$cookie-&gt;[data]</a> (i.e. $cookie-&gt;username)
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="curl"></a>
    <h4>The Curl Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/curl_construct.html">$curl = new Moc10_Curl($opts, $val = null)</a>
<a href="./api-glossary/curl_setoption.html">$curl-&gt;setOption($opt, $vl = null)</a>
<a href="./api-glossary/curl_getoption.html">$curl-&gt;getOption($opt)</a>
<a href="./api-glossary/curl_execute.html">$curl-&gt;execute()</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>

<a href="./api-glossary/curl_data.html">$curl-&gt;data</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="db"></a>
    <h4>The DB Connection Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/db_getinstance.html">$db = Moc10_Db::getInstance($type = null, $dbase = null, $host = null, $user = null, $pass = null)</a>
<a href="./api-glossary/db_query.html">$db-&gt;interface-&gt;query($sql)</a>
<a href="./api-glossary/db_fetch.html">$db-&gt;interface-&gt;fetch()</a>
<a href="./api-glossary/db_escape.html">$db-&gt;interface-&gt;escape()</a>
<a href="./api-glossary/db_lastid.html">$db-&gt;interface-&gt;lastId()</a>
<a href="./api-glossary/db_numrows.html">$db-&gt;interface-&gt;numRows()</a>
<a href="./api-glossary/db_numfields.html">$db-&gt;interface-&gt;numFields()</a>
<a href="./api-glossary/db_gettables.html">$db-&gt;interface-&gt;getTables()</a>
<a href="./api-glossary/db_version.html">$db-&gt;interface-&gt;version()</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="dom"></a>
    <h4>The DOM Component</h4>
    <br />
    <h5 class="underline">Methods (Moc10_Dom)</h5>
    <pre>

<a href="./api-glossary/dom_construct.html">$doc = new Moc10_Dom($type = null, $charset = 'utf-8', $childNode = null, $indent = null)</a>
<a href="./api-glossary/dom_gettype.html">$doc-&gt;getType()</a>
<a href="./api-glossary/dom_getcharset.html">$doc-&gt;getCharset()</a>
<a href="./api-glossary/dom_getindent.html">$doc-&gt;getIndent()</a>
<a href="./api-glossary/dom_settype.html">$doc-&gt;setType($type)</a>
<a href="./api-glossary/dom_setdtd.html">$doc-&gt;setDTD($dtd)</a>
<a href="./api-glossary/dom_setcharset.html">$doc-&gt;setCharset($chr)</a>
<a href="./api-glossary/dom_setindent.html">$doc-&gt;setIndent($ind)</a>
<a href="./api-glossary/dom_addchildren.html">$doc-&gt;addChildren($c)</a>
<a href="./api-glossary/dom_getchildren.html">$doc-&gt;getChildren()</a>
<a href="./api-glossary/dom_removechildren.html">$doc-&gt;removeChildren()</a>
<a href="./api-glossary/dom_render.html">$doc-&gt;render($ret = false)</a>
    </pre>
    <h5 class="underline">Methods (Moc10_Dom_Child)</h5>
    <pre>

<a href="./api-glossary/dom_child_construct.html">$child = new Moc10_Dom_Child($name, $value = null, $childNode = null, $first = false)</a>
<a href="./api-glossary/dom_child_getname.html">$child-&gt;getName()</a>
<a href="./api-glossary/dom_child_getvalue.html">$child-&gt;getValue()</a>
<a href="./api-glossary/dom_child_getindent.html">$child-&gt;getIndent()</a>
<a href="./api-glossary/dom_child_setname.html">$child-&gt;setName($name)</a>
<a href="./api-glossary/dom_child_setvalue.html">$child-&gt;setValue($value)</a>
<a href="./api-glossary/dom_child_setindent.html">$child-&gt;setIndent($ind)</a>
<a href="./api-glossary/dom_child_setattributes.html">$child-&gt;setAttributes($a, $v = null)</a>
<a href="./api-glossary/dom_child_getattributes.html">$child-&gt;getAttributes()</a>
<a href="./api-glossary/dom_child_addchildren.html">$child-&gt;addChildren($c)</a>
<a href="./api-glossary/dom_child_getchildren.html">$child-&gt;getChildren()</a>
<a href="./api-glossary/dom_child_removechildren.html">$child-&gt;removeChildren()</a>
<a href="./api-glossary/dom_child_render.html">$child-&gt;render($ret = false, $depth = 0, $indent = null)</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="feed"></a>
    <h4>The Feed Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/feed_reader_construct.html">$feedread = new Moc10_Feed_Reader($url, $limit = null)</a>
<a href="./api-glossary/feed_reader_setitemtemplate.html">$feedread-&gt;setItemTemplate($tmpl)</a>
<a href="./api-glossary/feed_reader_getfeedtype.html">$feedread-&gt;getFeedType()</a>
<a href="./api-glossary/feed_reader_render.html">$feedread-&gt;render($dt = null, $ret = false)</a>
<a href="./api-glossary/feed_writer_construct.html">$feedwrite = new Moc10_Feed_Writer($hdrs, $itms, $type = 'RSS', $dt = 'D, j M Y H:i:s O')</a>
<a href="./api-glossary/feed_writer_render.html">$feedwrite-&gt;render($ret = false)</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>
<a href="./api-glossary/feed_reader_title.html">$feedread-&gt;title</a>
<a href="./api-glossary/feed_reader_url.html">$feedread-&gt;url</a>
<a href="./api-glossary/feed_reader_desc.html">$feedread-&gt;desc</a>
<a href="./api-glossary/feed_reader_date.html">$feedread-&gt;date</a>
<a href="./api-glossary/feed_reader_generator.html">$feedread-&gt;generator</a>
<a href="./api-glossary/feed_reader_editor.html">$feedread-&gt;editor</a>
<a href="./api-glossary/feed_reader_items.html">$feedread-&gt;items[$i]</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="file"></a>
    <h4>The File Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/file_construct.html">$file = new Moc10_File($fl = null, $up = false, $typ = null)</a>
<a href="./api-glossary/file_dir_construct.html">$dir = new Moc10_File_Dir($dir, $full = false, $rec = false)</a>
<a href="./api-glossary/file_upload_construct.html">$file = new Moc10_File_Upload($upload, $file, $size = null, $types = null)</a>
<a href="./api-glossary/file_setfile.html">$file-&gt;setFile($file, $upload = false)</a>
<a href="./api-glossary/file_setallowedtypes.html">$file-&gt;setAllowedTypes($types)</a>
<a href="./api-glossary/file_getallowedtypes.html">$file-&gt;getAllowedTypes()</a>
<a href="./api-glossary/file_getmode.html">$file-&gt;getMode($dir = false)</a>
<a href="./api-glossary/file_setmode.html">$file-&gt;setMode($mode, $dir = false)</a>
<a href="./api-glossary/file_read.html">$file-&gt;read($off = null, $len = null)</a>
<a href="./api-glossary/file_write.html">$file-&gt;write($data, $append = null, $save = true)</a>
<a href="./api-glossary/file_copy.html">$file-&gt;copy($new)</a>
<a href="./api-glossary/file_move.html">$file-&gt;move($new)</a>
<a href="./api-glossary/file_output.html">$file-&gt;output($download = null)</a>
<a href="./api-glossary/file_export.html">$file-&gt;export($ary, $omit = null, $delim = ',', $esc = '"', $dt = null, $dload = true, $save = false)</a>
<a href="./api-glossary/file_import.html">$file-&gt;import($delim = ',', $esc = '"')</a>
<a href="./api-glossary/file_delete.html">$file-&gt;delete()</a>
<a href="./api-glossary/file_dir_getmode.html">$dir-&gt;getMode()</a>
<a href="./api-glossary/file_dir_setmode.html">$dir-&gt;setMode($mode)</a>
<a href="./api-glossary/file_dir_emptydir.html">$dir-&gt;emptyDir($path, $del = false)</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>
<a href="./api-glossary/file_fullpath.html">$file-&gt;fullpath</a>
<a href="./api-glossary/file_dir.html">$file-&gt;dir</a>
<a href="./api-glossary/file_basename.html">$file-&gt;basename</a>
<a href="./api-glossary/file_filename.html">$file-&gt;filename</a>
<a href="./api-glossary/file_ext.html">$file-&gt;ext</a>
<a href="./api-glossary/file_size.html">$file-&gt;size</a>
<a href="./api-glossary/file_mime.html">$file-&gt;mime</a>
<a href="./api-glossary/file_dir_path.html">$dir-&gt;path</a>
<a href="./api-glossary/file_dir_files.html">$dir-&gt;files</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="form"></a>
    <h4>The Form Component</h4>
    <br />
    <h5 class="underline">Methods (Moc10_Form)</h5>
    <pre>

<a href="./api-glossary/form_construct.html">$form = new Moc10_Form($action, $method, $indent = null)</a>
<a href="./api-glossary/form_setinitvalues.html">$form-&gt;setInitValues($values)</a>
<a href="./api-glossary/form_processinitvalues.html">$form-&gt;processInitValues()</a>
<a href="./api-glossary/form_setpostvalues.html">$form-&gt;setPostValues($post, $filter = false)</a>
<a href="./api-glossary/form_settemplate.html">$form-&gt;setTemplate($tmpl)</a>
<a href="./api-glossary/form_gettemplate.html">$form-&gt;getTemplate()</a>
<a href="./api-glossary/form_setattributes.html">$form-&gt;setAttributes($a, $v = null)</a>
<a href="./api-glossary/form_getattributes.html">$form-&gt;getAttributes()</a>
<a href="./api-glossary/form_addelements.html">$form-&gt;addElements($e)</a>
<a href="./api-glossary/form_getelements.html">$form-&gt;getElements()</a>
<a href="./api-glossary/form_isvalid.html">$form-&gt;isValid()</a>
<a href="./api-glossary/form_render.html">$form-&gt;render($ret = false)</a>
<a href="./api-glossary/form_tostring.html">print($form)</a>
    </pre>
    <h5 class="underline">Methods (Moc10_Form_Element)</h5>
    <pre>

<a href="./api-glossary/form_element_construct.html">$formelement = new Moc10_Form_Element($type, $name, $value = null, $marked = null, $indent = null)</a>
<a href="./api-glossary/form_element_checkbox_construct.html">$formelement = new Moc10_Form_Checkbox($name, $value = null, $marked = null, $indent = null)</a>
<a href="./api-glossary/form_element_radio_construct.html">$formelement = new Moc10_Form_Radio($name, $value = null, $marked = null, $indent = null)</a>
<a href="./api-glossary/form_element_select_construct.html">$formelement = new Moc10_Form_Select($name, $value = null, $marked = null, $indent = null)</a>
<a href="./api-glossary/form_element_textarea_construct.html">$formelement = new Moc10_Form_Textarea($name, $value = null, $marked = null, $indent = null)</a>
<a href="./api-glossary/form_element_setmarked.html">$formelement-&gt;setMarked($val)</a>  [For select, checkbox and radio elements only]
<a href="./api-glossary/form_element_setlabel.html">$formelement-&gt;setLabel($l)</a>
<a href="./api-glossary/form_element_setrequired.html">$formelement-&gt;setRequired($r)</a>
<a href="./api-glossary/form_element_addvalidator.html">$formelement-&gt;addValidator($type, $condition = true, $value = null, $msg = null)</a>
<a href="./api-glossary/form_element_render.html">$formelement-&gt;render()</a>
<a href="./api-glossary/form_element_validate.html">$formelement-&gt;validate()</a>
    </pre>
    <h5 class="underline">Properties (Moc10_Form_Element)</h5>
    <pre>

<a href="./api-glossary/form_element_value.html">$formelement-&gt;value</a>
<a href="./api-glossary/form_element_values.html">$formelement-&gt;values</a> [For select, checkbox and radio elements only]
<a href="./api-glossary/form_element_marked.html">$formelement-&gt;marked</a>
<a href="./api-glossary/form_element_label.html">$formelement-&gt;label</a>
<a href="./api-glossary/form_element_required.html">$formelement-&gt;required</a>
<a href="./api-glossary/form_element_validators.html">$formelement-&gt;validators</a>
<a href="./api-glossary/form_element_errors.html">$formelement-&gt;errors</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="ftp"></a>
    <h4>The FTP Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/ftp_construct.html">$ftp = new Moc10_Ftp($ftp, $user, $pass, $ssl = false)</a>
<a href="./api-glossary/ftp_pwd.html">$ftp-&gt;pwd()</a>
<a href="./api-glossary/ftp_chdir.html">$ftp-&gt;chdir($dir)</a>
<a href="./api-glossary/ftp_mkdir.html">$ftp-&gt;mkdir($dir)</a>
<a href="./api-glossary/ftp_rmdir.html">$ftp-&gt;rmdir($dir)</a>
<a href="./api-glossary/ftp_get.html">$ftp-&gt;get($local, $remote, $mode = FTP_BINARY)</a>
<a href="./api-glossary/ftp_put.html">$ftp-&gt;put($remote, $local, $mode = FTP_BINARY)</a>
<a href="./api-glossary/ftp_rename.html">$ftp-&gt;rename($old, $new)</a>
<a href="./api-glossary/ftp_chmod.html">$ftp-&gt;chmod($file, $mode)</a>
<a href="./api-glossary/ftp_delete.html">$ftp-&gt;delete($file)</a>
<a href="./api-glossary/ftp_pasv.html">$ftp-&gt;pasv($flag = true)</a>
<a href="./api-glossary/ftp_unset.html">unset($ftp)</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="image"></a>
    <h4>The Image Component</h4>
    <p>
        <strong>Note:</strong> The Image Component inherits all of the functionality of the the File Component and extends it with the following features:
    </p>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/image_construct.html">$image = new Moc10_Image($img, $up = false, $typ = null, $w = null, $h = null, $r = null, $g = null, $b = null)</a>
<a href="./api-glossary/image_upload_construct.html">$image = new Moc10_Image_Upload($upload, $file, $size = null, $types = null)</a>
<a href="./api-glossary/image_resize.html">$image-&gt;resize($px, $q = null, $to = null)</a>
<a href="./api-glossary/image_scale.html">$image-&gt;scale($scl, $q = null, $to = null)</a>
<a href="./api-glossary/image_crop.html">$image-&gt;crop($px, $x = 0, $y = 0, $q = null, $to = null)</a>
<a href="./api-glossary/image_text.html">$image-&gt;text($str, $size, $x, $y, $rotate = null, $font = null, $r = null, $g = null, $b = null, $to = null)</a>
<a href="./api-glossary/image_convert.html">$image-&gt;convert($type, $q = null)</a>
<a href="./api-glossary/image_colortotal.html">$image-&gt;colorTotal()</a>
<a href="./api-glossary/image_getcolors.html">$image-&gt;getColors($format = 'HEX')</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>

<a href="./api-glossary/image_width.html">$image-&gt;width</a>
<a href="./api-glossary/image_height.html">$image-&gt;height</a>
<a href="./api-glossary/image_channels.html">$image-&gt;channels</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="lang"></a>
    <h4>The Language Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/lang_construct.html">$lang = new Moc10_Language($lng = null)</a>
<a href="./api-glossary/lang_getlanguage.html">$lang-&gt;getLanguage()</a>
<a href="./api-glossary/lang_loadfile.html">$lang-&gt;loadFile($langFile)</a>
<a href="./api-glossary/lang___.html">$lang-&gt;__($str, $params = null)</a>
<a href="./api-glossary/lang__e.html">$lang-&gt;_e($str, $params = null)</a>
<a href="./api-glossary/lang_getlanguages.html">$lang-&gt;getLanguages($dir = null)</a>
<a href="./api-glossary/lang_generate.html">$lang-&gt;generateLanguageFile($lang, $api, $dest = false, $src = 'en', $tmpl = null)</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="mail"></a>
    <h4>The Mail Component</h4>

    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/mail_construct.html">$mail = new Moc10_Mail($em, $nm = null, $subj = null)</a>
<a href="./api-glossary/mail_setsubject.html">$mail-&gt;setSubject($subj)</a>
<a href="./api-glossary/mail_getsubject.html">$mail-&gt;getSubject()</a>
<a href="./api-glossary/mail_setboundary.html">$mail-&gt;setBoundary($bnd = null)</a>
<a href="./api-glossary/mail_getboundary.html">$mail-&gt;getBoundary()</a>
<a href="./api-glossary/mail_setcharset.html">$mail-&gt;setCharset($chr)</a>
<a href="./api-glossary/mail_getcharset.html">$mail-&gt;getCharset()</a>
<a href="./api-glossary/mail_settext.html">$mail-&gt;setText($txt)</a>
<a href="./api-glossary/mail_sethtml.html">$mail-&gt;setHtml($html)</a>
<a href="./api-glossary/mail_attachfile.html">$mail-&gt;attachFile($file)</a>
<a href="./api-glossary/mail_setheaders.html">$mail-&gt;setHeaders($hdrs = null)</a>
<a href="./api-glossary/mail_init.html">$mail-&gt;init()</a>
<a href="./api-glossary/mail_send.html">$mail-&gt;send()</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="pdf"></a>
    <h4>The PDF Component</h4>
    <p>
        <strong>Note:</strong> The PDF Component inherits all of the functionality of the the File Component and extends it with the following features:
    </p>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/pdf_construct.html">$pdf = new Moc10_Pdf($pdf, $sz = null, $w = null, $h = null)</a>
<a href="./api-glossary/pdf_importpdf.html">$pdf-&gt;importPdf($pdf, $pg = null)</a>
<a href="./api-glossary/pdf_addpage.html">$pdf-&gt;addPage($sz = null, $w = null, $h = null)</a>
<a href="./api-glossary/pdf_copypage.html">$pdf-&gt;copyPage($pg)</a>
<a href="./api-glossary/pdf_deletepage.html">$pdf-&gt;deletePage($pg)</a>
<a href="./api-glossary/pdf_orderpages.html">$pdf-&gt;orderPages($pgs)</a>
<a href="./api-glossary/pdf_curpage.html">$pdf-&gt;curPage()</a>
<a href="./api-glossary/pdf_numpages.html">$pdf-&gt;numPages()</a>
<a href="./api-glossary/pdf_setpage.html">$pdf-&gt;setPage($pg)</a>
<a href="./api-glossary/pdf_setversion.html">$pdf-&gt;setVersion($ver)</a>
<a href="./api-glossary/pdf_settitle.html">$pdf-&gt;setTitle($tle)</a>
<a href="./api-glossary/pdf_setauthor.html">$pdf-&gt;setAuthor($auth)</a>
<a href="./api-glossary/pdf_setsubject.html">$pdf-&gt;setSubject($subj)</a>
<a href="./api-glossary/pdf_setcreatedate.html">$pdf-&gt;setCreateDate($dt)</a>
<a href="./api-glossary/pdf_setmoddate.html">$pdf-&gt;setModDate($dt)</a>
<a href="./api-glossary/pdf_setfillcolor.html">$pdf-&gt;setFillColor($r, $g, $b)</a>
<a href="./api-glossary/pdf_setstrokecolor.html">$pdf-&gt;setStrokeColor($r, $g, $b)</a>
<a href="./api-glossary/pdf_setstroke.html">$pdf-&gt;setStroke($w = null, $dash_len = null, $dash_gap = null)</a>
<a href="./api-glossary/pdf_settextparams.html">$pdf-&gt;setTextParams($c = 0, $w = 0, $h = 100, $v = 100, $rot = 0, $rend = 0)</a>
<a href="./api-glossary/pdf_addfont.html">$pdf-&gt;addFont($font)</a>
<a href="./api-glossary/pdf_addtext.html">$pdf-&gt;addText($x, $y, $str, $font, $size)</a>
<a href="./api-glossary/pdf_getstringsize.html">$pdf-&gt;getStringSize($str, $font, $sz)</a>
<a href="./api-glossary/pdf_addline.html">$pdf-&gt;addLine($x1, $y1, $x2, $y2)</a>
<a href="./api-glossary/pdf_addrect.html">$pdf-&gt;addRect($x, $y, $l, $w, $fill = true)</a>
<a href="./api-glossary/pdf_addsquare.html">$pdf-&gt;addSquare($x, $y, $w, $fill = true)</a>
<a href="./api-glossary/pdf_addellipse.html">$pdf-&gt;addEllipse($x1, $y1, $x2, $y2, $x3, $y3, $x4, $y4, $fill = true)</a>
<a href="./api-glossary/pdf_addcircle.html">$pdf-&gt;addCircle($x, $y, $r, $fill = true)</a>
<a href="./api-glossary/pdf_addurl.html">$pdf-&gt;addURL($x, $y, $l, $w, $url)</a>
<a href="./api-glossary/pdf_addlink.html">$pdf-&gt;addLink($x, $y, $l, $w, $X, $Y, $Z, $dest = null)</a>
<a href="./api-glossary/pdf_addimage.html">$pdf-&gt;addImage($x, $y, $image, $scl = null)</a>
<a href="./api-glossary/pdf_save.html">$pdf-&gt;save($filename = null)</a>
<a href="./api-glossary/pdf_output.html">$pdf-&gt;output($download = null)</a>
<a href="./api-glossary/pdf_finalize.html">$pdf-&gt;finalize()</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="record"></a>
    <h4>The Record Component</h4>
    <p>
        <strong>Note:</strong> The Record Component utilizes the DB Component. It also assumes it is extended by a child class that defines the table in the database (i.e. the Test_Table_Users example.) Furthermore, if a single record is retrieved, then the properties of the record object mirror the fields of the database table. If multiple records are retrieved, then the array property "rows" of the record object contains ArrayObjects whose keys/properties mirror the fields of the database table rows.
    </p>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/record_construct.html">$record = new Test_Table_Users($fields = null, $type = null, $dbase = null, $host = null, $user = null, $pass = null)</a>
<a href="./api-glossary/record_setall.html">$record-&gt;setAll($fields = null)</a>
<a href="./api-glossary/record_findbyid.html">$record-&gt;findById($id, $limit = 1)</a>
<a href="./api-glossary/record_findby.html">$record-&gt;findBy($field, $value = null, $limit = 1)</a>
<a href="./api-glossary/record_findall.html">$record-&gt;findAll($order = null, $field = null, $value = null, $limit = null)</a>
<a href="./api-glossary/record_distinct.html">$record-&gt;distinct($distinctFields, $order = null, $field = null, $value = null, $limit = null)</a>
<a href="./api-glossary/record_search.html">$record-&gt;search($likeFields, $conj = 'AND', $order = null, $limit = null)</a>
<a href="./api-glossary/record_join.html">$record-&gt;join($table, $tableid, $order = null, $field = null, $value = null, $limit = null)</a>
<a href="./api-glossary/record_execute.html">$record-&gt;execute($sql)</a>
<a href="./api-glossary/record_save.html">$record-&gt;save($action = 'INSERT')</a>
<a href="./api-glossary/record_delete.html">$record-&gt;delete($field = null, $value = null)</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>

<a href="./api-glossary/record_fields.html">$record-&gt;[_fields]</a> (i.e. $user-&gt;email)
<a href="./api-glossary/record_db.html">$record-&gt;db</a>
<a href="./api-glossary/record_rows.html">$record-&gt;rows</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="session"></a>
    <h4>The Session Component</h4>
    <p>
        <strong>Note:</strong> The properties of a Session Component object mirror the keys and values of the global $_SESSION variable.
    </p>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/session_getinstance.html">$sess = Moc10_Session::getInstance()</a>
<a href="./api-glossary/session_getid.html">$sess-&gt;getId()</a>
<a href="./api-glossary/session_regenid.html">$sess-&gt;regenId()</a>
<a href="./api-glossary/session_kill.html">$sess-&gt;kill()</a>
    </pre>
    <h5 class="underline">Properties</h5>
    <pre>

<a href="./api-glossary/session_data.html">$session-&gt;[data]</a> (i.e. $sess-&gt;username)
    </pre>
    <h5 class="underline">Methods (Moc10_Session_Browser)</h5>
    <pre>

<a href="./api-glossary/session_browser_construct.html">$brws = new Moc10_Session_Browser()</a>
    </pre>
    <h5 class="underline">Properties (Moc10_Session_Browser)</h5>
    <pre>

<a href="./api-glossary/session_browser_ip.html">$brws-&gt;ip</a>
<a href="./api-glossary/session_browser_subnet.html">$brws-&gt;subnet</a>
<a href="./api-glossary/session_browser_ua.html">$brws-&gt;ua</a>
<a href="./api-glossary/session_browser_platform.html">$brws-&gt;platform</a>
<a href="./api-glossary/session_browser_os.html">$brws-&gt;os</a>
<a href="./api-glossary/session_browser_browser.html">$brws-&gt;browser</a>
<a href="./api-glossary/session_browser_version.html">$brws-&gt;version</a>
    </pre>
    <h5 class="underline">Methods (Moc10_Session_Mobile)</h5>
    <pre>

<a href="./api-glossary/session_mobile_construct.html">$mob = new Moc10_Session_Mobile($mob = null, $full = null)</a>
<a href="./api-glossary/session_mobile_gotomobile.html">$mob-&gt;goToMobile()</a>
<a href="./api-glossary/session_mobile_gotostandard.html">$mob-&gt;goToStandard()</a>
<a href="./api-glossary/session_mobile_gotourl.html">$mob-&gt;goToURL($url)</a>
    </pre>
    <h5 class="underline">Properties (Moc10_Session_Mobile)</h5>
    <pre>

<a href="./api-glossary/session_mobile_ua.html">$mob-&gt;ua</a>
<a href="./api-glossary/session_mobile_standard.html">$mob-&gt;standard</a>
<a href="./api-glossary/session_mobile_mobile.html">$mob-&gt;mobile</a>
<a href="./api-glossary/session_mobile_ismobile.html">$mob-&gt;isMobile</a>
<a href="./api-glossary/session_mobile_bypass.html">$mob-&gt;bypass</a>
    </pre>
    <h5 class="underline">Methods (Moc10_Session_Paginator)</h5>
    <pre>

<a href="./api-glossary/session_paginator_construct.html">$pages = new Moc10_Session_Paginator($content, $perpage = 10, $range = null, $total = null, $key = 'Arrows')</a>
<a href="./api-glossary/session_paginator_setcontent.html">$pages-&gt;setContent($content)</a>
<a href="./api-glossary/session_paginator_getcontent.html">$pages-&gt;getContent()</a>
<a href="./api-glossary/session_paginator_setheader.html">$pages-&gt;setHeader($hdr)</a>
<a href="./api-glossary/session_paginator_setrowtemplate.html">$pages-&gt;setRowTemplate($tmpl)</a>
<a href="./api-glossary/session_paginator_setfooter.html">$pages-&gt;setFooter($ftr)</a>
<a href="./api-glossary/session_paginator_render.html">$pages-&gt;render($pg, $sep = ' | ', $clsLnk = null, $clsOff = null, $dt = null, $ret = false)</a>
    </pre>
    <div class="divide"></div>
    <span class="right"><a href="./api-glossary.html#top">back to top ^</a></span>
    <a name="string"></a>
    <h4>The String Component</h4>
    <br />
    <h5 class="underline">Methods</h5>
    <pre>

<a href="./api-glossary/string_construct.html">$str = new Moc10_String($str = null)</a>
<a href="./api-glossary/string_tostring.html">print($str)</a>
<a href="./api-glossary/string_setstring.html">$str = Moc10_String::setString($str)</a>
<a href="./api-glossary/string_length.html">$str-&gt;length()</a>
<a href="./api-glossary/string_pos.html">$str-&gt;pos($char, $offset = 0)</a>
<a href="./api-glossary/string_ipos.html">$str-&gt;ipos($char, $offset = 0)</a>
<a href="./api-glossary/string_split.html">$str-&gt;split($delimiter)</a>
<a href="./api-glossary/string_glue.html">$str-&gt;glue($ary, $delimiter)</a>
<a href="./api-glossary/string_lower.html">$str-&gt;lower()</a>
<a href="./api-glossary/string_upper.html">$str-&gt;upper()</a>
<a href="./api-glossary/string_upperall.html">$str-&gt;upperall()</a>
<a href="./api-glossary/string_upperfirst.html">$str-&gt;upperfirst()</a>
<a href="./api-glossary/string_sub.html">$str-&gt;sub($start, $len = null)</a>
<a href="./api-glossary/string_between.html">$str-&gt;between($start, $end)</a>
<a href="./api-glossary/string_replace.html">$str-&gt;replace($search, $replace)</a>
<a href="./api-glossary/string_ireplace.html">$str-&gt;ireplace($search, $replace)</a>
<a href="./api-glossary/string_preg.html">$str-&gt;preg($pattern, $replace)</a>
<a href="./api-glossary/string_trim.html">$str-&gt;trim($chars = null)</a>
<a href="./api-glossary/string_add.html">$str-&gt;add()</a>
<a href="./api-glossary/string_strip.html">$str-&gt;strip()</a>
<a href="./api-glossary/string_striptags.html">$str-&gt;striptags($allowed = null)</a>
<a href="./api-glossary/string_escape.html">$str-&gt;escape($all = false)</a>
<a href="./api-glossary/string_br.html">$str-&gt;br()</a>
<a href="./api-glossary/string_wrap.html">$str-&gt;wrap($len, $delimiter = "\n", $cut = false)</a>
<a href="./api-glossary/string_html.html">$str-&gt;html()</a>
<a href="./api-glossary/string_dehtml.html">$str-&gt;dehtml()</a>
<a href="./api-glossary/string_slug.html">$str-&gt;slug($sep = null)</a>
<a href="./api-glossary/string_links.html">$str-&gt;links($tar = false)</a>
<a href="./api-glossary/string_date.html">$str-&gt;date($format = 'm/d/Y')</a>
<a href="./api-glossary/string_random.html">$str-&gt;random($len, $caps = false)</a>
    </pre>
</div>
<!-- Footer //-->
<div id="footer">
    Copyright &copy; 2009-2011, Moc 10 Media, LLC. All rights reserved.
</div>
</body>

</html>
Return current item: Moc10 PHP Library