BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException

Class BeHashComponent

General BEdita hash component

Object
Extended by BeHashComponent
Version
Modifiedby
Lastmodified: $Id: be_newsletter.php
Located at controllers/components/be_hash.php

Methods summary

public
# startup( Controller & $controller = null )

startup component

startup component

Parameters

$controller
public boolean
# handleHash( string $service_type, string $hash = null )

handle hash request like newsletter/frontend subscribe/unsubscribe

handle hash request like newsletter/frontend subscribe/unsubscribe

Parameters

$service_type
$hash

Returns

boolean

Throws

BeditaException
BeditaHashException
public array
# getHashRow( string $hash )

get hash_jobs row

get hash_jobs row

Parameters

$hash

Returns

array
HashJob row
protected array
# userSignUp( array $data )

user sign up registration

user sign up registration

Parameters

$data

Returns

array

Throws

BeditaHashException
BeditaException
protected array
# userSignUpActivation( array $data )

Signup activation for user

Signup activation for user

Parameters

$data

Returns

array

Throws

BeditaHashException
BeditaException
protected array
# newsletterSubscribe( array $data )

subscribe to a newsletter

subscribe to a newsletter

Parameters

$data

Returns

array

Throws

BeditaHashException
BeditaException
protected array
# newsletterSubscribeConfirm( array $data )

confirm subscription to a newsletter

confirm subscription to a newsletter

Parameters

$data

Returns

array

Throws

BeditaHashException
BeditaException
protected array
# newsletterUnsubscribe( array $data )

unsubscribe from a newsletter

unsubscribe from a newsletter

Parameters

$data

Returns

array

Throws

BeditaHashException
BeditaException
protected array
# newsletterUnsubscribeConfirm( array $data )

Confirm newsletter unsubscribe

Confirm newsletter unsubscribe

Parameters

$data

Returns

array

Throws

BeditaHashException
BeditaException
protected array
# recoverPassword( array $data )

recover password. Send an email with hash to reset password

recover password. Send an email with hash to reset password

Parameters

$data

Returns

array
mail params

Throws

BeditaHashException
BeditaException
protected array
# recoverPasswordChange( array $data )

Recover password

Recover password

Parameters

$data

Returns

array

Throws

BeditaHashException
protected
# sendNotificationMail( array $mailParams )

Send notification email

Send notification email

Parameters

$mailParams
protected
# loadMessages( )

Load messages: 1. default messages 2. local unversioned instance messages 3. frontend messages (if frontend app)

Load messages: 1. default messages 2. local unversioned instance messages 3. frontend messages (if frontend app)

protected string
# getNotifyText( string $msgType, string $field )

get message (in current lang, if present translation)

get message (in current lang, if present translation)

Parameters

$msgType
$field

Returns

string
protected string
# replacePlaceHolder( unknown_type $text, array & $params )

replace place holder

replace place holder

Parameters

$text
$params

Returns

string

Properties summary

protected BeHashComponent::$controller $controller

instance

instance

#
protected array $notifyMsg

store notification messages

store notification messages

# null
public array $components

other components

other components

# array("BeMail")
public boolean $closeHashJob

if an hash job has to be closed after at the end of handleHash method

if an hash job has to be closed after at the end of handleHash method

# true
BEdita API doc | 4-cactus API documentation generated by ApiGen