gnu-social/plugins/ExtendedProfile/classes/Profile_detail.php

106 lines
3.8 KiB
PHP
Raw Normal View History

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
/*
* @copyright 1012 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
defined('GNUSOCIAL') || die();
2011-03-08 01:26:19 +00:00
/**
* DataObject class to store extended profile fields. Allows for storing
2011-03-10 02:00:24 +00:00
* multiple values per a "field_name" (field_name property is not unique).
2011-03-08 01:26:19 +00:00
*
* Example:
*
* Jed's Phone Numbers
* home : 510-384-1992
* mobile: 510-719-1139
* work : 415-231-1121
*
* We can store these phone numbers in a "field" represented by three
* Profile_detail objects, each named 'phone_number' like this:
*
* $phone1 = new Profile_detail();
2011-03-10 02:00:24 +00:00
* $phone1->field_name = 'phone_number';
2011-03-08 01:26:19 +00:00
* $phone1->rel = 'home';
2011-03-10 02:16:02 +00:00
* $phone1->field_value = '510-384-1992';
2011-03-10 02:00:24 +00:00
* $phone1->value_index = 1;
2011-03-08 01:26:19 +00:00
*
* $phone1 = new Profile_detail();
2011-03-10 02:00:24 +00:00
* $phone1->field_name = 'phone_number';
2011-03-08 01:26:19 +00:00
* $phone1->rel = 'mobile';
2011-03-10 02:16:02 +00:00
* $phone1->field_value = '510-719-1139';
2011-03-10 02:00:24 +00:00
* $phone1->value_index = 2;
2011-03-08 01:26:19 +00:00
*
* $phone1 = new Profile_detail();
2011-03-10 02:00:24 +00:00
* $phone1->field_name = 'phone_number';
2011-03-08 01:26:19 +00:00
* $phone1->rel = 'work';
2011-03-10 02:00:24 +00:00
* $phone1->field_value = '415-231-1121';
* $phone1->value_index = 3;
2011-03-08 01:26:19 +00:00
*
*/
2011-03-10 02:00:24 +00:00
class Profile_detail extends Managed_DataObject
{
2011-03-08 01:26:19 +00:00
public $__table = 'profile_detail';
public $id;
2011-03-10 02:00:24 +00:00
public $profile_id; // profile this is for
2011-03-08 01:26:19 +00:00
public $rel; // detail for some field types; eg "home", "mobile", "work" for phones or "aim", "irc", "xmpp" for IM
2011-03-10 02:00:24 +00:00
public $field_name; // name
2011-03-10 02:16:02 +00:00
public $field_value; // primary text value
2011-03-10 02:00:24 +00:00
public $value_index; // relative ordering of multiple values in the same field
public $date; // related date
public $ref_profile; // for people types, allows pointing to a known profile in the system
public $created;
public $modified;
public static function schemaDef()
{
return [
// No need for i18n. Table properties.
'description' => 'Additional profile details for the ExtendedProfile plugin',
'fields' => [
'id' => ['type' => 'serial', 'not null' => true],
'profile_id' => ['type' => 'int', 'not null' => true],
'field_name' => [
'type' => 'varchar',
'length' => 16,
'not null' => true,
],
'value_index' => ['type' => 'int'],
'field_value' => ['type' => 'text'],
'date' => ['type' => 'datetime'],
'rel' => ['type' => 'varchar', 'length' => 16],
'rel_profile' => ['type' => 'int'],
'created' => [
'type' => 'datetime',
'not null' => true,
],
'modified' => [
2011-03-10 02:00:24 +00:00
'type' => 'timestamp',
'not null' => true,
],
],
'primary key' => ['id'],
'unique keys' => [
'profile_detail_profile_id_field_name_value_index_key' => ['profile_id', 'field_name', 'value_index']
],
];
}
}