Ccdn User Member Bundle Laravel Package

Getting Started

Minimal Setup

1. Install Dependencies Ensure codeconsortium/ccdn-user-bundle and codeconsortium/ccdn-user-member-bundle are installed via Composer:

   composer require codeconsortium/ccdn-user-bundle
   composer require codeconsortium/ccdn-user-member-bundle
   

2. Enable Bundles Add to config/bundles.php:

   return [
       // ...
       CodeConsortium\CCDNUserBundle\CCDNUserBundle::class => ['all' => true],
       CodeConsortium\CCDNUserMemberBundle\CCDNUserMemberBundle::class => ['all' => true],
   ];
   

3. Database Migrations Run Doctrine migrations to create the member table:

   php bin/console doctrine:migrations:diff
   php bin/console doctrine:migrations:migrate
   

4. First Use Case Register a new member via the CLI or a controller:

   use CodeConsortium\CCDNUserMemberBundle\Entity\Member;
   
   $member = new Member();
   $member->setUsername('john_doe');
   $member->setEmail('john@example.com');
   $member->setPlainPassword('secure123');
   $member->setEnabled(true);
   
   $em = $this->getDoctrine()->getManager();
   $em->persist($member);
   $em->flush();
   

Implementation Patterns

Core Workflows

1. Member Registration Extend the default registration logic by leveraging the MemberType form:

   use CodeConsortium\CCDNUserMemberBundle\Form\Type\MemberType;
   
   $form = $this->createForm(MemberType::class, $member);
   

2. Role-Based Access Control Use the Member entity’s roles property to assign permissions:

   $member->addRole('ROLE_MEMBER');
   $member->addRole('ROLE_ADMIN'); // If needed
   

3. Member Profile Management Fetch and update member profiles:

   $member = $em->getRepository(Member::class)->find($id);
   $member->setFirstName('John');
   $member->setLastName('Doe');
   $em->flush();
   

4. Integration with CCDNUserBundle Use the User entity from CCDNUserBundle as a base for Member:

   $member = new Member();
   $member->setUser($userEntity); // Link to CCDNUserBundle's User
   

Common Patterns

• Event Listeners Subscribe to MemberEvents (e.g., MemberRegisteredEvent) for post-registration actions:

  # config/services.yaml
  services:
      App\EventListener\MemberListener:
          tags:
              - { name: kernel.event_listener, event: member.registered, method: onMemberRegistered }
  

• Custom Fields Extend the Member entity to add custom attributes:

   /**
    * @ORM\Column(type="string", nullable=true)
    */
   private $customField;
  

• API Endpoints Use Symfony’s Serializer to expose member data:

   $serializer = $this->container->get('serializer');
   $memberData = $serializer->serialize($member, 'json', ['groups' => ['member']]);
  

Gotchas and Tips

Pitfalls

1. Symfony 2.1.x Dependency

   • The bundle only supports Symfony 2.1.x and PHP 5.4. Avoid using with newer Symfony versions without forking.
   • Workaround: Use a compatibility layer like symfony/symfony v2.1.x for legacy projects.

2. Missing Documentation

   • The README lacks details on entity relationships, form customization, or event triggers.
   • Tip: Inspect src/CodeConsortium/CCDNUserMemberBundle/Resources/config/doctrine/ for entity mappings and src/Form/Type/ for form logic.

3. Doctrine Configuration

   • Ensure CCDNUserBundle is configured before CCDNUserMemberBundle in bundles.php to avoid autoloading errors.

4. Password Handling

   • The bundle uses Symfony’s UserInterface for password hashing. Override setPlainPassword() if custom logic is needed:

     $member->setPlainPassword($plainPassword);
     $member->setPassword($this->passwordEncoder->encodePassword($member, $plainPassword));
     

Debugging Tips

• Check Entity States Use Doctrine’s lifecycle callbacks to debug entity changes:

  // In Member.php
  public function prePersist()
  {
      if (empty($this->salt)) {
          $this->salt = bin2hex(random_bytes(16));
      }
  }
  

• Form Validation Errors Enable debug mode (APP_DEBUG=true) to see form validation errors in Symfony’s profiler.

• Event Debugging Dump events in a listener to verify triggers:

  public function onMemberRegistered(MemberRegisteredEvent $event)
  {
      dump($event->getMember());
  }
  

Extension Points

1. Custom Member Types Create a subclass of Member for role-specific logic:

   class PremiumMember extends Member
   {
       /**
        * @ORM\Column(type="integer")
        */
       private $premiumTier;
   }
   

2. Override Templates Copy templates from Resources/views/ to your project’s templates/CCDNUserMemberBundle/ to customize rendering.

3. Add Validation Constraints Extend the Member entity with custom constraints:

   use Symfony\Component\Validator\Constraints as Assert;
   
   /**
    * @Assert\NotBlank(message="Email cannot be blank")
    * @Assert\Email(message="Invalid email format")
    */
   private $email;
   

4. API Integration Use FOSRestBundle or API Platform to expose member endpoints:

   # config/routes.yaml
   app_member_get:
       path: /api/members/{id}
       methods: GET
       defaults:
           _controller: App\Controller\MemberController::getMemberAction
           _format: json