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

Class: ipbwi_attachment

Source Location: /ipbwi/lib/attachment.inc.php

Class Overview

ipbwi
   |
   --ipbwi_attachment



Author(s):

  • Matthias Reuter ($LastChangedBy: matthias $)

Version:

  • $LastChangedDate: 2009-08-26 19:19:41 +0200 (Mi, 26 Aug 2009) $

Copyright:

  • 2007-2010 IPBWI development team

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: ipbwi

ipbwi::addSystemMessage()
adds a system message
ipbwi::date()
Returns textual/timestamp offsetted date by board and by member offset and DST setting.
ipbwi::getBoardVar()
gets the requested board-var
ipbwi::getLibLang()
gets the language-var from actual requested native language-bit
ipbwi::makeSafe()
filtering html-strings, e.g. for db-queries
ipbwi::printSystemMessages()
prints system messages
ipbwi::properXHTML()
filtering HTML strings
ipbwi::setLang()
Set's current SDK language
ipbwi::sysInfo()
informations about the current IPBWI and PHP installation
ipbwi::__destruct()

Class Details

[line 11]


Tags:

author:  Matthias Reuter ($LastChangedBy: matthias $)
version:  $LastChangedDate: 2009-08-26 19:19:41 +0200 (Mi, 26 Aug 2009) $
copyright:  2007-2010 IPBWI development team
link:  http://ipbwi.com/examples/attachment.php
since:  2.0
license:  GNU General Public License


[ Top ]


Class Variables

$hash =  false

[line 17]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


method getList [line 259]

array getList( mixed $IDs, [array $settings = array()], [bool $bypassPerms = false])

get's all available informations about attachments either from a list of forums, topics, posts or private messages



Tags:

return:  attachment-informations in an array
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->attachment->getList(12,array('type' => 'forum','start' => 10'limit' => 20));
  2.  $ipbwi->attachment->getList(array(20,104,55)array('type' => 'topic'),true);
access:  public


Parameters:

mixed   $IDs   IDs of the requested forums, topics, posts or PMs. Deliver them as array or single integer.
array   $settings   array with different settings for this function The following settings are supported:
  • string $settings[start]: For performance purposes, you are able to set a start parameter to set a section of the attachment list. This is used for forum-attachment-list only.
  • string $settings[limit]: For performance purposes, you are able to set a limit parameter to set a section of the attachment list. This is used for forum-attachment-list only.
  • string $settings[ipbwiLink]: If you want to use IPBWI for attachment-downloading, you are able to define the attachment-link here. The var %id% is required and will be replaced with the attachment-ID.
  • string $settings[type]: Define which type your IDs are, choose between post or msg
bool   $bypassPerms   set to true, to ignore permissions

[ Top ]

method info [line 130]

array info( mixed $IDs, [array $settings = array()], [bool $bypassPerms = false])

get's all available informations about attachments



Tags:

return:  attachment-informations in an array
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->attachment->info(12,array('type' => 'post','ipbwiLink' => ipbwi_WEB_URL.'examples/attachment.php?id=%id%'));
  2.  $ipbwi->attachment->info(12,array('type' => 'post','ipbwiLink' => ipbwi_WEB_URL.'examples/attachment.php?id=%id%&hash=%hash%'));
  3.  $ipbwi->attachment->info(array(20,104,55)array('type' => 'msg'),true);
access:  public


Parameters:

mixed   $IDs   relIDs (post or msg IDs) of the requested attachments. Deliver them as array or single integer.
array   $settings   array with different settings for this function The following settings are supported:
  • string $settings[ipbwiLink]: If you want to use IPBWI for attachment-downloading, you are able to define the attachment-link here. The var %id% is required and will be replaced with the attachment-ID. The var %hash% is optional and will be replaced with current hash key for deeplink protection.
  • string $settings[type]: Define which type your IDs are, choose between post or msg
bool   $bypassPerms   set to true, to ignore permissions

[ Top ]

method load [line 282]

file load( int $attachID, [bool $bypassPerms = false])

loads and views an attachment



Tags:

return:  returns attachment-file to the browser
author:  Matthias Reuter
since:  2.0
sample:  
  1.  $ipbwi->attachment->load(10,true);
access:  public


Parameters:

int   $attachID   ID of the attachment
bool   $bypassPerms   set to true, to ignore permissions

[ Top ]


Documentation generated on Sat, 23 Oct 2010 23:35:46 +0200 by phpDocumentor 1.4.3