~ubuntu-branches/ubuntu/intrepid/ldap-account-manager/intrepid

This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).

303

</dd>

304

<dt>

305

<a href="../modules/baseModule.html#methodgetAccountContainer">baseModule::getAccountContainer()</a>

306

</dt>

307

<dd>

308

Returns the <a href="../modules/accountContainer.html">accountContainer</a> object.

309

</dd>

310

<dt>

311

<a href="../modules/baseModule.html#methodgetAttributes">baseModule::getAttributes()</a>

312

</dt>

313

<dd>

314

Returns the LDAP attributes which are managed in this module.

315

</dd>

316

<dt>

317

<a href="../modules/baseModule.html#methodgetButtonStatus">baseModule::getButtonStatus()</a>

318

</dt>

319

<dd>

320

Controls if the module button the account page is visible and activated.

321

</dd>

322

<dt>

323

<a href="../modules/baseModule.html#methodgetIcon">baseModule::getIcon()</a>

324

</dt>

325

<dd>

326

Returns the path to the module icon.

327

</dd>

328

<dt>

329

<a href="../modules/baseModule.html#methodgetLDAPAliases">baseModule::getLDAPAliases()</a>

330

</dt>

331

<dd>

332

Returns a list of aliases for LDAP attributes.

333

</dd>

334

<dt>

335

<a href="../modules/baseModule.html#methodgetManagedAttributes">baseModule::getManagedAttributes()</a>

336

</dt>

337

<dd>

338

Returns a list of LDAP attributes which are managed by this module.

339

</dd>

340

<dt>

341

<a href="../modules/baseModule.html#methodgetManagedObjectClasses">baseModule::getManagedObjectClasses()</a>

342

</dt>

343

<dd>

344

Returns a list of managed object classes for this module.

345

</dd>

346

<dt>

347

<a href="../modules/baseModule.html#methodgetOriginalAttributes">baseModule::getOriginalAttributes()</a>

348

</dt>

349

<dd>

350

Returns the LDAP attributes which are managed in this module (with unchanged values).

351

</dd>

352

<dt>

353

<a href="../modules/baseModule.html#methodgetRequiredExtensions">baseModule::getRequiredExtensions()</a>

354

</dt>

355

<dd>

356

This function returns a list of PHP extensions (e.g. mhash) which are needed by this module.

357

</dd>

358

<dt>

359

<a href="../modules/baseModule.html#methodgetSelfServiceFields">baseModule::getSelfServiceFields()</a>

360

</dt>

361

<dd>

362

Returns a list of possible input fields and their descriptions.

363

</dd>

364

<dt>

365

<a href="../modules/baseModule.html#methodgetSelfServiceOptions">baseModule::getSelfServiceOptions()</a>

366

</dt>

367

<dd>

368

Returns the meta HTML code for each input field.

369

</dd>

370

<dt>

371

<a href="../modules/baseModule.html#methodgetSelfServiceSearchAttributes">baseModule::getSelfServiceSearchAttributes()</a>

372

</dt>

373

<dd>

374

This function returns a list of possible LDAP attributes (e.g. uid, cn, ...) which can be used to search for LDAP objects.

375

</dd>

376

<dt>

377

<a href="../modules/baseModule.html#methodgetSelfServiceSettings">baseModule::getSelfServiceSettings()</a>

378

</dt>

379

<dd>

380

Returns a list of self service configuration settings.

381

</dd>

382

<dt>

383

<a href="../modules/baseModule.html#methodget_alias">baseModule::get_alias()</a>

384

</dt>

385

<dd>

386

Returns an alias name for the module.

387

</dd>

388

<dt>

389

<a href="../modules/baseModule.html#methodget_configOptions">baseModule::get_configOptions()</a>

390

</dt>

391

<dd>

392

Returns a list of configuration options.

393

</dd>

394

<dt>

395

<a href="../modules/baseModule.html#methodget_dependencies">baseModule::get_dependencies()</a>

396

</dt>

397

<dd>

398

This function returns a list with all depending and conflicting modules.

399

</dd>

400

<dt>

401

<a href="../modules/baseModule.html#methodget_help">baseModule::get_help()</a>

402

</dt>

403

<dd>

404

This function returns the help entry array for a specific help id.

405

</dd>

406

