<<

NAME

pf::Portal::Profile

DESCRIPTION

pf::Portal::Profile wraps captive portal configuration in a way that we can provide several differently configured (behavior and template) captive portal from the same server.

METHODS

new

No one should call ->new by himself. pf::Portal::ProfileFactory should be used instead.

getName

Returns the name of the captive portal profile.

getLogo

Returns the logo for the current captive portal profile.

getGuestModes

Returns the available enabled modes for guest self-registration for the current captive portal profile.

getChainedGuestModes

Returns the available enabled modes for guest self-registration for chained sources for the current captive portal profile.

getTemplatePath

Returns the path for custom templates for the current captive portal profile.

Relative to html/captive-portal/templates/

getBillingEngine

Returns either enabled or disabled according to the billing engine state for the current captive portal profile.

getDescripton

Returns either enabled or disabled according to the billing engine state for the current captive portal profile.

getLocales

Returns the locales for the profile.

getSources

Returns the authentication sources IDs for the current captive portal profile.

getMandatoryFields

Returns the mandatory fields for the profile

getSourcesAsObjects

Returns the authentication sources objects for the current captive portal profile.

getInternalSources

Returns the internal authentication sources objects for the current captive portal profile.

getExternalSources

Returns the external authentication sources objects for the current captive portal profile.

getExclusiveSources

Returns the exclusive authentication sources objects for the current captive portal profile.

getSourcesByClass

Returns the sources for that match the class

hasChained

If the profile has a chained auth source

getSourceByType

Returns the first source object for the requested source type for the current captive portal profile.

getSourceByTypeForChained

Returns the first source object for the requested source type for chained sources in the current captive portal profile.

guestRegistrationOnly

Returns true if the profile only uses "sign-in" authentication sources (SMS, email or sponsor).

guestModeAllowed

Verify if the guest mode is allowed for the profile

nbregpages

The number of registration pages to be shown before signup or registration

reuseDot1xCredentials

Reuse dot1x credentials when authenticating

noPasswordNeeded

Check if the profile needs no password

noUsernameNeeded

Check if the profile needs no username

provisionerObjects

The provisionerObjects

dot1xRecomputeRoleFromPortal

Reuse dot1x credentials when authenticating

AUTHOR

Inverse inc. <info@inverse.ca>

COPYRIGHT

Copyright (C) 2005-2015 Inverse inc.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

<<