-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathregistrarclass.php
1471 lines (1292 loc) · 42.2 KB
/
registrarclass.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
require_once("3rdparty/domain/IRegistrar.php");
require_once("3rdparty/domain/standardfunctions.php");
/**
* -------------------------------------------------------------------------------------
* YourName - IRegistrar
*
* Author :
* Copyright :
* Version :
*
* CHANGE LOG:
* -------------------------------------------------------------------------------------
* yyyy-mm-yy Author Initial version
* -------------------------------------------------------------------------------------
*/
class YourName implements IRegistrar
{
public $User;
public $Password;
public $Error;
public $Warning;
public $Success;
public $Period = 1;
public $registrarHandles = array();
private $ClassName;
function __construct(){
$this->ClassName = __CLASS__;
$this->Error = array();
$this->Warning = array();
$this->Success = array();
}
/**
* Check whether a domain is already regestered or not.
*
* @param string $domain The name of the domain that needs to be checked.
* @return boolean True if free, False if not free, False and $this->Error[] in case of error.
*/
function checkDomain($domain) {
$my_result = $yourproxy->checkDomain($domain);
if($my_result == 'free'){
return true;
}elseif($my_result == 'active'){
return false;
}else{
$this->Error[] = 'Checking availability for domain TLD is not supported via the API.';
return false;
}
}
// /**
// * EXAMPLE IF A FUNCTION IS NOT SUPPORTED
// * Check whether a domain is already regestered or not.
// *
// * @param string $domain The name of the domain that needs to be checked.
// * @return boolean True if free, False if not free, False and $this->Error[] in case of error.
// */
// function checkDomain($domain) {
// $this->Warning[] = 'YourName: checking availability for domain '.$domain.' cannot be checked via the API.';
//
// if($this->caller == 'register'){
// return true;
// }elseif($this->caller == 'transfer'){
// return false;
// }
// }
/**
* Register a new domain
*
* @param string $domain The domainname that needs to be registered.
* @param array $nameservers The nameservers for the new domain.
* @param array $whois The customer information for the domain's whois information.
* @return bool True on success; False otherwise.
*/
function registerDomain($domain, $nameservers = array(), $whois = null) {
/** if you use DNS management, the following variables are also available
* $this->DNSTemplateID
* $this->DNSTemplateName
*/
/**
* Step 1) obtain an owner handle
*/
$ownerHandle = "";
// Check if a registrar-specific ownerhandle for this domain already exists.
if (isset($whois->ownerRegistrarHandles[$this->ClassName]))
{
$ownerHandle = $whois->ownerRegistrarHandles[$this->ClassName];
}
// If not, check if WHOIS-data for owner contact is available to search or create new handle
elseif($whois->ownerSurName != "")
{
// Search for existing handle, based on WHOIS data
$ownerHandle = $this->getContactHandle($whois, HANDLE_OWNER);
// If no existing handle is found, create new handle
if ($ownerHandle == "")
{
// Try to create new handle. In case of failure, quit function
if(!$ownerHandle = $this->createContact($whois, HANDLE_OWNER))
{
return false;
}
}
// If a new handle is created or found, store in array. HostFact will store this data, which will result in faster registration next time.
$this->registrarHandles['owner'] = $ownerHandle;
} else {
// If no handle can be created, because data is missing, quit function
$this->Error[] = sprintf("YourName: No domain owner contact given for domain '%s'.", $domain);
return false;
}
/**
* Step 2) obtain an admin handle
*/
$adminHandle = "";
// Check if a registrar-specific adminhandle for this domain already exists.
if (isset($whois->adminRegistrarHandles[$this->ClassName]))
{
$adminHandle = $whois->adminRegistrarHandles[$this->ClassName];
}
// If not, check if WHOIS-data for admin contact is available to search or create new handle
elseif($whois->adminSurName != "")
{
// Search for existing handle, based on WHOIS data
$adminHandle = $this->getContactHandle($whois, HANDLE_ADMIN);
// If no existing handle is found, create new handle
if ($adminHandle == "")
{
// Try to create new handle. In case of failure, quit function
if(!$adminHandle = $this->createContact($whois, HANDLE_ADMIN))
{
return false;
}
}
// If a new handle is created or found, store in array. HostFact will store this data, which will result in faster registration next time.
$this->registrarHandles['admin'] = $adminHandle;
} else {
// If no handle can be created, because data is missing, quit function
$this->Error[] = sprintf("YourName: No domain admin contact given for domain '%s'.", $domain);
return false;
}
/**
* Step 3) obtain a tech handle
*/
$techHandle = "";
// Check if a registrar-specific techhandle for this domain already exists.
if (isset($whois->techRegistrarHandles[$this->ClassName]))
{
$techHandle = $whois->techRegistrarHandles[$this->ClassName];
}
// If not, check if WHOIS-data for tech contact is available to search or create new handle
elseif($whois->techSurName != "")
{
// Search for existing handle, based on WHOIS data
$techHandle = $this->getContactHandle($whois, HANDLE_TECH);
// If no existing handle is found, create new handle
if ($techHandle == "")
{
// Try to create new handle. In case of failure, quit function
if(!$techHandle = $this->createContact($whois, HANDLE_TECH))
{
return false;
}
}
// If a new handle is created or found, store in array. HostFact will store this data, which will result in faster registration next time.
$this->registrarHandles['tech'] = $techHandle;
} else {
// If no handle can be created, because data is missing, quit function
$this->Error[] = sprintf("YourName: No domain tech contact given for domain '%s'.", $domain);
return false;
}
/**
* Step 4) obtain nameserver handles
*/
// If your system uses nameserver groups or handles, you can check the $nameserver array and match these hostnames with your own system.
/**
* Step 5) check your own default settings
*/
// Determine period for registration in years, based on your TLD properties.
// $this->Period is also used in HostFact, for determining the renewal date.
$this->Period = 1;
/**
* Step 6) register domain
*/
// Start registering the domain, you can use $domain, $ownerHandle, $adminHandle, $techHandle, $nameservers
$response = true;
$error_msg = '';
/**
* Step 7) provide feedback to HostFact
*/
if($response === true)
{
// Registration is succesfull
return true;
}
else
{
// Registration failed
$this->Error[] = sprintf("YourName: Error while registering '%s': ", $error_msg);
return false;
}
}
/**
* Transfer a domain to the given user.
*
* @param string $domain The demainname that needs to be transfered.
* @param array $nameservers The nameservers for the tranfered domain.
* @param array $whois The contact information for the new owner, admin, tech and billing contact.
* @return bool True on success; False otherwise;
*/
function transferDomain($domain, $nameservers = array(), $whois = null, $authcode = "") {
/** if you use DNS management, the following variables are also available
* $this->DNSTemplateID
* $this->DNSTemplateName
*/
/**
* Step 1) obtain an owner handle
*/
$ownerHandle = "";
// Check if a registrar-specific ownerhandle for this domain already exists.
if (isset($whois->ownerRegistrarHandles[$this->ClassName]))
{
$ownerHandle = $whois->ownerRegistrarHandles[$this->ClassName];
}
// If not, check if WHOIS-data for owner contact is available to search or create new handle
elseif($whois->ownerSurName != "")
{
// Search for existing handle, based on WHOIS data
$ownerHandle = $this->getContactHandle($whois, HANDLE_OWNER);
// If no existing handle is found, create new handle
if ($ownerHandle == "")
{
// Try to create new handle. In case of failure, quit function
if(!$ownerHandle = $this->createContact($whois, HANDLE_OWNER))
{
return false;
}
}
// If a new handle is created or found, store in array. HostFact will store this data, which will result in faster transfer next time.
$this->registrarHandles['owner'] = $ownerHandle;
} else {
// If no handle can be created, because data is missing, quit function
$this->Error[] = sprintf("YourName: No domain owner contact given for domain '%s'.", $domain);
return false;
}
/**
* Step 2) obtain an admin handle
*/
$adminHandle = "";
// Check if a registrar-specific adminhandle for this domain already exists.
if (isset($whois->adminRegistrarHandles[$this->ClassName]))
{
$adminHandle = $whois->adminRegistrarHandles[$this->ClassName];
}
// If not, check if WHOIS-data for admin contact is available to search or create new handle
elseif($whois->adminSurName != "")
{
// Search for existing handle, based on WHOIS data
$adminHandle = $this->getContactHandle($whois, HANDLE_ADMIN);
// If no existing handle is found, create new handle
if ($adminHandle == "")
{
// Try to create new handle. In case of failure, quit function
if(!$adminHandle = $this->createContact($whois, HANDLE_ADMIN))
{
return false;
}
}
// If a new handle is created or found, store in array. HostFact will store this data, which will result in faster transfer next time.
$this->registrarHandles['admin'] = $adminHandle;
} else {
// If no handle can be created, because data is missing, quit function
$this->Error[] = sprintf("YourName: No domain admin contact given for domain '%s'.", $domain);
return false;
}
/**
* Step 3) obtain a tech handle
*/
$techHandle = "";
// Check if a registrar-specific techhandle for this domain already exists.
if (isset($whois->techRegistrarHandles[$this->ClassName]))
{
$techHandle = $whois->techRegistrarHandles[$this->ClassName];
}
// If not, check if WHOIS-data for tech contact is available to search or create new handle
elseif($whois->techSurName != "")
{
// Search for existing handle, based on WHOIS data
$techHandle = $this->getContactHandle($whois, HANDLE_TECH);
// If no existing handle is found, create new handle
if ($techHandle == "")
{
// Try to create new handle. In case of failure, quit function
if(!$techHandle = $this->createContact($whois, HANDLE_TECH))
{
return false;
}
}
// If a new handle is created or found, store in array. HostFact will store this data, which will result in faster transfer next time.
$this->registrarHandles['tech'] = $techHandle;
} else {
// If no handle can be created, because data is missing, quit function
$this->Error[] = sprintf("YourName: No domain tech contact given for domain '%s'.", $domain);
return false;
}
/**
* Step 4) obtain nameserver handles
*/
// If your system uses nameserver groups or handles, you can check the $nameserver array and match these hostnames with your own system.
/**
* Step 5) check your own default settings
*/
// Determine period for transfer in years, based on your TLD properties.
// $this->Period is also used in HostFact, for determining the renewal date.
$this->Period = 1;
/**
* Step 6) transfer domain
*/
// Start transferring the domain, you can use $domain, $ownerHandle, $adminHandle, $techHandle, $nameservers, $authcode
$response = true;
$error_msg = '';
/**
* Step 7) provide feedback to HostFact
*/
if($response === true)
{
// Transfer is succesfull
return true;
}
else
{
// Transfer failed
$this->Error[] = sprintf("YourName: Error while transferring '%s': ", $error_msg);
return false;
}
}
/**
* Delete a domain
*
* @param string $domain The name of the domain that you want to delete.
* @param string $delType end|now
* @return bool True if the domain was succesfully removed; False otherwise;
*/
function deleteDomain($domain, $delType = 'end') {
if($delType == "end"){
return $this->setDomainAutoRenew($domain, false);
}else{
/**
* Step 1) delete domain
*/
// Delete the domain, you can use $domain
$response = true;
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
// Deleting is succesfull
return true;
}
else
{
// Deleting failed
$this->Error[] = sprintf("YourName: Error while terminating '%s': %s", $domain, $error_msg);
return false;
}
}
}
/**
* Get all available information of the given domain
*
* @param mixed $domain The domain for which the information is requested.
* @return array The array containing all information about the given domain
*/
function getDomainInformation($domain) {
/**
* Step 1) query domain
*/
// Query the domain, you can use $domain
$response = true;
$error_msg = '';
$nameservers_array = array('ns1.hostfact.com','ns2.hostfact.com');
$whois = new whois();
$whois->ownerHandle = 'ABCD001';
$whois->adminHandle = 'ABCD001';
$whois->techHandle = 'ABCD002';
$expirationdate = '2012-05-01';
$registrationdate = '2000-05-01';
$authkey = '1234567';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
// Return array with data
$response = array( "Domain" => $domain,
"Information" => array( "nameservers" => $nameservers_array, // Array with 1, 2 or 3 elements (hostnames)
"whois" => $whois, // Whois object
"expiration_date" => $expirationdate, // Empty or date in yyyy-mm-dd
"registration_date" => $registrationdate, // Empty or date in yyyy-mm-dd
"authkey" => $authkey));
return $response;
}
else
{
// No information can be found
$this->Error[] = sprintf("YourName: Error while retreiving information about '%s': %s", $domain, $error_msg);
return false;
}
}
/**
* Get a list of all the domains.
*
* @param string $contactHandle The handle of a contact, so the list could be filtered (usefull for updating domain whois data)
* @return array A list of all domains available in the system.
*/
function getDomainList($contactHandle = "") {
/**
* Step 1) query domain
*/
// Query the domain, you can use $domain
$response = true;
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
$domain_array = array();
// Loop for all domains:
$nameservers_array = array('ns1.hostfact.com','ns2.hostfact.com');
$whois = new whois();
$whois->ownerHandle = 'ABCD001';
$whois->adminHandle = 'ABCD001';
$whois->techHandle = 'ABCD002';
$expirationdate = '2012-05-01';
$registrationdate = '2000-05-01';
$authkey = '1234567';
// Return array with data
$response = array( "Domain" => $domain,
"Information" => array( "nameservers" => $nameservers_array, // Array with 1, 2 or 3 elements (hostnames)
"whois" => $whois, // Whois object
"expiration_date" => $expirationdate, // Empty or date in yyyy-mm-dd
"registration_date" => $registrationdate, // Empty or date in yyyy-mm-dd
"authkey" => $authkey));
$domain_array[] = $response;
// When loop is ready, return array
return $domain_array;
}
else
{
// No domains can be found
$this->Error[] = sprintf("YourName: Error while retreiving domains: %s", $error_msg);
return false;
}
}
/**
* Change the lock status of the specified domain.
*
* @param string $domain The domain to change the lock state for
* @param bool $lock The new lock state (True|False)
* @return bool True is the lock state was changed succesfully
*/
function lockDomain($domain, $lock = true) {
/**
* Step 1) (un)lock domain
*/
// (un)lock the domain, you can use $domain and $lock
$response = true;
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
// (un)locking is succesfull
return true;
}
else
{
// (un)locking failed
$this->Error[] = sprintf("YourName: Error while (un)locking '%s': %s", $domain, $error_msg);
return false;
}
}
/**
* Change the autorenew state of the given domain. When autorenew is enabled, the domain will be extended.
*
* @param string $domain The domainname to change the autorenew setting for,
* @param bool $autorenew The new autorenew setting (True = On|False = Off)
* @return bool True when the setting is succesfully changed; False otherwise
*/
function setDomainAutoRenew($domain, $autorenew = true) {
/**
* Step 1) change autorenew for domain
*/
// change autorenew for the domain, you can use $domain and $autorenew
$response = true;
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
// change is succesfull
return true;
}
else
{
// change failed
$this->Error[] = sprintf("YourName: Error while changing auto renew '%s': %s", $domain, $error_msg);
return false;
}
}
/**
* Get EPP code/token
*
* @param mixed $domain
* @return
*/
public function getToken($domain){
/**
* Step 1) get EPP code/token
*/
$response = true;
$auth_code = 'XYZ0123';
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
// EPP code is retrieved
return $auth_code;
}
else
{
// EPP code cannot be retrieved
$this->Error[] = sprintf("YourName: Error while retreiving authorization code '%s': %s", $domain, $error_msg);
return false;
}
}
/**
* getSyncData()
* Check domain information for one or more domains
* @param mixed $list_domains Array with list of domains. Key is domain, value must be filled.
* @return mixed $list_domains
*/
public function getSyncData($list_domains)
{
/**
* There are two scenario's for retrieving the information
* 1. Get the domain list which provide sufficient information for this function
* 2. We must request the info per domain. Take care of script timeout
*
* Both scenario's can be found below
*/
$scenario = 'list'; // list | onebyone
if($scenario == 'list')
{
/**
* Scenario 1: Get the domain list which provide sufficient information for this function
*/
// First copy the array to $check_domains, so we can check if domains doesn't exist anymore
$check_domains = $list_domains;
// Ask registrar for information of all domains
$response = array(); // Array with all domains and their information
if($response === FALSE)
{
$this->Error[] = 'Domain(s) could not be retrieved at the registrar';
return FALSE;
}
// loop trough the domain list from the registrar
foreach($response as $_domain_info)
{
$domain_name = 'hostfact.com';
if(!isset($list_domains[$domain_name]))
{
// Not in list to sync
continue;
}
// Add data
$nameservers_array = array('ns1.hostfact.com','ns2.hostfact.com');
$expirationdate = '2014-05-01';
$auto_renew = 'on'; // or 'off'
// extend the list_domains array with data from the registrar
$list_domains[$domain_name]['Information']['nameservers'] = $nameservers_array;
$list_domains[$domain_name]['Information']['expiration_date'] = (isset($expirationdate)) ? $expirationdate : '';
$list_domains[$domain_name]['Information']['auto_renew'] = (isset($auto_renew)) ? $auto_renew : '';
$list_domains[$domain_name]['Status'] = 'success';
unset($check_domains[$domain_key]);
}
// add errors to the domains that weren't found with the registrar
if(count($check_domains) > 0)
{
foreach($check_domains as $domain_key => $value)
{
$list_domains[$domain_key]['Status'] = 'error';
$list_domains[$domain_key]['Error_msg'] = 'Domain not found';
}
}
// Return list
return $list_domains;
}
elseif($scenario == 'onebyone')
{
/**
* Scenario 2: We must request the info per domain. Take care of script timeout
*/
$max_domains_to_check = 10;
$checked_domains = 0;
// Check domain one for one
foreach($list_domains as $domain_name => $value)
{
// Ask registrar for information of domain
$response = array(); // Array with domain information
if($response === FALSE)
{
$list_domains[$domain_name]['Status'] = 'error';
$list_domains[$domain_name]['Error_msg'] = 'Domain not found';
continue;
}
// Add data
$nameservers_array = array('ns1.hostfact.com','ns2.hostfact.com');
$expirationdate = '2014-05-01';
$auto_renew = 'on'; // or 'off'
// extend the list_domains array with data from the registrar
$list_domains[$domain_name]['Information']['nameservers'] = $nameservers_array;
$list_domains[$domain_name]['Information']['expiration_date'] = (isset($expirationdate)) ? $expirationdate : '';
$list_domains[$domain_name]['Information']['auto_renew'] = (isset($auto_renew)) ? $auto_renew : '';
$list_domains[$domain_name]['Status'] = 'success';
// Increment counter
$checked_domains++;
// Stop loop after max domains
if($checked_domains > $max_domains_to_check)
{
break;
}
}
// Return list (domains which aren't completed with data, will be synced by a next cronjob)
return $list_domains;
}
}
/**
* Update the domain Whois data, but only if no handles are used by the registrar.
*
* @param mixed $domain
* @param mixed $whois
* @return boolean True if succesfull, false otherwise
*/
function updateDomainWhois($domain,$whois){
/**
* Step 1) update WHOIS data for domain.
*/
// update owner WHOIS for the domain, you can use $domain and $whois
$response = true;
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response === true)
{
// update is succesfull
return true;
}
else
{
// update failed
$this->Error[] = sprintf("YourName: Error while changing contact for '%s': %s", $domain, $error_msg);
return false;
}
}
/**
* get domain whois handles
*
* @param mixed $domain
* @return array with handles
*/
function getDomainWhois($domain){
/**
* Step 1) get handles for WHOIS contacts
*/
$contacts = array();
$contacts['ownerHandle'] = 'ABC001';
$contacts['adminHandle'] = 'ABC002';
$contacts['techHandle'] = 'ABC003';
/**
* Step 2) provide feedback to HostFact
*/
return $contacts;
}
/**
* Create a new whois contact
*
* @param array $whois The whois information for the new contact.
* @param mixed $type The contact type. This is only used to access the right data in the $whois object.
* @return bool Handle when the new contact was created succesfully; False otherwise.
*/
function createContact($whois, $type = HANDLE_OWNER) {
// Determine which contact type should be found
switch($type) {
case HANDLE_OWNER: $prefix = "owner"; break;
case HANDLE_ADMIN: $prefix = "admin"; break;
case HANDLE_TECH: $prefix = "tech"; break;
default: $prefix = ""; break;
}
// Some help-functions, to obtain more formatted data
$whois->getParam($prefix,'StreetName'); // Not only Address, but also StreetName, StreetNumber and StreetNumberAddon are available after calling this function.
$whois->getParam($prefix,'CountryCode'); // Phone and faxnumber are split. CountryCode, PhoneNumber and FaxNumber available. CountryCode contains for example '+31'. PhoneNumber contains number without leading zero e.g. '123456789'.
/**
* Step 1) Create the contact
*/
// Create the contact
// Available variables, see example in Appendix A of documentation.
// e.g.
// $whois->ownerSurName To obtain surname of domain owner
// $whois->adminPhoneNumber To obtain phone number of admin contact data
$handle = 'ABCDEF';
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($handle)
{
// A handle is created
return $handle;
}
else
{
// Creating handle failed
$this->Error[] = sprintf("YourName: Error while creating contact: %s", $error_msg);
return false;
}
}
/**
* Update the whois information for the given contact person.
*
* @param string $handle The handle of the contact to be changed.
* @param array $whois The new whois information for the given contact.
* @param mixed $type The of contact. This is used to access the right fields in the whois array
* @return
*/
function updateContact($handle, $whois, $type = HANDLE_OWNER) {
// Determine which contact type should be found
switch($type) {
case HANDLE_OWNER: $prefix = "owner"; break;
case HANDLE_ADMIN: $prefix = "admin"; break;
case HANDLE_TECH: $prefix = "tech"; break;
default: $prefix = ""; break;
}
// Some help-functions, to obtain more formatted data
$whois->getParam($prefix,'StreetName'); // Not only Address, but also StreetName, StreetNumber and StreetNumberAddon are available after calling this function.
$whois->getParam($prefix,'CountryCode'); // Phone and faxnumber are split. CountryCode, PhoneNumber and FaxNumber available. CountryCode contains for example '+31'. PhoneNumber contains number without leading zero e.g. '123456789'.
/**
* Step 1) Update the contact, it can depend on the modified data which action you should take.
*/
// Update the contact
// Available variables, see example in Appendix A of documentation.
// e.g.
// $whois->ownerSurName To obtain surname of domain owner
// $whois->adminPhoneNumber To obtain phone number of admin contact data
$response = true;
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response)
{
// If a new handle is created, you can use:
// $this->registrarHandles[$prefix] = "ABCDEF";
// handle is updated
return true;
}
else
{
// Updating handle failed
$this->Error[] = sprintf("YourName: Error while editting contact: %s", $error_msg);
return false;
}
}
/**
* Get information availabe of the requested contact.
*
* @param string $handle The handle of the contact to request.
* @return array Information available about the requested contact.
*/
function getContact($handle){
/**
* Step 1) Create the contact
*/
// Create the contact
$response = true;
$whois = new whois();
$error_msg = '';
/**
* Step 2) provide feedback to HostFact
*/
if($response)
{
// The contact is found
$whois->ownerCompanyName = "BusinessName";
$whois->ownerInitials = "C.";
$whois->ownerSurName = "Jackson";
$whois->ownerAddress = "222 E 14th Street";
$whois->ownerZipCode = "10003";
$whois->ownerCity = "New York";
$whois->ownerCountry = 'US';
$whois->ownerPhoneNumber = "+1 23 45 67 80";
$whois->ownerFaxNumber = "+1 23 45 67 81";
$whois->ownerEmailAddress = "example@hostfact.com";
return $whois;
}
else
{
// Contact cannot be found
$this->Error[] = sprintf("YourName: Error while retreiving contact: %s", $error_msg);
return $whois;
}
}
/**
* Get the handle of a contact.
*
* @param array $whois The whois information of contact
* @param string $type The type of person. This is used to access the right fields in the whois object.
* @return string handle of the requested contact; False if the contact could not be found.
*/
function getContactHandle($whois = array(), $type = HANDLE_OWNER) {
// Determine which contact type should be found
switch($type) {
case HANDLE_OWNER: $prefix = "owner"; break;
case HANDLE_ADMIN: $prefix = "admin"; break;
case HANDLE_TECH: $prefix = "tech"; break;
default: $prefix = ""; break;
}
/**
* Step 1) Search for contact data
*/
// Search for a handle which can be used
$handle = 'ABCDEF';
/**
* Step 2) provide feedback to HostFact
*/
if($handle)
{
// A handle is found
return $handle;
}
else
{
// No handle is found
return false;
}
}
/**
* Get a list of contact handles available
*
* @param string $surname Surname to limit the number of records in the list.
* @return array List of all contact matching the $surname search criteria.
*/
function getContactList($surname = "") {
/**
* Step 1) Search for contact data
*/
$contact_list = array(array("Handle" => "C0222-042",
"CompanyName" => "BusinessName",
"SurName" => "Jackson",
"Initials" => "C."
),
array( "Handle" => "C0241-001",
"CompanyName" => "",
"SurName" => "Smith",
"Initials" => "John"
)
);
/**
* Step 2) provide feedback to HostFact
*/
if(count($contact_list) > 0)
{