<dt>

407

<a href="../modules/baseModule.html#methodget_ldap_filter">baseModule::get_ldap_filter()</a>

408

</dt>

409

<dd>

410

Returns an LDAP filter for the account lists

411

</dd>

412

<dt>

413

<a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a>

414

</dt>

415

<dd>

416

This function provides meta data which is interpreted by baseModule.

417

</dd>

418

<dt>

419

<a href="../modules/baseModule.html#methodget_pdfFields">baseModule::get_pdfFields()</a>

420

</dt>

421

<dd>

422

Returns a hashtable with all entries that may be printed out in the PDF.

423

</dd>

424

<dt>

425

<a href="../modules/baseModule.html#methodget_profileOptions">baseModule::get_profileOptions()</a>

426

</dt>

427

<dd>

428

This function defines what attributes will be used in the account profiles and their appearance in the profile editor.

429

</dd>

430

<dt>

431

<a href="../modules/baseModule.html#methodget_RDNAttributes">baseModule::get_RDNAttributes()</a>

432

</dt>

433

<dd>

434

Returns a hash array containing a list of possible LDAP attributes that can be used to form the RDN (Relative Distinguished Name).

435

</dd>

436

<dt>

437

<a href="../modules/baseModule.html#methodget_scope">baseModule::get_scope()</a>

438

</dt>

439

<dd>

440

Returns the account type of this module (user, group, host)

441

</dd>

442

<dt>

443

<a href="../modules/baseModule.html#methodget_uploadColumns">baseModule::get_uploadColumns()</a>

444

</dt>

445

<dd>

446

Returns an array containing all input columns for the file upload.

447

</dd>

448

<dt>

449

<a href="../modules/baseModule.html#methodget_uploadPreDepends">baseModule::get_uploadPreDepends()</a>

450

</dt>

451

<dd>

452

Returns a list of module names which must be processed in building the account befor this module.

453

</dd>

454

<dt>

455

<a href="../modules/baseModule.html#methodinit">baseModule::init()</a>

456

</dt>

457

<dd>

458

Initializes the module after it became part of an <a href="../modules/accountContainer.html">accountContainer</a>

459

</dd>

460

<dt>

461

<a href="../modules/baseModule.html#methodis_base_module">baseModule::is_base_module()</a>

462

</dt>

463

<dd>

464

Returns true if your module is a base module and otherwise false.

465

</dd>

466

<dt>

467

<a href="../modules/baseModule.html#methodload_attributes">baseModule::load_attributes()</a>

468

</dt>

469

<dd>

470

This function loads the LDAP attributes when an account should be loaded.

471

</dd>

472

<dt>

473

<a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a>

474

</dt>

475

<dd>

476

This function fills the $messages variable with output messages from this module.

477

</dd>

478

<dt>

479

<a href="../modules/baseModule.html#methodload_profile">baseModule::load_profile()</a>

480

</dt>

481

<dd>

482

This function loads the values from an account profile to the module's internal data structures.

483

</dd>

484

<dt>

485

<a href="../modules/baseModule.html#methodmodule_complete">baseModule::module_complete()</a>

486

</dt>

487

<dd>

488

This functions is used to check if all settings for this module have been made.

489

</dd>

490

<dt>

491

<a href="../modules/baseModule.html#methodmodule_ready">baseModule::module_ready()</a>

492

</dt>

493

<dd>

494

This function is used to check if this module page can be displayed.

495

</dd>

496

<dt>

497

<a href="../modules/baseModule.html#methodpostDeleteActions">baseModule::postDeleteActions()</a>

498

</dt>

499

<dd>

500

Allows the module to run commands after the LDAP entry is deleted.

501

</dd>

502

<dt>

503

<a href="../modules/baseModule.html#methodpostModifyActions">baseModule::postModifyActions()</a>

504

</dt>

505

<dd>

506

Allows the module to run commands after the LDAP entry is changed or created.

507

</dd>

508

<dt>

509

<a href="../modules/baseModule.html#methodpreDeleteActions">baseModule::preDeleteActions()</a>

510

</dt>

511

<dd>

512

Allows the module to run commands before the LDAP entry is deleted.

513

</dd>

514

<dt>

515

<a href="../modules/baseModule.html#methodpreModifyActions">baseModule::preModifyActions()</a>

