Overview

Packages

  • admin
  • classes
    • media
  • CodeIgniter
    • Libraries
  • core
  • functions
  • JSMin
  • None
  • OpenID
  • PHP
  • PHPMailer
  • plugins
    • admin
    • development
    • feed
    • mail
    • media
    • misc
    • seo
    • spam
    • uploader
    • users
    • zenpage
    • zenphoto
      • news
  • Services
    • JSON

Classes

  • _zp_captcha
  • _zp_HTML_cache
  • external_auth
  • lib_GD_Options
  • lib_Imagick_Options
  • lib_NoGraphics
  • utf8
  • zpFunctions

Functions

  • add_context
  • applyMacros
  • byteConvert
  • cacheImage
  • checkAlbumPassword
  • checkObjectsThumb
  • checkPublishDates
  • checkSignature
  • cleanHTML
  • commentsAllowed
  • cron_starter
  • dateTimeConvert
  • db_count
  • db_name
  • debug404
  • debugLogBacktrace
  • debugLogVar
  • dircopy
  • enableExtension
  • extensionEnabled
  • fetchComments
  • filesystemToInternal
  • fix_path_redirect
  • galleryAlbumsPerPage
  • generateLanguageList
  • generateListFromArray
  • generateListFromFiles
  • get_context
  • get_language_string
  • getAllSubAlbumIDs
  • getAllTagsCount
  • getAllTagsUnique
  • getAllTranslations
  • getBare
  • getEnabledPlugins
  • getImageRotation
  • getItemByID
  • getLanguageArray
  • getLanguageFlag
  • getLinkHTML
  • getMacros
  • getManagedAlbumList
  • getNestedAlbumList
  • getNotViewableAlbums
  • getNotViewableImages
  • getOptionFromDB
  • getPlugin
  • getPluginFiles
  • getSerializedArray
  • getSetClause
  • getTagCountByAccess
  • gettext_pl
  • gettext_th
  • getThemeOption
  • getTimezones
  • getUrAlbum
  • getUserIP
  • getUserLocale
  • getWhereClause
  • getXSRFToken
  • handleSearchParms
  • html_decode
  • html_encode
  • html_encodeTagged
  • i18nSetLocale
  • imageDebug
  • imageError
  • in_context
  • internalToFilesystem
  • iptc_make_tag
  • is_connected
  • is_valid_email_zp
  • isImagePhoto
  • isImageVideo
  • isValidURL
  • ksesProcess
  • load_zenpage_news
  • load_zenpage_pages
  • lookupSortKey
  • mb_strlen
  • mb_strpos
  • mb_strrpos
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count
  • mkdir_recursive
  • myts_date
  • ngettext_pl
  • ngettext_th
  • parseAllowedTags
  • parseHttpAcceptLanguage
  • populateManagedObjectsList
  • prefix
  • prepareAlbumPage
  • prepareCustomPage
  • prepareImagePage
  • prepareIndexPage
  • printLinkHTML
  • propSizes
  • rc4
  • read_exif_data_protected
  • readTags
  • reconfigureAction
  • reconfigureCS
  • reconfigurePage
  • rem_context
  • restore_context
  • reveal
  • safe_fnmatch
  • sanitize
  • sanitize_numeric
  • sanitize_path
  • sanitize_script
  • sanitize_string
  • sanitizeRedirect
  • save_context
  • seoFriendly
  • seoFriendlyJS
  • set_context
  • setMainDomain
  • setThemeOption
  • setThemeOptionDefault
  • setupCurrentLocale
  • setupDomain
  • setupTheme
  • shortenContent
  • shuffle_assoc
  • signatureChange
  • sortByKey
  • sortByMultilingual
  • sortMultiArray
  • storeTags
  • timezoneDiff
  • truncate_string
  • validateLocale
  • XSRFToken
  • zp_clearCookie
  • zp_cookieEncode
  • zp_error
  • zp_getCookie
  • zp_handle_password
  • zp_handle_password_single
  • zp_image_types
  • zp_load_album
  • zp_load_gallery
  • zp_load_image
  • zp_load_page
  • zp_load_request
  • zp_load_search
  • zp_loggedin
  • zp_mail
  • zp_setCookie
  • zpErrorHandler
  • zpFormattedDate
  • zpRewriteURL
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class external_auth

Root class for external authorizaton plugins

Package: core
Author: Stephen Billard (sbillard)
Located at external_auth.php
Methods summary
protected
# user( )

returns an array with the user details from the external authorization

returns an array with the user details from the external authorization

public
# check( BIT $authorized )

This is the cookie processor filter handler it invokes the child class check() method to see if there is a valid visitor to the site The check() method should return "false" if there is no valid visitor or an array of User information if there is one.

This is the cookie processor filter handler it invokes the child class check() method to see if there is a valid visitor to the site The check() method should return "false" if there is no valid visitor or an array of User information if there is one.

If there is a valid user, the user name is checked against Zenphoto users. If such user exists he will be automatically logged in. If no user by that userid exists a transient user will be created and logged in. User details are filled in from the user information in the passed array.

Most enteries in the result array are simply stored into the user property of the same name. However, there are some special handling items that may be present:

  • groups: an array of the user's group membership
  • objects: a Zenphoto "managed object list" array
  • album: the name of the user's primary album
  • logout_link: information that the plugin can use when a user loggs out

All the above may be missing. However, if there is no groups entry, there needs to be an entry for the user's rights otherwise he will have none. There should not be both a rights entry and a groups entry as they are mutually exclusive.

album and objects entries should come last in the list so all other properties are processed first as these methods may modify other properties.

Parameters

$authorized
Properties summary
public string $auth
# 'external'
Zenphoto doc API documentation generated by ApiGen