Admidio API
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Packages

  • com
    • tecnick
      • tcpdf
  • None
  • PHPMailer
    • easypeasyics
  • PHPWavUtils
  • Securimage
    • classes

Classes

  • AutoLogin
  • Component
  • ComponentUpdate
  • ConditionParser
  • Database
  • DateTimeExtended
  • Email
  • Folder
  • FormValidation
  • FunctionClass
  • Htaccess
  • HtmlDiv
  • HtmlElement
  • HtmlForm
  • HtmlFormBasic
  • HtmlFormInstallation
  • HtmlList
  • HtmlNavbar
  • HtmlPage
  • HtmlTable
  • HtmlTableBasic
  • Image
  • Inventory
  • InventoryFields
  • Language
  • LanguageData
  • ListConfiguration
  • Menu
  • Message
  • ModuleAnnouncements
  • ModuleDates
  • ModuleLists
  • ModuleMenu
  • ModuleMessages
  • Modules
  • ModuleWeblinks
  • MyFiles
  • Navigation
  • ntlm_sasl_client_class
  • Organization
  • Participants
  • PasswordHash
  • PasswordHashing
  • ProfileFields
  • RoleDependency
  • RolesRights
  • RSSfeed
  • Session
  • SystemMail
  • TableAccess
  • TableAnnouncement
  • TableCategory
  • TableDate
  • TableFile
  • TableFolder
  • TableGuestbook
  • TableGuestbookComment
  • TableInventory
  • TableInventoryField
  • TableLists
  • TableMembers
  • TableMessage
  • TablePhotos
  • TableRoles
  • TableRooms
  • TableText
  • TableUserField
  • TableUsers
  • TableWeblink
  • UploadHandlerDownload
  • UploadHandlerPhoto
  • User
  • UserRegistration

Exceptions

  • AdmException
  • WavFileException
  • WavFormatException

Functions

  • admFuncAutoload
  • admFuncGeneratePagination
  • admFuncGetBytesFromSize
  • admFuncGetDirectoryEntries
  • admFuncMaxUploadSize
  • admFuncProcessableImageSize
  • admFuncShowCreateChangeInfoById
  • admFuncShowCreateChangeInfoByName
  • admFuncVariableIsValid
  • admReadTemplateFile
  • admStrIsValidFileName
  • admStrStripTagsSpecial
  • admStrToLower
  • admStrToUpper
  • bzip2Version
  • checkDatabaseVersion
  • checkPhpVersion
  • EmailAttachment
  • FileSizeNiceDisplay
  • FormattedTimeRemaining
  • FunctionIsDisabled
  • getFormerRolesFromDatabase
  • getFutureRolesFromDatabase
  • getmicrotime
  • getRoleMemberships
  • getRolesFromDatabase
  • gzipVersion
  • hasRole
  • hl_attrval
  • hl_bal
  • hl_cmtcd
  • hl_ent
  • hl_prot
  • hl_regex
  • hl_spec
  • hl_tag
  • hl_tag2
  • hl_tidy
  • hl_version
  • htmLawed
  • HTMLFilter
  • isGroupLeader
  • isMember
  • kses
  • kses_hook
  • MySQLdumpVersion
  • OutputInformation
  • SafeExec
  • showNotice
  • strAddSlashesDeep
  • strNextLetter
  • strStripSlashesDeep
  • strStripTags
  • strValidCharacters
  • tln_body2div
  • tln_casenormalize
  • tln_deent
  • tln_defang
  • tln_findnxreg
  • tln_findnxstr
  • tln_fixatts
  • tln_fixstyle
  • tln_fixurl
  • tln_getnxtag
  • tln_sanitize
  • tln_skipspace
  • tln_tagprint
  • tln_unspace
  • version_compare_replacement
  • version_compare_replacement_sub

Class Image

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

Image Folgende Methoden stehen zur Verfuegung:

setImageFromPath($pathAndFilename) - setzt den Pfad zum Bild und liest Bildinformationen ein setImageFromData($imageData) - liest das Bild aus einem String ein und wird intern als PNG-Bild weiter verarbeitet und ausgegeben copyToFile($imageResource = null, $pathAndFilename = "", $quality = 95) - kopiert die uebergebene Bildresource in die uebergebene Datei bzw. der hinterlegten Datei des Objekts copyToBrowser($imageResource = null, $quality = 95) - gibt das Bild direkt aus, so dass es im Browser dargestellt werden kann getMimeType() - gibt den Mime-Type (image/png) des Bildes zurueck rotate($direction = "right") - dreht das Bild um 90° in eine Richtung ("left"/"right") scaleLargerSide($newMaxSize) - skaliert die laengere Seite des Bildes auf den uebergebenen Pixelwert scale($newXSize, $newYSize, $aspect_ratio = true) - das Bild wird in einer vorgegebenen maximalen Laenge/Hoehe skaliert delete() - entfernt das Bild aus dem Speicher