516

</dt>

517

<dd>

518

Allows the module to run commands before the LDAP entry is changed or created.

519

</dd>

520

<dt>

521

<a href="../modules/baseModule.html#methodprocess_attributes">baseModule::process_attributes()</a>

522

</dt>

523

<dd>

524

This function processes user input.

525

</dd>

526

<dt>

527

<a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a>

528

</dt>

529

<dd>

530

Returns a list of modifications which have to be made to the LDAP account.

531

</dd>

532

</dl>

533

</div>

534

</td>

535

536

</tr></table>

537

<hr />

538

539

540

<h3>Class Details</h3>

541

542

[line 38]<br />

543

This module manages LDAP attributes of the object class inetOrgPerson (e.g. name and address).<br /><br /><br /><br />

544

545

546

547

<tr>

548

<td><b>author:</b>  </td><td>Roland Gruber</td>

549

</tr>

550

</table>

551

</div>

552

</div><br /><br />

553

554

555

556

<hr />

557

558

<h3>Class Methods</h3>

559

560

561

<hr />

562

563

<h3>method build_uploadAccounts <span class="smalllinenumber">[line 1079]</span></h3>

564

565

566

567

<code>array build_uploadAccounts(

568

array

569

$rawAccounts, array

570

$ids,

571

&$partialAccounts, array

572

$partialAccounts)</code>

573

</td></tr></table>

574

</td></tr></table><br />

575

576

In this function the LDAP account is built up.<br /><br /><br /><br />

577

578

579

580

<tr>

581

<td><b>return:</b>  </td><td>list of error messages if any</td>

582

</tr>

583

</table>

584

</div>

585

586

587

Overrides <a href="../modules/baseModule.html#methodbuild_uploadAccounts">baseModule::build_uploadAccounts()</a> (In this function the LDAP accounts are built.)<br /><br />

588

<h4>Parameters:</h4>

589

590

591

<tr>

592

<td class="type">array  </td>

593

<td><b>$rawAccounts</b>  </td>

594

<td>list of hash arrays (name => value) from user input</td>

595

</tr>

596

<tr>

597

<td class="type">array  </td>

598

<td><b>$partialAccounts</b>  </td>

599

<td>list of hash arrays (name => value) which are later added to LDAP</td>

600

</tr>

601

<tr>

602

<td class="type">array  </td>

603

604

<td>list of IDs for column position (e.g. "posixAccount_uid" => 5)</td>

605

</tr>

606

<tr>

607

608

<td><b>&$partialAccounts</b>  </td>

609

610

</tr>

611

</table>

612

</div><br />

613

614

</div>

615

<hr />

616

617

<h3>method checkSelfServiceOptions <span class="smalllinenumber">[line 1510]</span></h3>

618

619

620

621

<code>array checkSelfServiceOptions(

622

string

623

$fields, array

624

$attributes)</code>

625

</td></tr></table>

626

</td></tr></table><br />

627

628

Checks if all input values are correct and returns the LDAP commands which should be executed.<br /><br /><br /><br />

629

630

631

632

<tr>

633

<td><b>return:</b>  </td><td>messages and LDAP commands (array('messages' => array(), 'add' => array(), 'del' => array(), 'mod' => array()))</td>

634

</tr>

635

</table>

636

</div>

637

638

639

Overrides <a href="../modules/baseModule.html#methodcheckSelfServiceOptions">baseModule::checkSelfServiceOptions()</a> (Checks if all input values are correct and returns the LDAP attributes which should be changed.)<br /><br />

640

<h4>Parameters:</h4>

641

642

643

<tr>

644

<td class="type">string  </td>

645

<td><b>$fields</b>  </td>

646

<td>input fields</td>

647

</tr>

648

<tr>

649

<td class="type">array  </td>

650

<td><b>$attributes</b>  </td>

651

<td>LDAP attributes</td>

652

</tr>

653

</table>

654

</div><br />

655

656

</div>

657

<hr />

658

659

<h3>method display_html_attributes <span class="smalllinenumber">[line 707]</span></h3>

660

661

662

663

<code>array display_html_attributes(

664

)</code>

665

</td></tr></table>

666

</td></tr></table><br />

667

668

Returns the HTML meta data for the main account page.<br /><br /><br /><br />

