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 Card

Addressbook card model

Model
Extended by AppModel
Extended by BEAppModel
Extended by BEAppObjectModel
Extended by Card
Located at models/objects/card.php

Methods summary

public
# beforeValidate( )
public
# beforeSave( )
public
# afterSave( $created )
private
# setupCsvDelimiter( $options )
public results
# importCSVFile( string $csvFile, array $options = null )

Import a Microsoft Outlook/Outlook Express CSV file

Import a Microsoft Outlook/Outlook Express CSV file

Parameters

$csvFile

$csvFile, path to csv file file

$options

$options, default attributes/array to use, e.g. categories, 'Category' => array (1,3,4..) - array of id-categories 'overwritePolicy' - card with same email exists, values = 'skip'(default), 'overwrite', 'new'

Returns

results
array, num of objects saved ('numSaved') and other data
public string,
# headerCSV( array $options = null )

Get Microsoft Outlook CSV header or custom CSV header

Get Microsoft Outlook CSV header or custom CSV header

Parameters

$options

$options, may contain - 'delimiter' => '' default is ',' - 'custom' => true (use custom format) default false

Returns

string,
single line as string
public string,
# exportCSV( array $options = null, array $data = array() )

Export model data to Microsoft Outlook CSV format or custom CSV format

Export model data to Microsoft Outlook CSV format or custom CSV format

Parameters

$options

$options, may contain - 'delimiter' => '' default is ',' - 'custom' => true (use custom format) default false

$data
$data, object data to export

Returns

string,
single line as string
public string,
# createCsvAsString( array $data, array $options = null )

Generate CSV file content as string from cards data array

Generate CSV file content as string from cards data array

Parameters

$data

$options, may contain - 'delimiter' => '' default is ',' - 'custom' => true (use custom format) default false

$options
$data, object data to export

Returns

string,
requested CSV content
public results
# importVCardFile( string $cardFile, array $options = null )

Import a vCard/vcf file

Import a vCard/vcf file

Parameters

$cardFile
$cardFile, path to vcard file
$options

$options, default attributes array to use, e.g. categories, "Category" => array (1,3,4..) - array of id-categories

Returns

results
array, num of objects saved ("numSaved") and other data
public
# exportVCard( array $data = null )

Export model data to VCard format

Export model data to VCard format

Parameters

$data
to export - if missing current data are loaded, using $this->id
private
# vcardLine( $vline, $field, array & $data )
private
# parseVCards( & $lines )

Methods inherited from BEAppObjectModel

apiTransformer(), arrangeDataForClone(), checkType(), cloneObject(), field(), getTypeId(), save(), saveField(), updateHasManyAssoc(), validateContent()

Methods inherited from BEAppModel

am(), buildQueryStatement(), checkDate(), checkDuration(), checkFloat(), checkNumber(), containLevel(), email(), fieldsString(), findObjects(), findObjectsAfterFilter(), findObjectsClauses(), findObjectsCount(), getBindingsLevel(), getDefaultDateFormat(), getDriver(), getEndQuote(), getLimitClausole(), getStartQuote(), setBindingsLevel(), setupDbParams(), toolbar()

Constants summary

string DEFAULT_CSV_DELIMITER
# ','

Properties summary

public array $searchFields
# array( "title" => 10, "nickname" => 8, "description" => 4, "website" => 6, "email" => 6, "email2" => 5, "street_address" => 3, "company_name" => 3, "city" => 4, "note" => 2 )
public array $actsAs
# array( 'CompactResult' => array("MailGroup", "GeoTag") )
protected array $modelBindings
# array( 'detailed' => array( 'BEObject' => array( 'ObjectType', 'UserCreated', 'UserModified', 'Permission', 'ObjectProperty', 'LangText', 'RelatedObject', 'Category', 'Annotation', 'User', 'Alias', 'Version' => array('User.realname', 'User.userid'), 'GeoTag' ), 'MailGroup' ), 'default' => array( 'BEObject' => array( 'ObjectProperty', 'LangText', 'ObjectType', 'Category', 'RelatedObject', 'Annotation' ) ), 'minimum' => array('BEObject' => array('ObjectType')), 'frontend' => array( 'BEObject' => array( 'LangText', 'RelatedObject', 'GeoTag', 'ObjectProperty', 'Category' ) ), 'api' => array( 'BEObject' => array( 'LangText', 'GeoTag', 'ObjectProperty', 'Category' ) ) )
public array $objectTypesGroups
# array("leafs", "related")
public array $hasAndBelongsToMany
# array( "MailGroup" => array( "joinTable" => "mail_group_cards", "with" => "MailGroupCard" ) )
public array $validate
# array( 'email' => array( 'rule' => 'email', 'allowEmpty' => true, 'message' => 'Please supply a valid email address.' ), 'email2' => array( 'rule' => 'email', 'allowEmpty' => true, 'message' => 'Please supply a valid email address.' ), 'newsletter_email' => array( 'rule' => 'email', 'allowEmpty' => true, 'message' => 'Please supply a valid email address.' ) )
private array $csvFields
# array ( "Title" => "person_title", "First Name" => "name", "Middle Name", "Last Name" => "surname", "Suffix", "E-mail Address" => "email", "E-mail 2 Address" => "email2", "E-mail 3 Address", "Business Street","Business Street 2","Business Street 3","Business City", "Business State" => "state_name", "Business Postal Code" => "zipcode", "Business Country" => "country", "Home Street" => "street_address", "Home Street 2","Home Street 3","Home City","Home State","Home Postal Code","Home Country", "Other Street","Other Street 2","Other Street 3","Other City","Other State", "Other Postal Code","Other Country","Company" => "company_name","Department", "Job Title","Assistant's Phone","Business Fax" => "fax","Business Phone" => "phone", "Business Phone 2" => "phone2" ,"Callback", "Car Phone","Company Main Phone","Home Fax","Home Phone","Home Phone 2","ISDN","Mobile Phone", "Other Fax","Other Phone","Pager","Primary Phone","Radio Phone","TTY/TDD Phone","Telex", "Assistant's Name","Birthday" => "birthdate","Manager's Name","Notes","Other Address PO Box","Spouse", "Web Page" => "website", "Personal Web Page" => "website", 'Mail Group' => 'mail_group' )
private string $csvDelimiter
# self::DEFAULT_CSV_DELIMITER

Properties inherited from BEAppObjectModel

$hasOne, $recursive

Properties inherited from BEAppModel

$driver, $eQ, $sQ

Properties inherited from AppModel

$apiTransformerOptions

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