Located at image.php

Methods summary

public
# __construct( string $pathAndFilename = '' )

Parameters

$pathAndFilename
public boolean
# setImageFromPath( string $pathAndFilename )

Methode setzt den Pfad zum Bild und liest Bildinformationen ein

Methode setzt den Pfad zum Bild und liest Bildinformationen ein

Parameters

$pathAndFilename

Returns

boolean
public boolean
# setImageFromData( string $imageData )

Methode liest das Bild aus einem String ein und wird intern als PNG-Bild weiter verarbeitet und ausgegeben

Methode liest das Bild aus einem String ein und wird intern als PNG-Bild weiter verarbeitet und ausgegeben

Parameters

$imageData
String with binary image data

Returns

boolean
private boolean
# createResource( string $pathAndFilename )

Parameters

$pathAndFilename

Returns

boolean
public boolean
# copyToFile( resource|null $imageResource = null, string $pathAndFilename = '', integer $quality = 95 )

Methode kopiert die uebergebene Bildresource in die uebergebene Datei bzw. der hinterlegten Datei des Objekts

Methode kopiert die uebergebene Bildresource in die uebergebene Datei bzw. der hinterlegten Datei des Objekts

Parameters

$imageResource
eine andere Bild-Resource kann uebergeben werden
$pathAndFilename
ein andere Datei kann zur Ausgabe angegeben werden
$quality
die Qualitaet kann fuer jpeg-Dateien veraendert werden

Returns

boolean
true, falls erfolgreich
public boolean
# copyToBrowser( resource|null $imageResource = null, integer $quality = 95 )

Methode gibt das Bild direkt aus, so dass es im Browser dargestellt werden kann

Methode gibt das Bild direkt aus, so dass es im Browser dargestellt werden kann

Parameters

$imageResource
eine andere Bild-Resource kann uebergeben werden
$quality
die Qualitaet kann fuer jpeg-Dateien veraendert werden

Returns

boolean
public string
# getMimeType( )

gibt den Mime-Type (image/png) des Bildes zurueck

gibt den Mime-Type (image/png) des Bildes zurueck

Returns

string
public
# setImageType( string $imageType )

setzt den Image-Type des Bildes neu

setzt den Image-Type des Bildes neu

Parameters

$imageType
public
# rotate( string $direction = 'right' )

Methode dreht das Bild um 90° in eine Richtung

Methode dreht das Bild um 90° in eine Richtung

Parameters

$direction
'right' o. 'left' Richtung, in die gedreht wird
public boolean
# scaleLargerSide( integer $newMaxSize )

Methode skaliert die laengere Seite des Bildes auf den uebergebenen Pixelwert die andere Seite wird dann entsprechend dem Seitenverhaeltnis zurueckgerechnet

Methode skaliert die laengere Seite des Bildes auf den uebergebenen Pixelwert die andere Seite wird dann entsprechend dem Seitenverhaeltnis zurueckgerechnet

Parameters

$newMaxSize

Returns

boolean
public boolean
# scale( integer $newXSize, integer $newYSize, boolean $maintainAspectRatio = true )

Scale an image to the new size of the parameters. Therefore the PHP instance may need some memory which should be set through the PHP setting memory_limit.

Scale an image to the new size of the parameters. Therefore the PHP instance may need some memory which should be set through the PHP setting memory_limit.

Parameters

$newXSize
The new horizontal width in pixel. The image will be scaled to this size.
$newYSize
The new vertical height in pixel. The image will be scaled to this size.
$maintainAspectRatio

If this is set to true, the image will be within the given size but maybe one side will be smaller than set with the parameters.

Returns

boolean
public
# delete( )

Delete image from class and server memory

Delete image from class and server memory

Properties summary

private $imagePath
#
private $imageType
#
public $imageResource
#
public integer $imageWidth
# 0
public integer $imageHeight
# 0
Admidio API API documentation generated by ApiGen