669

670

671

672

<tr>

673

<td><b>return:</b>  </td><td>HTML meta data</td>

674

</tr>

675

</table>

676

</div>

677

678

679

Overrides <a href="../modules/baseModule.html#methoddisplay_html_attributes">baseModule::display_html_attributes()</a> (This function creates meta HTML code to display the module page.)<br /><br />

680

681

</div>

682

<hr />

683

684

<h3>method display_html_password <span class="smalllinenumber">[line 984]</span></h3>

685

686

687

688

<code>array display_html_password(

689

)</code>

690

</td></tr></table>

691

</td></tr></table><br />

692

693

Displays the password changing dialog.<br /><br /><br /><br />

694

695

696

697

<tr>

698

<td><b>return:</b>  </td><td>meta HTML code</td>

699

</tr>

700

</table>

701

</div>

702

703

704

705

706

</div>

707

<hr />

708

709

<h3>method display_html_photo <span class="smalllinenumber">[line 1024]</span></h3>

710

711

712

713

<code>array display_html_photo(

714

)</code>

715

</td></tr></table>

716

</td></tr></table><br />

717

718

Displays the photo upload page.<br /><br /><br /><br />

719

720

721

722

<tr>

723

<td><b>return:</b>  </td><td>meta HTML code</td>

724

</tr>

725

</table>

726

</div>

727

728

729

730

731

</div>

732

<hr />

733

734

<h3>method getButtonStatus <span class="smalllinenumber">[line 521]</span></h3>

735

736

737

738

<code>string getButtonStatus(

739

)</code>

740

</td></tr></table>

741

</td></tr></table><br />

742

743

Controls if the module button the account page is visible and activated.<br /><br /><br /><br />

744

745

746

747

<tr>

748

<td><b>return:</b>  </td><td>status ("enabled", "disabled", "hidden")</td>

749

</tr>

750

</table>

751

</div>

752

753

754

Overrides <a href="../modules/baseModule.html#methodgetButtonStatus">baseModule::getButtonStatus()</a> (Controls if the module button the account page is visible and activated.)<br /><br />

755

756

</div>

757

<hr />

758

759

<h3>method getSelfServiceOptions <span class="smalllinenumber">[line 1337]</span></h3>

760

761

762

763

<code>array getSelfServiceOptions(

764

array

765

$fields, array

766

$attributes)</code>

767

</td></tr></table>

768

</td></tr></table><br />

769

770

Returns the meta HTML code for each input field.<br /><br /><p>format: array(<field1> => array(<META HTML>), ...) It is not possible to display help links.</p><br /><br /><br />

771

772

773

774

<tr>

775

<td><b>return:</b>  </td><td>meta HTML</td>

776

</tr>

777

</table>

778

</div>

779

780

781

Overrides <a href="../modules/baseModule.html#methodgetSelfServiceOptions">baseModule::getSelfServiceOptions()</a> (Returns the meta HTML code for each input field.)<br /><br />

782

<h4>Parameters:</h4>

783

784

785

<tr>

786

<td class="type">array  </td>

787

<td><b>$fields</b>  </td>

788

<td>list of active fields</td>

789

</tr>

790

<tr>

791

<td class="type">array  </td>

792

<td><b>$attributes</b>  </td>

793

<td>attributes of LDAP account (attribute names in lower case)</td>

794

</tr>

795

</table>

796

</div><br />

797

798

</div>

799

<hr />

800

801

<h3>method get_metaData <span class="smalllinenumber">[line 118]</span></h3>

802

803

804

805

<code>array get_metaData(

806

)</code>

807

</td></tr></table>

808

</td></tr></table><br />

809

810

Returns meta data that is interpreted by parent class<br /><br /><br /><br />

811

812

813

814

<tr>

815

<td><b>return:</b>  </td><td>array with meta data</td>

816

</tr>

817

<tr>

818

<td><b>see:</b>  </td><td><a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a></td>

819

</tr>

820

</table>

821

</div>

822

823

824

Overrides <a href="../modules/baseModule.html#methodget_metaData">baseModule::get_metaData()</a> (This function provides meta data which is interpreted by baseModule.)<br /><br />

825

826

</div>

827

<hr />

828

829

<h3>method get_pdfEntries <span class="smalllinenumber">[line 1043]</span></h3>

