phpDocumentor pivotx
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Procedural File: module_snippets.php

Source Location: /modules/module_snippets.php

Page Details

Contains all of the old snippets. Most will be moved/ported to module_smarty.php

but some will remain here as fallback for people using old 1.x templates

Functions
snippet_close_on_esc  [line 362]

void snippet_close_on_esc( )


[ Top ]
snippet_comments  [line 297]

string snippet_comments( [string $order = 'ascending']  )

Wrapper for smarty_comments.

Parameters:
string   $order: 


[ Top ]
snippet_download  [line 101]

void snippet_download( string $filename, string $icon, string $text, string $title  )

Inserts a link to a downloadable file... Just a wrapper for backwards compatibility.

Parameters:
string   $filename: 
string   $icon:  Insert a suitable icon if set to "icon"
string   $text:  The text of the download link.
string   $title:  The text of the title attribue of the link.


[ Top ]
snippet_editlink  [line 379]

void snippet_editlink( [ $name = '']  )
Parameters:
   $name: 


[ Top ]
snippet_encrypt_mail  [line 245]

string snippet_encrypt_mail( string $email, string $display, [string $title = '']  )

Encrypts the given email address using JavaScript. Wrapper for smarty_link.

If "Encode Email Address" is not selected for the current weblog, the output will be a plain mailto-link.

Parameters:
string   $email: 
string   $display:  Text of the mailto-link.
string   $title:  Title of the mailto-link.

API Tags:
Uses:  smarty_link()


[ Top ]
snippet_entry_data  [line 169]

void snippet_entry_data( [ $word = ''], [ $image = ''], [ $download = '']  )
Parameters:
   $word: 
   $image: 
   $download: 


[ Top ]
snippet_image  [line 28]

void snippet_image( $filename, [ $alt = ''], [ $meta = ''], [ $compl = 0]  )

Inserts an image. Just a wrapper for backwards compatibility.

Parameters:
   $filename: 
   $alt: 
   $meta: 
   $compl: 


[ Top ]
snippet_jscookies  [line 219]

void snippet_jscookies( )


[ Top ]
snippet_keywords  [line 267]

string snippet_keywords( [string $text = ''], [string $sep = '']  )

Displays the keywords for the entry.

Parameters:
string   $text:  The output format. The default values is "%keywords%".
string   $sep:  The separator between the keywords. The default value is comma. The value "clear" will output the keywords exactly as it was inserted with the entry.

API Tags:
Return:  The text to display.


[ Top ]
snippet_lang  [line 372]

void snippet_lang( [ $type = '']  )

wrapper for smarty_lang

Parameters:
   $type: 

API Tags:
Uses:  smarty_lang()


[ Top ]
snippet_last_comments  [line 356]

void snippet_last_comments( )


[ Top ]
snippet_link  [line 124]

string snippet_link( string $filename, string $name  )

Creates a link to a file. This snippet has changed meaning in PivotX.

The snippet will check the parent driectory of Pivot and the upload directory for a file with the given name.

Parameters:
string   $filename: 
string   $name:  (Link text)


[ Top ]
snippet_nextentry  [line 308]

void snippet_nextentry( [ $text = ''], [ $cutoff = 20]  )

Placeholder for backwards compatibility

Parameters:
   $text: 
   $cutoff: 


[ Top ]
snippet_nextentryincategory  [line 328]

void snippet_nextentryincategory( [ $text = ''], [ $cutoff = '']  )

Placeholder for backwards compatibility

Parameters:
   $text: 
   $cutoff: 


[ Top ]
snippet_popup  [line 66]

void snippet_popup( $filename, [ $thumbname = ''], [ $alt = ''], [ $align = 'center'], [ $border = '']  )

Insert a popup to an image.. Just a wrapper for backwards compatibility.

Parameters:
   $filename: 
   $thumbname: 
   $alt: 
   $align: 
   $border: 


[ Top ]
snippet_previousentry  [line 318]

void snippet_previousentry( [ $text = ''], [ $cutoff = 20]  )

Placeholder for backwards compatibility

Parameters:
   $text: 
   $cutoff: 


[ Top ]
snippet_previousentryincategory  [line 338]

void snippet_previousentryincategory( [ $text = ''], [ $cutoff = '']  )

Placeholder for backwards compatibility

Parameters:
   $text: 
   $cutoff: 


[ Top ]
snippet_subweblog  [line 153]

void snippet_subweblog( [ $sub = ''], [ $count = ''], [ $order = 'lasttofirst']  )
Parameters:
   $sub: 
   $count: 
   $order: 


[ Top ]
snippet_tags  [line 391]

void snippet_tags( [ $text = ''], [ $sep = '']  )

Wrapper for smarty_introduction

Parameters:
   $text: 
   $sep: 

API Tags:
Uses:  smarty_tags()


[ Top ]
snippet_trackback_autodiscovery  [line 349]

void snippet_trackback_autodiscovery( )

deprecate this!! We need to add these via a hook!



[ Top ]
snippet_tt  [line 455]

string snippet_tt( string $tagName, [string $externalLink = ''], [string $template = '']  )

Display a Tag, as used in the introduction or body. Just a wrapper for backwards compatibility.

Parameters:
string   $tagName: 
string   $externalLink: 
string   $template: 


[ Top ]
snippet_ttaglist  [line 405]

string snippet_ttaglist( [string $template = '']  )

Get detailed info for tags used in an entry

Parameters:
string   $template: 


[ Top ]
snippet_weblog  [line 159]

void snippet_weblog( [ $sub = ''], [ $count = '']  )
Parameters:
   $sub: 
   $count: 


[ Top ]
snippet_weblogtitle  [line 146]

string snippet_weblogtitle( [string $strip = '']  )

Returns the title (name) of the current weblog. Just a wrapper for backwards compatibility.

Parameters:
string   $strip:  if equal to 'strip' all HTML tags will be removed.


[ Top ]


Documentation generated on Tue, 05 Sep 2017 01:06:11 +0200 by phpDocumentor 1.4.3