830

831

832

833

<code>array get_pdfEntries(

834

)</code>

835

</td></tr></table>

836

</td></tr></table><br />

837

838

Returns the PDF entries for this module.<br /><br /><br /><br />

839

840

841

842

<tr>

843

<td><b>return:</b>  </td><td>list of possible PDF entries</td>

844

</tr>

845

</table>

846

</div>

847

848

849

850

851

</div>

852

<hr />

853

854

<h3>method load_Messages <span class="smalllinenumber">[line 70]</span></h3>

855

856

857

858

<code>void load_Messages(

859

)</code>

860

</td></tr></table>

861

</td></tr></table><br />

862

863

This function fills the message array.<br /><br /><br /><br />

864

865

Overrides <a href="../modules/baseModule.html#methodload_Messages">baseModule::load_Messages()</a> (This function fills the $messages variable with output messages from this module.)<br /><br />

866

867

</div>

868

<hr />

869

870

<h3>method module_complete <span class="smalllinenumber">[line 504]</span></h3>

871

872

873

874

<code>boolean module_complete(

875

)</code>

876

</td></tr></table>

877

</td></tr></table><br />

878

879

This functions return true if all needed settings are done.<br /><br /><br /><br />

880

881

882

883

<tr>

884

<td><b>return:</b>  </td><td>true, if all is ok</td>

885

</tr>

886

</table>

887

</div>

888

889

890

Overrides <a href="../modules/baseModule.html#methodmodule_complete">baseModule::module_complete()</a> (This functions is used to check if all settings for this module have been made.)<br /><br />

891

892

</div>

893

<hr />

894

895

<h3>method process_attributes <span class="smalllinenumber">[line 581]</span></h3>

896

897

898

899

<code>array process_attributes(

900

)</code>

901

</td></tr></table>

902

</td></tr></table><br />

903

904

Processes user input of the primary module page.<br /><br /><p>It checks if all input values are correct and updates the associated LDAP attributes.</p><br /><br /><br />

905

906

907

908

<tr>

909

<td><b>return:</b>  </td><td>list of info/error messages</td>

910

</tr>

911

</table>

912

</div>

913

914

915

Overrides <a href="../modules/baseModule.html#methodprocess_attributes">baseModule::process_attributes()</a> (This function processes user input.)<br /><br />

916

917

</div>

918

<hr />

919

920

<h3>method process_password <span class="smalllinenumber">[line 956]</span></h3>

921

922

923

924

<code>void process_password(

925

)</code>

926

</td></tr></table>

927

</td></tr></table><br />

928

929

Sets a new password.<br /><br /><br /><br />

930

931

932

933

</div>

934

<hr />

935

936

<h3>method process_photo <span class="smalllinenumber">[line 1004]</span></h3>

937

938

939

940

<code>void process_photo(

941

)</code>

942

</td></tr></table>

943

</td></tr></table><br />

944

945

Sets a new photo.<br /><br /><br /><br />

946

947

948

949

</div>

950

<hr />

951

952

<h3>method save_attributes <span class="smalllinenumber">[line 543]</span></h3>

953

954

955

956

<code>array save_attributes(

957

)</code>

958

</td></tr></table>

959

</td></tr></table><br />

960

961

Returns a list of modifications which have to be made to the LDAP account.<br /><br /><br /><br />

962

963

964

965

<tr>

966

<td><b>return:</b>  </td><td>list of modifications <br />This function returns an array with 3 entries: <br />array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) <br />DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid) <br />"add" are attributes which have to be added to LDAP entry <br />"remove" are attributes which have to be removed from LDAP entry <br />"modify" are attributes which have to been modified in LDAP entry</td>

967

</tr>

968

</table>

969

</div>

970

971

972

Overrides <a href="../modules/baseModule.html#methodsave_attributes">baseModule::save_attributes()</a> (Returns a list of modifications which have to be made to the LDAP account.)<br /><br />

973

974

</div>

975

</div><br />

976

977

978

979

<hr />

980

Documentation generated on Mon, 28 Apr 2008 20:17:18 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.0</a>

981

</div>

982

</td></tr></table>

983

</td>

984

</tr>

985

</table>

986

987

</body>

988

</html>

b'\\ No newline at end of file'

Older »